@icure/cardinal-sdk 2.8.1 → 2.10.0

package/filters/InsuranceFilters.d.mts

@@ -0,0 +1,54 @@
+import { BaseFilterOptions, BaseSortableFilterOptions } from '../cardinal-sdk-ts.mjs';
+import { Insurance } from '../model/Insurance.mjs';
+import { Identifier } from '../model/base/Identifier.mjs';
+interface InsuranceFiltersFactory {
+    /**
+     *
+     *  Filter options to match all insurances.
+     *  These options are not sortable.
+     */
+    all(): BaseFilterOptions<Insurance>;
+    /**
+     *
+     *  Options for insurance filtering which match all the insurances that have at least
+     *  an identifier that has the same exact [Identifier.system] and [Identifier.value] as one of the provided
+     *  [identifiers]. Other properties of the provided identifiers are ignored.
+     *
+     *  These options are sortable. When sorting using these options the insurances will be in the same order as
+     *  the input identifiers. In case an entity has multiple identifiers only the first matching identifier is considered
+     *  for the sorting.
+     *
+     *  @param identifiers a list of identifiers
+     */
+    byIdentifiers(identifiers: Array<Identifier>): BaseFilterOptions<Insurance>;
+    /**
+     *
+     *  Options for insurance filtering which match all insurances shared directly (i.e. ignoring hierarchies) ƒthat have a certain code.
+     *  If you specify only the [codeType] you will get all entities that have at least a code of that type.
+     *
+     *  These options are sortable. When sorting using these options the insurances will be sorted by [codeCode]
+     *
+     *  @param codeType a code type
+     *  @param codeCode a code for the provided code type, or null if you want the filter to accept any entity
+     *  with a code of the provided type.
+     */
+    byCode(codeType: string, options?: {
+        codeCode?: string | undefined;
+    }): BaseSortableFilterOptions<Insurance>;
+    /**
+     *
+     *  Options for insurance filtering which match all insurances shared directly (i.e. ignoring hierarchies) that have a certain tag.
+     *  If you specify only the [tagType] you will get all entities that have at least a tag of that type.
+     *
+     *  These options are sortable. When sorting using these options the insurances will be sorted by [tagCode]
+     *
+     *  @param tagType a tag type
+     *  @param tagCode a code for the provided tag type, or null if you want the filter to accept any entity
+     *  with a tag of the provided type.
+     */
+    byTag(tagType: string, options?: {
+        tagCode?: string | undefined;
+    }): BaseSortableFilterOptions<Insurance>;
+}
+export declare const InsuranceFilters: InsuranceFiltersFactory;
+export {};

package/filters/InsuranceFilters.mjs

@@ -0,0 +1,8 @@
+// auto-generated file
+import { InternalInsuranceFiltersObj } from '../cardinal-sdk-ts.mjs';
+export const InsuranceFilters = {
+    all: () => InternalInsuranceFiltersObj.getInstance().all(),
+    byIdentifiers: (identifiers) => InternalInsuranceFiltersObj.getInstance().byIdentifiers(identifiers),
+    byCode: (codeType, options) => InternalInsuranceFiltersObj.getInstance().byCode(codeType, options),
+    byTag: (tagType, options) => InternalInsuranceFiltersObj.getInstance().byTag(tagType, options)
+};

package/filters.d.mts

@@ -18,3 +18,4 @@ export * from './filters/HealthcarePartyFilters.mjs';
 export * from './filters/ContactFilters.mjs';
 export * from './filters/MaintenanceTaskFilters.mjs';
 export * from './filters/CalendarItemFilters.mjs';
+export * from './filters/InsuranceFilters.mjs';

package/filters.mjs

@@ -18,3 +18,4 @@ export * from './filters/HealthcarePartyFilters.mjs';
 export * from './filters/ContactFilters.mjs';
 export * from './filters/MaintenanceTaskFilters.mjs';
 export * from './filters/CalendarItemFilters.mjs';
+export * from './filters/InsuranceFilters.mjs';

package/model/Contact.d.mts

@@ -1,11 +1,12 @@
 import { CodeStub } from './base/CodeStub.mjs';
 import { HasEncryptionMetadata } from './base/HasEncryptionMetadata.mjs';
 import { HasEndOfLife } from './base/HasEndOfLife.mjs';
