@icure/cardinal-sdk 2.9.0 → 2.10.1

package/kotlinx-coroutines-core.mjs

@@ -235,6 +235,11 @@ initMetadataForClass(BufferedChannelIterator, 'BufferedChannelIterator', VOID, V
 initMetadataForCoroutine($sendCOROUTINE$, CoroutineImpl);
 initMetadataForCoroutine($receiveCOROUTINE$, CoroutineImpl);
 initMetadataForCoroutine($receiveCatchingCOROUTINE$, CoroutineImpl);
+function close$default(cause, $super) {
+  cause = cause === VOID ? null : cause;
+  return $super === VOID ? this.s1d(cause) : $super.s1d.call(this, cause);
+}
+initMetadataForInterface(SendChannel, 'SendChannel', VOID, VOID, VOID, [1]);
 function cancel$default_0(cause, $super) {
   cause = cause === VOID ? null : cause;
   var tmp;
@@ -247,12 +252,7 @@ function cancel$default_0(cause, $super) {
   return tmp;
 }
 initMetadataForInterface(ReceiveChannel, 'ReceiveChannel', VOID, VOID, VOID, [0]);
-function close$default(cause, $super) {
-  cause = cause === VOID ? null : cause;
-  return $super === VOID ? this.s1d(cause) : $super.s1d.call(this, cause);
-}
-initMetadataForInterface(SendChannel, 'SendChannel', VOID, VOID, VOID, [1]);
-initMetadataForClass(BufferedChannel, 'BufferedChannel', VOID, VOID, [ReceiveChannel, SendChannel], [1, 4, 0, 3]);
+initMetadataForClass(BufferedChannel, 'BufferedChannel', VOID, VOID, [SendChannel, ReceiveChannel], [1, 4, 0, 3]);
 initMetadataForClass(WaiterEB, 'WaiterEB');
 initMetadataForClass(ReceiveCatching, 'ReceiveCatching', VOID, VOID, [Waiter]);
 initMetadataForObject(Factory, 'Factory');
@@ -262,7 +262,7 @@ initMetadataForCompanion(Companion);
 initMetadataForClass(ChannelResult, 'ChannelResult');
 initMetadataForClass(ClosedReceiveChannelException, 'ClosedReceiveChannelException', VOID, NoSuchElementException);
 initMetadataForClass(ClosedSendChannelException, 'ClosedSendChannelException', VOID, IllegalStateException);
-initMetadataForClass(ChannelCoroutine, 'ChannelCoroutine', VOID, AbstractCoroutine, [ReceiveChannel, SendChannel], [1, 0]);
+initMetadataForClass(ChannelCoroutine, 'ChannelCoroutine', VOID, AbstractCoroutine, [SendChannel, ReceiveChannel], [1, 0]);
 initMetadataForClass(ConflatedBufferedChannel, 'ConflatedBufferedChannel', VOID, BufferedChannel, VOID, [1, 0]);
 initMetadataForInterface(ProducerScope, 'ProducerScope', VOID, VOID, [CoroutineScope, SendChannel], [1]);
 initMetadataForClass(ProducerCoroutine, 'ProducerCoroutine', VOID, ChannelCoroutine, [ProducerScope], [1, 0]);

package/model/Contact.d.mts

@@ -6,7 +6,7 @@ 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';
@@ -272,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;
@@ -453,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/Patient.d.mts

@@ -8,7 +8,7 @@ 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';
@@ -422,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).
@@ -790,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/embed/Address.d.mts

@@ -5,7 +5,7 @@ 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, HasIdentifier {
@@ -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"]),
         });

package/model/embed/Annotation.d.mts

@@ -1,5 +1,7 @@
 import { CodeStub } from '../base/CodeStub.mjs';
 import { Identifiable } from '../base/Identifiable.mjs';
+import { Base64String } from '../specializations/Base64String.mjs';
+import { Encryptable } from './Encryptable.mjs';
 /**
  *
  *  Text node with attribution that can be attached to a medical record. Used by healthcare parties
@@ -7,7 +9,127 @@ import { Identifiable } from '../base/Identifiable.mjs';
  *  for example to flag a faulty thermometer after taking a temperature.
  *  /
  */
