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 * to add side notes, * for example to flag a faulty thermometer after taking a temperature. * / */ export interface Annotation extends Identifiable, 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; 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; /** * * The encrypted content of this annotation. */ encryptedSelf: Base64String | undefined; readonly isEncrypted: false; constructor(partial: Partial); toJSON(): object; static fromJSON(json: any, ignoreUnknownKeys?: boolean, path?: Array): 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. */ 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; /** * * The encrypted content of this annotation. */ encryptedSelf: Base64String | undefined; readonly isEncrypted: true; constructor(partial: Partial); toJSON(): object; static fromJSON(json: any, ignoreUnknownKeys?: boolean, path?: Array): EncryptedAnnotation; }