+import { HasIdentifier } from './base/HasIdentifier.mjs';
 import { ICureDocument } from './base/ICureDocument.mjs';
 import { Identifier } from './base/Identifier.mjs';
 import { StoredDocument } from './base/StoredDocument.mjs';
 import { Address, DecryptedAddress, EncryptedAddress } from './embed/Address.mjs';
-import { Annotation } from './embed/Annotation.mjs';
+import { Annotation, DecryptedAnnotation, EncryptedAnnotation } from './embed/Annotation.mjs';
 import { ContactParticipant } from './embed/ContactParticipant.mjs';
 import { Delegation } from './embed/Delegation.mjs';
 import { Encryptable } from './embed/Encryptable.mjs';
@@ -34,12 +35,7 @@ import { Base64String } from './specializations/Base64String.mjs';
  *  absence of a patient.
  *  /
  */
-export interface Contact extends StoredDocument, ICureDocument<string>, HasEncryptionMetadata, Encryptable, HasEndOfLife {
-    /**
-     *
-     *  The identifiers of the Contact.
-     */
-    identifier: Array<Identifier>;
+export interface Contact extends StoredDocument, ICureDocument<string>, HasEncryptionMetadata, Encryptable, HasEndOfLife, HasIdentifier {
     /**
      *
      *  Separate contacts can be merged in one logical contact if they share the same groupId. When a
@@ -276,7 +272,7 @@ export declare class DecryptedContact {
      *
      *  Comments and notes recorded by a healthcare party about this contact.
      */
-    notes: Array<Annotation>;
+    notes: Array<DecryptedAnnotation>;
     readonly isEncrypted: false;
     constructor(partial: Partial<DecryptedContact>);
     toJSON(): object;
@@ -457,7 +453,7 @@ export declare class EncryptedContact {
      *
      *  Comments and notes recorded by a healthcare party about this contact.
      */
-    notes: Array<Annotation>;
+    notes: Array<EncryptedAnnotation>;
     readonly isEncrypted: true;
     constructor(partial: Partial<EncryptedContact>);
     toJSON(): object;

package/model/Contact.mjs

@@ -4,7 +4,7 @@ import { randomUuid } from '../utils/Id.mjs';
 import { CodeStub } from './base/CodeStub.mjs';
 import { Identifier } from './base/Identifier.mjs';
 import { DecryptedAddress, EncryptedAddress } from './embed/Address.mjs';
-import { Annotation } from './embed/Annotation.mjs';
+import { DecryptedAnnotation, EncryptedAnnotation } from './embed/Annotation.mjs';
 import { ContactParticipant } from './embed/ContactParticipant.mjs';
 import { Delegation } from './embed/Delegation.mjs';
 import { SecurityMetadata } from './embed/SecurityMetadata.mjs';
@@ -319,7 +319,7 @@ export class DecryptedContact {
             encryptionKeys: expectMap(extractEntry(jCpy, 'encryptionKeys', false, path), false, [...path, ".encryptionKeys"], (k0, p0) => expectString(k0, false, p0), (v0, p0) => expectArray(v0, false, p0, (x1, p1) => expectObject(x1, false, ignoreUnknownKeys, p1, Delegation.fromJSON))),
             encryptedSelf: expectString(extractEntry(jCpy, 'encryptedSelf', false, path), true, [...path, ".encryptedSelf"]),
             securityMetadata: expectObject(extractEntry(jCpy, 'securityMetadata', false, path), true, ignoreUnknownKeys, [...path, ".securityMetadata"], SecurityMetadata.fromJSON),
-            notes: expectArray(extractEntry(jCpy, 'notes', false, path), false, [...path, ".notes"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, Annotation.fromJSON)),
+            notes: expectArray(extractEntry(jCpy, 'notes', false, path), false, [...path, ".notes"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, DecryptedAnnotation.fromJSON)),
         });
         if (!ignoreUnknownKeys) {
             const unused = Object.keys(jCpy);
@@ -638,7 +638,7 @@ export class EncryptedContact {
             encryptionKeys: expectMap(extractEntry(jCpy, 'encryptionKeys', false, path), false, [...path, ".encryptionKeys"], (k0, p0) => expectString(k0, false, p0), (v0, p0) => expectArray(v0, false, p0, (x1, p1) => expectObject(x1, false, ignoreUnknownKeys, p1, Delegation.fromJSON))),
             encryptedSelf: expectString(extractEntry(jCpy, 'encryptedSelf', false, path), true, [...path, ".encryptedSelf"]),
             securityMetadata: expectObject(extractEntry(jCpy, 'securityMetadata', false, path), true, ignoreUnknownKeys, [...path, ".securityMetadata"], SecurityMetadata.fromJSON),
-            notes: expectArray(extractEntry(jCpy, 'notes', false, path), false, [...path, ".notes"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, Annotation.fromJSON)),
+            notes: expectArray(extractEntry(jCpy, 'notes', false, path), false, [...path, ".notes"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, EncryptedAnnotation.fromJSON)),
         });
         if (!ignoreUnknownKeys) {
             const unused = Object.keys(jCpy);

package/model/HealthElement.d.mts

@@ -4,7 +4,7 @@ import { HasEndOfLife } from './base/HasEndOfLife.mjs';
 import { ICureDocument } from './base/ICureDocument.mjs';
 import { Identifier } from './base/Identifier.mjs';
 import { StoredDocument } from './base/StoredDocument.mjs';
-import { Annotation } from './embed/Annotation.mjs';
+import { Annotation, DecryptedAnnotation, EncryptedAnnotation } from './embed/Annotation.mjs';
 import { CareTeamMember, DecryptedCareTeamMember, EncryptedCareTeamMember } from './embed/CareTeamMember.mjs';
 import { Delegation } from './embed/Delegation.mjs';
 import { Encryptable } from './embed/Encryptable.mjs';
@@ -210,7 +210,7 @@ export declare class DecryptedHealthElement {
      *
      *  Localized text annotations for the healthcare element.
      */
-    notes: Array<Annotation>;
+    notes: Array<DecryptedAnnotation>;
     /**
      *
      *  Whether the healthcare element is relevant or not.
@@ -394,7 +394,7 @@ export declare class EncryptedHealthElement {
      *
      *  Localized text annotations for the healthcare element.
      */
-    notes: Array<Annotation>;
+    notes: Array<EncryptedAnnotation>;
     /**
      *
      *  Whether the healthcare element is relevant or not.

package/model/HealthElement.mjs

@@ -3,7 +3,7 @@ import { expectArray, expectBoolean, expectMap, expectNumber, expectObject, expe
 import { randomUuid } from '../utils/Id.mjs';
 import { CodeStub } from './base/CodeStub.mjs';
 import { Identifier } from './base/Identifier.mjs';
-import { Annotation } from './embed/Annotation.mjs';
+import { DecryptedAnnotation, EncryptedAnnotation } from './embed/Annotation.mjs';
 import { DecryptedCareTeamMember, EncryptedCareTeamMember } from './embed/CareTeamMember.mjs';
 import { Delegation } from './embed/Delegation.mjs';
 import { DecryptedEpisode, EncryptedEpisode } from './embed/Episode.mjs';
@@ -327,7 +327,7 @@ export class DecryptedHealthElement {
             closingDate: expectNumber(extractEntry(jCpy, 'closingDate', false, path), true, true, [...path, ".closingDate"]),
             descr: expectString(extractEntry(jCpy, 'descr', false, path), true, [...path, ".descr"]),
             note: expectString(extractEntry(jCpy, 'note', false, path), true, [...path, ".note"]),
-            notes: expectArray(extractEntry(jCpy, 'notes', false, path), false, [...path, ".notes"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, Annotation.fromJSON)),
+            notes: expectArray(extractEntry(jCpy, 'notes', false, path), false, [...path, ".notes"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, DecryptedAnnotation.fromJSON)),
             relevant: expectBoolean(extractEntry(jCpy, 'relevant', false, path), false, [...path, ".relevant"]),
             idOpeningContact: expectString(extractEntry(jCpy, 'idOpeningContact', false, path), true, [...path, ".idOpeningContact"]),
             idClosingContact: expectString(extractEntry(jCpy, 'idClosingContact', false, path), true, [...path, ".idClosingContact"]),
@@ -668,7 +668,7 @@ export class EncryptedHealthElement {
             closingDate: expectNumber(extractEntry(jCpy, 'closingDate', false, path), true, true, [...path, ".closingDate"]),
             descr: expectString(extractEntry(jCpy, 'descr', false, path), true, [...path, ".descr"]),
             note: expectString(extractEntry(jCpy, 'note', false, path), true, [...path, ".note"]),
-            notes: expectArray(extractEntry(jCpy, 'notes', false, path), false, [...path, ".notes"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, Annotation.fromJSON)),
+            notes: expectArray(extractEntry(jCpy, 'notes', false, path), false, [...path, ".notes"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, EncryptedAnnotation.fromJSON)),
             relevant: expectBoolean(extractEntry(jCpy, 'relevant', false, path), false, [...path, ".relevant"]),
             idOpeningContact: expectString(extractEntry(jCpy, 'idOpeningContact', false, path), true, [...path, ".idOpeningContact"]),
             idClosingContact: expectString(extractEntry(jCpy, 'idClosingContact', false, path), true, [...path, ".idClosingContact"]),

package/model/HealthcareParty.d.mts

@@ -3,6 +3,7 @@ import { CodeStub } from './base/CodeStub.mjs';
 import { CryptoActor } from './base/CryptoActor.mjs';
 import { DataOwner } from './base/DataOwner.mjs';
 import { HasCodes } from './base/HasCodes.mjs';
+import { HasIdentifier } from './base/HasIdentifier.mjs';
 import { HasTags } from './base/HasTags.mjs';
 import { Identifier } from './base/Identifier.mjs';
 import { Named } from './base/Named.mjs';
@@ -23,7 +24,7 @@ import { SpkiHexString } from './specializations/SpkiHexString.mjs';
  *  icure-healthdata CouchDB database.
  *  /
  */
-export declare class HealthcareParty implements StoredDocument, Named, Person, CryptoActor, DataOwner, HasCodes, HasTags {
+export declare class HealthcareParty implements StoredDocument, Named, Person, CryptoActor, DataOwner, HasCodes, HasTags, HasIdentifier {
     /**
      *
      *  The Id of the healthcare party. We encourage using either a v4 UUID or a HL7 Id.

package/model/Insurance.d.mts

@@ -1,12 +1,17 @@
+import { CodeStub } from './base/CodeStub.mjs';
+import { HasCodes } from './base/HasCodes.mjs';
+import { HasIdentifier } from './base/HasIdentifier.mjs';
+import { HasTags } from './base/HasTags.mjs';
+import { Identifier } from './base/Identifier.mjs';
 import { StoredDocument } from './base/StoredDocument.mjs';
 import { DecryptedAddress } from './embed/Address.mjs';
 /**
  *
- *  Represents an insurance entity. An insurance can be a mutual fund, a private insurance company,
- *  or any other type of insurance organization that covers healthcare costs.
- *  /
+ *
+ *   Represents an insurance entity. An insurance can be a mutual fund, a private insurance company,
+ *   or any other type of insurance organization that covers healthcare costs.
  */
-export declare class Insurance implements StoredDocument {
+export declare class Insurance implements StoredDocument, HasTags, HasCodes, HasIdentifier {
     /**
      *
      *  The unique identifier of the insurance.
@@ -32,19 +37,19 @@ export declare class Insurance implements StoredDocument {
     };
     /**
      *
-     *  Whether this is a private insurance.
+     *  The identifiers of the insurance.
      */
-    privateInsurance: boolean;
+    identifier: Array<Identifier>;
     /**
      *
-     *  Whether this insurance covers hospitalisation.
+     *  Tags that qualify the insurance as being member of a certain class.
      */
-    hospitalisationInsurance: boolean;
+    tags: Array<CodeStub>;
     /**
      *
-     *  Whether this insurance covers ambulatory care.
+     *  Codes that identify or qualify this particular insurance.
      */
-    ambulatoryInsurance: boolean;
+    codes: Array<CodeStub>;
     /**
      *
      *  The insurance code.

package/model/Insurance.mjs

@@ -1,12 +1,14 @@
 // auto-generated file
-import { expectBoolean, expectMap, expectNumber, expectObject, expectString, extractEntry } from '../internal/JsonDecodeUtils.mjs';
+import { expectArray, expectMap, expectNumber, expectObject, expectString, extractEntry } from '../internal/JsonDecodeUtils.mjs';
 import { randomUuid } from '../utils/Id.mjs';
+import { CodeStub } from './base/CodeStub.mjs';
+import { Identifier } from './base/Identifier.mjs';
 import { DecryptedAddress } from './embed/Address.mjs';
 /**
  *
- *  Represents an insurance entity. An insurance can be a mutual fund, a private insurance company,
- *  or any other type of insurance organization that covers healthcare costs.
- *  /
+ *
+ *   Represents an insurance entity. An insurance can be a mutual fund, a private insurance company,
+ *   or any other type of insurance organization that covers healthcare costs.
  */
 export class Insurance {
     constructor(partial) {
@@ -29,19 +31,19 @@ export class Insurance {
         this.name = {};
         /**
          *
-         *  Whether this is a private insurance.
+         *  The identifiers of the insurance.
          */
-        this.privateInsurance = false;
+        this.identifier = [];
         /**
          *
-         *  Whether this insurance covers hospitalisation.
+         *  Tags that qualify the insurance as being member of a certain class.
          */
-        this.hospitalisationInsurance = false;
+        this.tags = [];
         /**
          *
-         *  Whether this insurance covers ambulatory care.
+         *  Codes that identify or qualify this particular insurance.
          */
-        this.ambulatoryInsurance = false;
+        this.codes = [];
         /**
          *
          *  The insurance code.
@@ -64,12 +66,12 @@ export class Insurance {
             this.deletionDate = partial.deletionDate;
         if ('name' in partial && partial.name !== undefined)
             this.name = partial.name;
-        if ('privateInsurance' in partial && partial.privateInsurance !== undefined)
-            this.privateInsurance = partial.privateInsurance;
-        if ('hospitalisationInsurance' in partial && partial.hospitalisationInsurance !== undefined)
-            this.hospitalisationInsurance = partial.hospitalisationInsurance;
-        if ('ambulatoryInsurance' in partial && partial.ambulatoryInsurance !== undefined)
-            this.ambulatoryInsurance = partial.ambulatoryInsurance;
+        if ('identifier' in partial && partial.identifier !== undefined)
+            this.identifier = partial.identifier;
+        if ('tags' in partial && partial.tags !== undefined)
+            this.tags = partial.tags;
+        if ('codes' in partial && partial.codes !== undefined)
+            this.codes = partial.codes;
         if ('code' in partial)
             this.code = partial.code;
         if ('agreementNumber' in partial)
@@ -86,9 +88,9 @@ export class Insurance {
         if (this.deletionDate != undefined)
             res['deletionDate'] = this.deletionDate;
         res['name'] = Object.fromEntries(Object.entries(this.name).map(([k0, v0]) => [k0, v0]));
-        res['privateInsurance'] = this.privateInsurance;
-        res['hospitalisationInsurance'] = this.hospitalisationInsurance;
-        res['ambulatoryInsurance'] = this.ambulatoryInsurance;
+        res['identifier'] = this.identifier.map((x0) => x0.toJSON());
+        res['tags'] = this.tags.map((x0) => x0.toJSON());
+        res['codes'] = this.codes.map((x0) => x0.toJSON());
         if (this.code != undefined)
             res['code'] = this.code;
         if (this.agreementNumber != undefined)
@@ -107,9 +109,9 @@ export class Insurance {
             rev: expectString(extractEntry(jCpy, 'rev', false, path), true, [...path, ".rev"]),
             deletionDate: expectNumber(extractEntry(jCpy, 'deletionDate', false, path), true, true, [...path, ".deletionDate"]),
             name: expectMap(extractEntry(jCpy, 'name', false, path), false, [...path, ".name"], (k0, p0) => expectString(k0, false, p0), (v0, p0) => expectString(v0, false, p0)),
-            privateInsurance: expectBoolean(extractEntry(jCpy, 'privateInsurance', false, path), false, [...path, ".privateInsurance"]),
-            hospitalisationInsurance: expectBoolean(extractEntry(jCpy, 'hospitalisationInsurance', false, path), false, [...path, ".hospitalisationInsurance"]),
-            ambulatoryInsurance: expectBoolean(extractEntry(jCpy, 'ambulatoryInsurance', false, path), false, [...path, ".ambulatoryInsurance"]),
+            identifier: expectArray(extractEntry(jCpy, 'identifier', false, path), false, [...path, ".identifier"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, Identifier.fromJSON)),
+            tags: expectArray(extractEntry(jCpy, 'tags', false, path), false, [...path, ".tags"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, CodeStub.fromJSON)),
+            codes: expectArray(extractEntry(jCpy, 'codes', false, path), false, [...path, ".codes"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, CodeStub.fromJSON)),
             code: expectString(extractEntry(jCpy, 'code', false, path), true, [...path, ".code"]),
             agreementNumber: expectString(extractEntry(jCpy, 'agreementNumber', false, path), true, [...path, ".agreementNumber"]),
             parent: expectString(extractEntry(jCpy, 'parent', false, path), true, [...path, ".parent"]),

package/model/Invoice.d.mts

@@ -1,5 +1,6 @@
 import { CodeStub } from './base/CodeStub.mjs';
 import { HasEncryptionMetadata } from './base/HasEncryptionMetadata.mjs';
+import { HasIdentifier } from './base/HasIdentifier.mjs';
 import { ICureDocument } from './base/ICureDocument.mjs';
 import { Identifier } from './base/Identifier.mjs';
 import { StoredDocument } from './base/StoredDocument.mjs';
@@ -18,12 +19,7 @@ import { Base64String } from './specializations/Base64String.mjs';
  *  services rendered. It is serialized in JSON and saved in the underlying iCure CouchDB database.
  *  /
  */
-export interface Invoice extends StoredDocument, ICureDocument<string>, HasEncryptionMetadata, Encryptable {
-    /**
-     *
-     *  The identifiers of the invoice.
-     */
-    identifier: Array<Identifier>;
+export interface Invoice extends StoredDocument, ICureDocument<string>, HasEncryptionMetadata, Encryptable, HasIdentifier {
     /**
      *
      *  The timestamp (unix epoch in ms) when the invoice was drafted.

package/model/MaintenanceTask.d.mts

@@ -2,6 +2,7 @@ import { DecryptedPropertyStub, EncryptedPropertyStub, PropertyStub } from './Pr
 import { CodeStub } from './base/CodeStub.mjs';
 import { HasEncryptionMetadata } from './base/HasEncryptionMetadata.mjs';
 import { HasEndOfLife } from './base/HasEndOfLife.mjs';
+import { HasIdentifier } from './base/HasIdentifier.mjs';
 import { ICureDocument } from './base/ICureDocument.mjs';
 import { Identifier } from './base/Identifier.mjs';
 import { StoredDocument } from './base/StoredDocument.mjs';
@@ -18,12 +19,7 @@ import { Base64String } from './specializations/Base64String.mjs';
  *  asynchronous processing.
  *  /
  */
-export interface MaintenanceTask extends StoredDocument, ICureDocument<string>, HasEncryptionMetadata, Encryptable, HasEndOfLife {
-    /**
-     *
-     *  The identifiers of the maintenance task.
-     */
-    identifier: Array<Identifier>;
+export interface MaintenanceTask extends StoredDocument, ICureDocument<string>, HasEncryptionMetadata, Encryptable, HasEndOfLife, HasIdentifier {
     /**
      *
      *  The type of the maintenance task.

package/model/Patient.d.mts

@@ -2,12 +2,13 @@ import { DecryptedPropertyStub, EncryptedPropertyStub, PropertyStub } from './Pr
 import { CodeStub } from './base/CodeStub.mjs';
 import { CryptoActor } from './base/CryptoActor.mjs';
 import { HasEncryptionMetadata } from './base/HasEncryptionMetadata.mjs';
+import { HasIdentifier } from './base/HasIdentifier.mjs';
 import { ICureDocument } from './base/ICureDocument.mjs';
 import { Identifier } from './base/Identifier.mjs';
 import { Person } from './base/Person.mjs';
 import { StoredDocument } from './base/StoredDocument.mjs';
 import { DecryptedAddress, EncryptedAddress } from './embed/Address.mjs';
-import { Annotation } from './embed/Annotation.mjs';
+import { Annotation, DecryptedAnnotation, EncryptedAnnotation } from './embed/Annotation.mjs';
 import { Delegation } from './embed/Delegation.mjs';
 import { Encryptable } from './embed/Encryptable.mjs';
 import { DecryptedFinancialInstitutionInformation, EncryptedFinancialInstitutionInformation, FinancialInstitutionInformation } from './embed/FinancialInstitutionInformation.mjs';
@@ -31,12 +32,7 @@ import { SpkiHexString } from './specializations/SpkiHexString.mjs';
  *  end-to-end encryption of sensitive data.
  *  /
  */
-export interface Patient extends StoredDocument, ICureDocument<string>, Person, HasEncryptionMetadata, Encryptable, CryptoActor {
-    /**
-     *
-     *  The patient's identifiers, used by the client to uniquely identify the patient.
-     */
-    identifier: Array<Identifier>;
+export interface Patient extends StoredDocument, ICureDocument<string>, Person, HasEncryptionMetadata, Encryptable, HasIdentifier, CryptoActor {
     /**
      *
      *  The birth sex of the patient.
@@ -426,7 +422,7 @@ export declare class DecryptedPatient {
      *
      *  Localized text notes (can be confidential).
      */
-    notes: Array<Annotation>;
+    notes: Array<DecryptedAnnotation>;
     /**
      *
      *  A text note (can be confidential, encrypted by default).
@@ -794,7 +790,7 @@ export declare class EncryptedPatient {
      *
      *  Localized text notes (can be confidential).
      */
-    notes: Array<Annotation>;
+    notes: Array<EncryptedAnnotation>;
     /**
      *
      *  A text note (can be confidential, encrypted by default).

package/model/Patient.mjs

@@ -5,7 +5,7 @@ import { DecryptedPropertyStub, EncryptedPropertyStub } from './PropertyStub.mjs
 import { CodeStub } from './base/CodeStub.mjs';
 import { Identifier } from './base/Identifier.mjs';
 import { DecryptedAddress, EncryptedAddress } from './embed/Address.mjs';
-import { Annotation } from './embed/Annotation.mjs';
+import { DecryptedAnnotation, EncryptedAnnotation } from './embed/Annotation.mjs';
 import { Delegation } from './embed/Delegation.mjs';
 import { DecryptedFinancialInstitutionInformation, EncryptedFinancialInstitutionInformation } from './embed/FinancialInstitutionInformation.mjs';
 import { Gender } from './embed/Gender.mjs';
@@ -645,7 +645,7 @@ export class DecryptedPatient {
             deceased: expectBoolean(extractEntry(jCpy, 'deceased', false, path), true, [...path, ".deceased"]),
             education: expectString(extractEntry(jCpy, 'education', false, path), true, [...path, ".education"]),
             profession: expectString(extractEntry(jCpy, 'profession', false, path), true, [...path, ".profession"]),
-            notes: expectArray(extractEntry(jCpy, 'notes', false, path), false, [...path, ".notes"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, Annotation.fromJSON)),
+            notes: expectArray(extractEntry(jCpy, 'notes', false, path), false, [...path, ".notes"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, DecryptedAnnotation.fromJSON)),
             note: expectString(extractEntry(jCpy, 'note', false, path), true, [...path, ".note"]),
             administrativeNote: expectString(extractEntry(jCpy, 'administrativeNote', false, path), true, [...path, ".administrativeNote"]),
             nationality: expectString(extractEntry(jCpy, 'nationality', false, path), true, [...path, ".nationality"]),
@@ -1311,7 +1311,7 @@ export class EncryptedPatient {
             deceased: expectBoolean(extractEntry(jCpy, 'deceased', false, path), true, [...path, ".deceased"]),
             education: expectString(extractEntry(jCpy, 'education', false, path), true, [...path, ".education"]),
             profession: expectString(extractEntry(jCpy, 'profession', false, path), true, [...path, ".profession"]),
-            notes: expectArray(extractEntry(jCpy, 'notes', false, path), false, [...path, ".notes"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, Annotation.fromJSON)),
+            notes: expectArray(extractEntry(jCpy, 'notes', false, path), false, [...path, ".notes"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, EncryptedAnnotation.fromJSON)),
             note: expectString(extractEntry(jCpy, 'note', false, path), true, [...path, ".note"]),
             administrativeNote: expectString(extractEntry(jCpy, 'administrativeNote', false, path), true, [...path, ".administrativeNote"]),
             nationality: expectString(extractEntry(jCpy, 'nationality', false, path), true, [...path, ".nationality"]),

package/model/User.d.mts

@@ -1,4 +1,5 @@
 import { DecryptedPropertyStub } from './PropertyStub.mjs';
+import { HasIdentifier } from './base/HasIdentifier.mjs';
 import { Identifier } from './base/Identifier.mjs';
 import { StoredDocument } from './base/StoredDocument.mjs';
 import { DelegationTag } from './embed/DelegationTag.mjs';
@@ -13,7 +14,7 @@ import { Permission } from './security/Permission.mjs';
  *  party,
  *   a patient, or a device, and holds authentication credentials, roles, and permissions.
  */
-export declare class User implements StoredDocument {
+export declare class User implements StoredDocument, HasIdentifier {
     /**
      *
      *  The Id of the user. We encourage using either a v4 UUID or a HL7 Id.

package/model/base/HasIdentifier.d.mts

@@ -0,0 +1,10 @@
+import { Identifier } from './Identifier.mjs';
+/**
+ *
+ *
+ *   Interface for entities that can be identified uniquely and unambiguously by a set of
+ *  identifiers.
+ */
+export interface HasIdentifier {
+    identifier: Array<Identifier>;
+}

package/model/base/HasIdentifier.mjs

@@ -0,0 +1 @@
+export {};

package/model/embed/Address.d.mts

@@ -1,14 +1,14 @@
 import { CodeStub } from '../base/CodeStub.mjs';
 import { HasCodes } from '../base/HasCodes.mjs';
+import { HasIdentifier } from '../base/HasIdentifier.mjs';
 import { HasTags } from '../base/HasTags.mjs';
 import { Identifier } from '../base/Identifier.mjs';
 import { Base64String } from '../specializations/Base64String.mjs';
 import { AddressType } from './AddressType.mjs';
-import { Annotation } from './Annotation.mjs';
+import { Annotation, DecryptedAnnotation, EncryptedAnnotation } from './Annotation.mjs';
 import { Encryptable } from './Encryptable.mjs';
 import { DecryptedTelecom, EncryptedTelecom, Telecom } from './Telecom.mjs';
-export interface Address extends Encryptable, HasTags, HasCodes {
-    identifier: Array<Identifier>;
+export interface Address extends Encryptable, HasTags, HasCodes, HasIdentifier {
     addressType: AddressType | undefined;
     descr: string | undefined;
     street: string | undefined;
@@ -38,7 +38,7 @@ export declare class DecryptedAddress {
     state: string | undefined;
     country: string | undefined;
     note: string | undefined;
-    notes: Array<Annotation>;
+    notes: Array<DecryptedAnnotation>;
     telecoms: Array<DecryptedTelecom>;
     encryptedSelf: Base64String | undefined;
     readonly isEncrypted: false;
@@ -60,7 +60,7 @@ export declare class EncryptedAddress {
     state: string | undefined;
     country: string | undefined;
     note: string | undefined;
-    notes: Array<Annotation>;
+    notes: Array<EncryptedAnnotation>;
     telecoms: Array<EncryptedTelecom>;
     encryptedSelf: Base64String | undefined;
     readonly isEncrypted: true;

package/model/embed/Address.mjs

@@ -3,7 +3,7 @@ import { expectArray, expectObject, expectString, expectStringEnum, extractEntry
 import { CodeStub } from '../base/CodeStub.mjs';
 import { Identifier } from '../base/Identifier.mjs';
 import { AddressType } from './AddressType.mjs';
-import { Annotation } from './Annotation.mjs';
+import { DecryptedAnnotation, EncryptedAnnotation } from './Annotation.mjs';
 import { DecryptedTelecom, EncryptedTelecom } from './Telecom.mjs';
 export class DecryptedAddress {
     constructor(partial) {
@@ -111,7 +111,7 @@ export class DecryptedAddress {
             state: expectString(extractEntry(jCpy, 'state', false, path), true, [...path, ".state"]),
             country: expectString(extractEntry(jCpy, 'country', false, path), true, [...path, ".country"]),
             note: expectString(extractEntry(jCpy, 'note', false, path), true, [...path, ".note"]),
-            notes: expectArray(extractEntry(jCpy, 'notes', false, path), false, [...path, ".notes"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, Annotation.fromJSON)),
+            notes: expectArray(extractEntry(jCpy, 'notes', false, path), false, [...path, ".notes"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, DecryptedAnnotation.fromJSON)),
             telecoms: expectArray(extractEntry(jCpy, 'telecoms', false, path), false, [...path, ".telecoms"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, DecryptedTelecom.fromJSON)),
             encryptedSelf: expectString(extractEntry(jCpy, 'encryptedSelf', false, path), true, [...path, ".encryptedSelf"]),
         });
@@ -229,7 +229,7 @@ export class EncryptedAddress {
             state: expectString(extractEntry(jCpy, 'state', false, path), true, [...path, ".state"]),
             country: expectString(extractEntry(jCpy, 'country', false, path), true, [...path, ".country"]),
             note: expectString(extractEntry(jCpy, 'note', false, path), true, [...path, ".note"]),
-            notes: expectArray(extractEntry(jCpy, 'notes', false, path), false, [...path, ".notes"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, Annotation.fromJSON)),
+            notes: expectArray(extractEntry(jCpy, 'notes', false, path), false, [...path, ".notes"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, EncryptedAnnotation.fromJSON)),
             telecoms: expectArray(extractEntry(jCpy, 'telecoms', false, path), false, [...path, ".telecoms"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, EncryptedTelecom.fromJSON)),
             encryptedSelf: expectString(extractEntry(jCpy, 'encryptedSelf', false, path), true, [...path, ".encryptedSelf"]),
         });