-export declare class Annotation implements Identifiable<string> {
+export interface Annotation extends Identifiable<string>, Encryptable {
+    /**
+     *
+     *  The identifier of the author of this annotation.
+     */
+    author: string | undefined;
+    /**
+     *
+     *  The timestamp (unix epoch in ms) of creation of this note, filled automatically if missing.
+     */
+    created: number | undefined;
+    /**
+     *
+     *  The timestamp (unix epoch in ms) of the latest modification of this note, filled automatically
+     *  if missing.
+     */
+    modified: number | undefined;
+    /**
+     *
+     *  Text contained in the note, written as markdown. Deprecated in favor of [markdown].
+     */
+    text: string | undefined;
+    /**
+     *
+     *  Localized text contained in the note, written as markdown. Keys should respect ISO 639-1.
+     */
+    markdown: {
+        [key: string]: string;
+    };
+    /**
+     *
+     *  Defines to which part of the corresponding information the note is related to.
+     */
+    location: string | undefined;
+    /**
+     *
+     *  Whether this annotation is confidential.
+     */
+    confidential: boolean | undefined;
+    /**
+     *
+     *  Tags associated with this annotation.
+     */
+    tags: Array<CodeStub>;
+    readonly isEncrypted: boolean;
+    toJSON(): object;
+}
+/**
+ *
+ *  Text node with attribution that can be attached to a medical record. Used by healthcare parties
+ *  to add side notes,
+ *  for example to flag a faulty thermometer after taking a temperature.
+ *  /
+ */
+export declare class DecryptedAnnotation {
+    /**
+     *
+     *  The Id of the Annotation. We encourage using either a v4 UUID or a HL7 Id.
+     */
+    id: string;
+    /**
+     *
+     *  The identifier of the author of this annotation.
+     */
+    author: string | undefined;
+    /**
+     *
+     *  The timestamp (unix epoch in ms) of creation of this note, filled automatically if missing.
+     */
+    created: number | undefined;
+    /**
+     *
+     *  The timestamp (unix epoch in ms) of the latest modification of this note, filled automatically
+     *  if missing.
+     */
+    modified: number | undefined;
+    /**
+     *
+     *  Text contained in the note, written as markdown. Deprecated in favor of [markdown].
+     */
+    text: string | undefined;
+    /**
+     *
+     *  Localized text contained in the note, written as markdown. Keys should respect ISO 639-1.
+     */
+    markdown: {
+        [key: string]: string;
+    };
+    /**
+     *
+     *  Defines to which part of the corresponding information the note is related to.
+     */
+    location: string | undefined;
+    /**
+     *
+     *  Whether this annotation is confidential.
+     */
+    confidential: boolean | undefined;
+    /**
+     *
+     *  Tags associated with this annotation.
+     */
+    tags: Array<CodeStub>;
+    /**
+     *
+     *  The encrypted content of this annotation.
+     */
+    encryptedSelf: Base64String | undefined;
+    readonly isEncrypted: false;
+    constructor(partial: Partial<DecryptedAnnotation>);
+    toJSON(): object;
+    static fromJSON(json: any, ignoreUnknownKeys?: boolean, path?: Array<string>): DecryptedAnnotation;
+}
+/**
+ *
+ *  Text node with attribution that can be attached to a medical record. Used by healthcare parties
+ *  to add side notes,
+ *  for example to flag a faulty thermometer after taking a temperature.
+ *  /
+ */
+export declare class EncryptedAnnotation {
     /**
      *
      *  The Id of the Annotation. We encourage using either a v4 UUID or a HL7 Id.
@@ -60,8 +182,9 @@ export declare class Annotation implements Identifiable<string> {
      *
      *  The encrypted content of this annotation.
      */
-    encryptedSelf: string | undefined;
-    constructor(partial: Partial<Annotation>);
+    encryptedSelf: Base64String | undefined;
+    readonly isEncrypted: true;
+    constructor(partial: Partial<EncryptedAnnotation>);
     toJSON(): object;
-    static fromJSON(json: any, ignoreUnknownKeys?: boolean, path?: Array<string>): Annotation;
+    static fromJSON(json: any, ignoreUnknownKeys?: boolean, path?: Array<string>): EncryptedAnnotation;
 }

package/model/embed/Annotation.mjs

@@ -9,7 +9,7 @@ import { CodeStub } from '../base/CodeStub.mjs';
  *  for example to flag a faulty thermometer after taking a temperature.
  *  /
  */
-export class Annotation {
+export class DecryptedAnnotation {
     constructor(partial) {
         var _a;
         /**
@@ -58,6 +58,9 @@ export class Annotation {
          *  The encrypted content of this annotation.
          */
         this.encryptedSelf = undefined;
+        this.isEncrypted = false;
+        if (partial.isEncrypted !== undefined && partial.isEncrypted !== false)
+            throw new Error('partial.isEncrypted must be undefined or false');
         this.id = (_a = partial.id) !== null && _a !== void 0 ? _a : randomUuid();
         if ('author' in partial)
             this.author = partial.author;
@@ -97,13 +100,16 @@ export class Annotation {
         res['tags'] = this.tags.map((x0) => x0.toJSON());
         if (this.encryptedSelf != undefined)
             res['encryptedSelf'] = this.encryptedSelf;
+        res['isEncrypted'] = false;
         return res;
     }
-    static fromJSON(json, ignoreUnknownKeys = false, path = ['Annotation']) {
+    static fromJSON(json, ignoreUnknownKeys = false, path = ['DecryptedAnnotation']) {
         if (typeof json != 'object')
             throw new Error(`Expected json object at path ${path.join("")}`);
         const jCpy = Object.assign({}, json);
-        const res = new Annotation({
+        if (extractEntry(jCpy, "isEncrypted", true, path) !== false)
+            throw new Error(`Unexpected value for ${path.join("")} isEncrypted marker, should be false. The provided json doesn't represent a DecryptedAnnotation`);
+        const res = new DecryptedAnnotation({
             id: expectString(extractEntry(jCpy, 'id', true, path), false, [...path, ".id"]),
             author: expectString(extractEntry(jCpy, 'author', false, path), true, [...path, ".author"]),
             created: expectNumber(extractEntry(jCpy, 'created', false, path), true, true, [...path, ".created"]),
@@ -118,7 +124,134 @@ export class Annotation {
         if (!ignoreUnknownKeys) {
             const unused = Object.keys(jCpy);
             if (unused.length > 0)
-                throw new Error(`Unexpected key(s) for json object Annotation at path ${path.join("")}: ${unused}`);
+                throw new Error(`Unexpected key(s) for json object DecryptedAnnotation at path ${path.join("")}: ${unused}`);
+        }
+        return res;
+    }
+}
+/**
+ *
+ *  Text node with attribution that can be attached to a medical record. Used by healthcare parties
+ *  to add side notes,
+ *  for example to flag a faulty thermometer after taking a temperature.
+ *  /
+ */
+export class EncryptedAnnotation {
+    constructor(partial) {
+        var _a;
+        /**
+         *
+         *  The identifier of the author of this annotation.
+         */
+        this.author = undefined;
+        /**
+         *
+         *  The timestamp (unix epoch in ms) of creation of this note, filled automatically if missing.
+         */
+        this.created = undefined;
+        /**
+         *
+         *  The timestamp (unix epoch in ms) of the latest modification of this note, filled automatically
+         *  if missing.
+         */
+        this.modified = undefined;
+        /**
+         *
+         *  Text contained in the note, written as markdown. Deprecated in favor of [markdown].
+         */
+        this.text = undefined;
+        /**
+         *
+         *  Localized text contained in the note, written as markdown. Keys should respect ISO 639-1.
+         */
+        this.markdown = {};
+        /**
+         *
+         *  Defines to which part of the corresponding information the note is related to.
+         */
+        this.location = undefined;
+        /**
+         *
+         *  Whether this annotation is confidential.
+         */
+        this.confidential = undefined;
+        /**
+         *
+         *  Tags associated with this annotation.
+         */
+        this.tags = [];
+        /**
+         *
+         *  The encrypted content of this annotation.
+         */
+        this.encryptedSelf = undefined;
+        this.isEncrypted = true;
+        if (partial.isEncrypted !== undefined && partial.isEncrypted !== true)
+            throw new Error('partial.isEncrypted must be undefined or true');
+        this.id = (_a = partial.id) !== null && _a !== void 0 ? _a : randomUuid();
+        if ('author' in partial)
+            this.author = partial.author;
+        if ('created' in partial)
+            this.created = partial.created;
+        if ('modified' in partial)
+            this.modified = partial.modified;
+        if ('text' in partial)
+            this.text = partial.text;
+        if ('markdown' in partial && partial.markdown !== undefined)
+            this.markdown = partial.markdown;
+        if ('location' in partial)
+            this.location = partial.location;
+        if ('confidential' in partial)
+            this.confidential = partial.confidential;
+        if ('tags' in partial && partial.tags !== undefined)
+            this.tags = partial.tags;
+        if ('encryptedSelf' in partial)
+            this.encryptedSelf = partial.encryptedSelf;
+    }
+    toJSON() {
+        const res = {};
+        res['id'] = this.id;
+        if (this.author != undefined)
+            res['author'] = this.author;
+        if (this.created != undefined)
+            res['created'] = this.created;
+        if (this.modified != undefined)
+            res['modified'] = this.modified;
+        if (this.text != undefined)
+            res['text'] = this.text;
+        res['markdown'] = Object.fromEntries(Object.entries(this.markdown).map(([k0, v0]) => [k0, v0]));
+        if (this.location != undefined)
+            res['location'] = this.location;
+        if (this.confidential != undefined)
+            res['confidential'] = this.confidential;
+        res['tags'] = this.tags.map((x0) => x0.toJSON());
+        if (this.encryptedSelf != undefined)
+            res['encryptedSelf'] = this.encryptedSelf;
+        res['isEncrypted'] = true;
+        return res;
+    }
+    static fromJSON(json, ignoreUnknownKeys = false, path = ['EncryptedAnnotation']) {
+        if (typeof json != 'object')
+            throw new Error(`Expected json object at path ${path.join("")}`);
+        const jCpy = Object.assign({}, json);
+        if (extractEntry(jCpy, "isEncrypted", true, path) !== true)
+            throw new Error(`Unexpected value for ${path.join("")} isEncrypted marker, should be true. The provided json doesn't represent a EncryptedAnnotation`);
+        const res = new EncryptedAnnotation({
+            id: expectString(extractEntry(jCpy, 'id', true, path), false, [...path, ".id"]),
+            author: expectString(extractEntry(jCpy, 'author', false, path), true, [...path, ".author"]),
+            created: expectNumber(extractEntry(jCpy, 'created', false, path), true, true, [...path, ".created"]),
+            modified: expectNumber(extractEntry(jCpy, 'modified', false, path), true, true, [...path, ".modified"]),
+            text: expectString(extractEntry(jCpy, 'text', false, path), true, [...path, ".text"]),
+            markdown: expectMap(extractEntry(jCpy, 'markdown', false, path), false, [...path, ".markdown"], (k0, p0) => expectString(k0, false, p0), (v0, p0) => expectString(v0, false, p0)),
+            location: expectString(extractEntry(jCpy, 'location', false, path), true, [...path, ".location"]),
+            confidential: expectBoolean(extractEntry(jCpy, 'confidential', false, path), true, [...path, ".confidential"]),
+            tags: expectArray(extractEntry(jCpy, 'tags', false, path), false, [...path, ".tags"], (x0, p0) => expectObject(x0, false, ignoreUnknownKeys, p0, CodeStub.fromJSON)),
+            encryptedSelf: expectString(extractEntry(jCpy, 'encryptedSelf', false, path), true, [...path, ".encryptedSelf"]),
+        });
+        if (!ignoreUnknownKeys) {
+            const unused = Object.keys(jCpy);
+            if (unused.length > 0)
+                throw new Error(`Unexpected key(s) for json object EncryptedAnnotation at path ${path.join("")}: ${unused}`);
         }
         return res;
     }

package/model/embed/ReferenceRange.d.mts

@@ -1,5 +1,5 @@
 import { CodeStub } from '../base/CodeStub.mjs';
-import { Annotation } from './Annotation.mjs';
+import { DecryptedAnnotation } from './Annotation.mjs';
 import { Range } from './Range.mjs';
 /**
  *
@@ -37,7 +37,7 @@ export declare class ReferenceRange {
      *
      *  Annotations providing additional context.
      */
-    notes: Array<Annotation>;
+    notes: Array<DecryptedAnnotation>;
     /**
      *
      *  The age range to which this reference range applies.

package/model/embed/ReferenceRange.mjs

@@ -1,7 +1,7 @@
 // auto-generated file
 import { expectArray, expectNumber, expectObject, expectString, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
 import { CodeStub } from '../base/CodeStub.mjs';
-import { Annotation } from './Annotation.mjs';
+import { DecryptedAnnotation } from './Annotation.mjs';
 import { Range } from './Range.mjs';
 /**
  *
@@ -86,7 +86,7 @@ export class ReferenceRange {
             stringValue: expectString(extractEntry(jCpy, 'stringValue', false, path), true, [...path, ".stringValue"]),
             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)),
-            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)),
             age: expectObject(extractEntry(jCpy, 'age', false, path), true, ignoreUnknownKeys, [...path, ".age"], Range.fromJSON),
         });
         if (!ignoreUnknownKeys) {

package/model/embed/Service.d.mts

@@ -5,7 +5,7 @@ import { ICureDocument } from '../base/ICureDocument.mjs';
 import { Identifier } from '../base/Identifier.mjs';
 import { LinkQualification } from '../base/LinkQualification.mjs';
 import { Base64String } from '../specializations/Base64String.mjs';
-import { Annotation } from './Annotation.mjs';
+import { Annotation, DecryptedAnnotation, EncryptedAnnotation } from './Annotation.mjs';
 import { Content, DecryptedContent, EncryptedContent } from './Content.mjs';
 import { Delegation } from './Delegation.mjs';
 import { Encryptable } from './Encryptable.mjs';
@@ -289,7 +289,7 @@ export declare class DecryptedService {
      *
      *  Comments - Notes recorded by a HCP about this service
      */
-    notes: Array<Annotation>;
+    notes: Array<DecryptedAnnotation>;
     /**
      *
      *  Links towards related services (possibly in other contacts)
@@ -462,7 +462,7 @@ export declare class EncryptedService {
      *
      *  Comments - Notes recorded by a HCP about this service
      */
-    notes: Array<Annotation>;
+    notes: Array<EncryptedAnnotation>;
     /**
      *
      *  Links towards related services (possibly in other contacts)