@icure/api 7.1.16 → 8.0.0-RC.2

package/icc-api/model/Patient.js.map

@@ -1 +1 @@
-{"version":3,"file":"Patient.js","sourceRoot":"","sources":["../../../icc-api/model/Patient.ts"],"names":[],"mappings":";;;AA0BA;;GAEG;AACH,+CAAuC;AACvC,MAAa,OAAO;IAClB,YAAY,IAAgB;QAC1B,IAAI,WAAW,GAA8B,EAAE,CAAA;QAC/C,IAAI,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE;YAClB,IAAI,OAAO,IAAI,CAAC,OAAO,KAAK,QAAQ,EAAE;gBACpC,WAAW,CAAC,OAAO,GAAG,IAAA,qBAAO,EAAC,IAAI,CAAC,OAAO,CAAC,CAAA;aAC5C;iBAAM,IAAI,IAAI,CAAC,OAAO,YAAY,WAAW,IAAI,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;gBAClF,WAAW,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAA;aACnC;iBAAM;gBACL,MAAM,IAAI,KAAK,CAAC,6BAA6B,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;aACpE;SACF;QACD,MAAM,CAAC,MAAM,CAAC,IAAe,EAAE,IAAI,EAAE,WAAW,CAAC,CAAA;IACnD,CAAC;CA4RF;AAzSD,0BAySC;AACD,WAAiB,OAAO;IAET,kBAAU,GAAG;QACxB,IAAI,EAAE,MAAoB;QAC1B,MAAM,EAAE,QAAsB;QAC9B,aAAa,EAAE,eAA6B;QAC5C,OAAO,EAAE,SAAuB;QAChC,aAAa,EAAE,eAA6B;QAC5C,eAAe,EAAE,iBAA+B;QAChD,OAAO,EAAE,SAAuB;KACjC,CAAA;IAEY,oBAAY,GAAG;QAC1B,IAAI,EAAE,MAAsB;QAC5B,MAAM,EAAE,QAAwB;QAChC,aAAa,EAAE,eAA+B;QAC9C,OAAO,EAAE,SAAyB;QAClC,aAAa,EAAE,eAA+B;QAC9C,eAAe,EAAE,iBAAiC;QAClD,OAAO,EAAE,SAAyB;KACnC,CAAA;IAEY,8BAAsB,GAAG;QACpC,QAAQ,EAAE,UAAoC;QAC9C,KAAK,EAAE,OAAiC;QACxC,WAAW,EAAE,cAAwC;QACrD,OAAO,EAAE,SAAmC;QAC5C,SAAS,EAAE,YAAsC;QACjD,OAAO,EAAE,SAAmC;QAC5C,IAAI,EAAE,MAAgC;KACvC,CAAA;IAgBY,0BAAkB,GAAG;QAChC,MAAM,EAAE,QAA8B;QACtC,QAAQ,EAAE,WAAiC;QAC3C,OAAO,EAAE,SAA+B;QACxC,SAAS,EAAE,WAAiC;QAC5C,QAAQ,EAAE,UAAgC;QAC1C,SAAS,EAAE,WAAiC;QAC5C,OAAO,EAAE,SAA+B;QACxC,OAAO,EAAE,SAA+B;QACxC,WAAW,EAAE,aAAmC;QAChD,OAAO,EAAE,SAA+B;QACxC,QAAQ,EAAE,UAAgC;QAC1C,KAAK,EAAE,OAA6B;QACpC,QAAQ,EAAE,UAAgC;QAC1C,UAAU,EAAE,YAAkC;KAC/C,CAAA;AACH,CAAC,EA9DgB,OAAO,GAAP,eAAO,KAAP,eAAO,QA8DvB","sourcesContent":["/**\n * iCure Data Stack API Documentation\n * The iCure Data Stack Application API is the native interface to iCure. This version is obsolete, please use v2.\n *\n * OpenAPI spec version: v1\n *\n *\n * NOTE: This class is auto generated by the swagger code generator program.\n * https://github.com/swagger-api/swagger-codegen.git\n * Do not edit the class manually.\n */\nimport { Address } from './Address'\nimport { CodeStub } from './CodeStub'\nimport { Delegation } from './Delegation'\nimport { EmploymentInfo } from './EmploymentInfo'\nimport { FinancialInstitutionInformation } from './FinancialInstitutionInformation'\nimport { Identifier } from './Identifier'\nimport { Insurability } from './Insurability'\nimport { MedicalHouseContract } from './MedicalHouseContract'\nimport { Partnership } from './Partnership'\nimport { PatientHealthCareParty } from './PatientHealthCareParty'\nimport { PersonName } from './PersonName'\nimport { PropertyStub } from './PropertyStub'\nimport { SchoolingInfo } from './SchoolingInfo'\nimport { Annotation } from './Annotation'\n\n/**\n * This entity is a root level object. It represents a patient It is serialized in JSON and saved in the underlying icure-patient CouchDB database.\n */\nimport { b64_2ab } from './ModelHelper'\nexport class Patient {\n  constructor(json: JSON | any) {\n    let pictureData: { picture?: ArrayBuffer } = {}\n    if (!!json.picture) {\n      if (typeof json.picture === 'string') {\n        pictureData.picture = b64_2ab(json.picture)\n      } else if (json.picture instanceof ArrayBuffer || ArrayBuffer.isView(json.picture)) {\n        pictureData.picture = json.picture\n      } else {\n        throw new Error(`Invalid type for picture: ${typeof json.picture}`)\n      }\n    }\n    Object.assign(this as Patient, json, pictureData)\n  }\n\n  /**\n   * the Id of the patient. We encourage using either a v4 UUID or a HL7 Id.\n   */\n  id?: string\n  /**\n   * the revision of the patient in the database, used for conflict management / optimistic locking.\n   */\n  rev?: string\n  identifier?: Array<Identifier>\n  /**\n   * The timestamp (unix epoch in ms) of creation of this entity, will be filled automatically if missing. Not enforced by the application server.\n   */\n  created?: number\n  /**\n   * The date (unix epoch in ms) of the latest modification of this entity, will be filled automatically if missing. Not enforced by the application server.\n   */\n  modified?: number\n  /**\n   * The id of the User that has created this entity, will be filled automatically if missing. Not enforced by the application server.\n   */\n  author?: string\n  /**\n   * The id of the HealthcareParty that is responsible for this entity, will be filled automatically if missing. Not enforced by the application server.\n   */\n  responsible?: string\n  /**\n   * A tag is an item from a codification system that qualifies an entity as being member of a certain class, whatever the value it might have taken. If the tag qualifies the content of a field, it means that whatever the content of the field, the tag will always apply. For example, the label of a field is qualified using a tag. LOINC is a codification system typically used for tags.\n   */\n  tags?: Array<CodeStub>\n  /**\n   * A code is an item from a codification system that qualifies the content of this entity. SNOMED-CT, ICPC-2 or ICD-10 codifications systems can be used for codes\n   */\n  codes?: Array<CodeStub>\n  /**\n   * Soft delete (unix epoch in ms) timestamp of the object.\n   */\n  endOfLife?: number\n  /**\n   * hard delete (unix epoch in ms) timestamp of the object. Filled automatically when deletePatient is called.\n   */\n  deletionDate?: number\n  /**\n   * the firstname (name) of the patient.\n   */\n  firstName?: string\n  /**\n   * the lastname (surname) of the patient. This is the official lastname that should be used for official administrative purposes.\n   */\n  lastName?: string\n  /**\n   * the list of all names of the patient, also containing the official full name information. Ordered by preference of use. First element is therefore the official name used for the patient in the application\n   */\n  names?: Array<PersonName>\n  /**\n   * the name of the company this patient is member of.\n   */\n  companyName?: string\n  /**\n   * the list of languages spoken by the patient ordered by fluency (alpha-2 code http://www.loc.gov/standards/iso639-2/ascii_8bits.html).\n   */\n  languages?: Array<string>\n  /**\n   * the list of addresses (with address type).\n   */\n  addresses?: Array<Address>\n  /**\n   * Mr., Ms., Pr., Dr. ...\n   */\n  civility?: string\n  /**\n   * the gender of the patient: male, female, indeterminate, changed, changedToMale, changedToFemale, unknown\n   */\n  gender?: Patient.GenderEnum\n  /**\n   * the birth sex of the patient: male, female, indeterminate, unknown\n   */\n  birthSex?: Patient.BirthSexEnum\n  /**\n   * The id of the patient this patient has been merged with.\n   */\n  mergeToPatientId?: string\n  /**\n   * The ids of the patients that have been merged inside this patient.\n   */\n  mergedIds?: Array<string>\n  /**\n   * An alias of the person, nickname, ...\n   */\n  alias?: string\n  /**\n   * Is the patient active (boolean).\n   */\n  active?: boolean\n  /**\n   * When not active, the reason for deactivation.\n   */\n  deactivationReason?: Patient.DeactivationReasonEnum\n  /**\n   * Deactivation date of the patient\n   */\n  deactivationDate?: number\n  /**\n   * Social security inscription number.\n   */\n  ssin?: string\n  /**\n   * Lastname at birth (can be different of the current name), depending on the country, must be used to design the patient .\n   */\n  maidenName?: string\n  /**\n   * Lastname of the spouse for a married woman, depending on the country, can be used to design the patient.\n   */\n  spouseName?: string\n  /**\n   * Lastname of the partner, should not be used to design the patient.\n   */\n  partnerName?: string\n  /**\n   * any of `single`, `in_couple`, `married`, `separated`, `divorced`, `divorcing`, `widowed`, `widower`, `complicated`, `unknown`, `contract`, `other`.\n   */\n  personalStatus?: Patient.PersonalStatusEnum\n  /**\n   * The birthdate encoded as a fuzzy date on 8 positions (YYYYMMDD) MM and/or DD can be set to 00 if unknown (19740000 is a valid date).\n   */\n  dateOfBirth?: number\n  /**\n   * The date of death encoded as a fuzzy date on 8 positions (YYYYMMDD) MM and/or DD can be set to 00 if unknown (19740000 is a valid date).\n   */\n  dateOfDeath?: number\n  /**\n   * Timestamp of the latest validation of the eID of the person..\n   */\n  timestampOfLatestEidReading?: number\n  /**\n   * The place of birth.\n   */\n  placeOfBirth?: string\n  /**\n   * The place of death.\n   */\n  placeOfDeath?: string\n  /**\n   * Is the patient deceased.\n   */\n  deceased?: boolean\n  /**\n   * The level of education (college degree, undergraduate, phd).\n   */\n  education?: string\n  /**\n   * The current professional activity.\n   */\n  profession?: string\n  /**\n   * A text note (can be confidential, encrypted by default).\n   * @deprecated use notes instead with proper tags\n   */\n  note?: string\n  /**\n   * An administrative note, not confidential.\n   * @deprecated use notes instead with proper tags\n   */\n  administrativeNote?: string\n  /**\n   * A list of localized notes.\n   */\n  notes?: Annotation[]\n  /**\n   * The nationality of the patient.\n   */\n  nationality?: string\n  /**\n   * The race of the patient.\n   */\n  race?: string\n  /**\n   * The ethnicity of the patient.\n   */\n  ethnicity?: string\n  /**\n   * The id of the user that usually handles this patient.\n   */\n  preferredUserId?: string\n  /**\n   * A picture usually saved in JPEG format.\n   */\n  picture?: ArrayBuffer\n  /**\n   * An external (from another source) id with no guarantee or requirement for unicity .\n   */\n  externalId?: string\n  /**\n   * List of insurance coverages (of class Insurability, see below).\n   */\n  insurabilities?: Array<Insurability>\n  /**\n   * List of partners, or persons of contact (of class Partnership, see below).\n   */\n  partnerships?: Array<Partnership>\n  /**\n   * Links (usually for therapeutic reasons) between this patient and healthcare parties (of class PatientHealthcareParty).\n   */\n  patientHealthCareParties?: Array<PatientHealthCareParty>\n  /**\n   * Financial information (Bank, bank account) used to reimburse the patient.\n   */\n  financialInstitutionInformation?: Array<FinancialInstitutionInformation>\n  /**\n   * Contracts between the patient and the healthcare entity.\n   */\n  medicalHouseContracts?: Array<MedicalHouseContract>\n  /**\n   * Codified list of professions exercised by this patient.\n   */\n  patientProfessions?: Array<CodeStub>\n  /**\n   * Extra parameters\n   */\n  parameters?: { [key: string]: Array<string> }\n  /**\n   * Extra properties\n   */\n  properties?: Array<PropertyStub>\n  /**\n   * For each couple of HcParties (delegator and delegate), this map contains the exchange AES key. The delegator is always this hcp, the key of the map is the id of the delegate.The AES exchange key is encrypted using RSA twice : once using this hcp public key (index 0 in the Array) and once using the other hcp public key (index 1 in the Array). For a pair of HcParties. Each HcParty always has one AES exchange key for himself.\n   */\n  hcPartyKeys?: { [key: string]: Array<string> }\n  /**\n   * Extra AES exchange keys, usually the ones we lost access to at some point. The structure is { publicKey: { delegateId: { myPubKey1: aesExKey_for_this, delegatePubKey1: aesExKey_for_delegate } } }\n   */\n  aesExchangeKeys?: { [key: string]: { [key: string]: { [key: string]: string } } }\n  /**\n   * Our private keys encrypted with our public keys. The structure is { publicKey1: { publicKey2: privateKey2_encrypted_with_publicKey1, publicKey3: privateKey3_encrypted_with_publicKey1 } }\n   */\n  transferKeys?: { [key: string]: { [key: string]: string } }\n  /**\n   * The privateKeyShamirPartitions are used to share this hcp's private RSA key with a series of other hcParties using Shamir's algorithm. The key of the map is the hcp Id with whom this partition has been shared. The value is \\\"threshold⎮partition in hex\\\" encrypted using the the partition's holder's public RSA key\n   */\n  privateKeyShamirPartitions?: { [key: string]: string }\n  /**\n   * The public key of this hcp\n   */\n  publicKey?: string\n  /**\n   * The public keys of this actor which should be used for RSA-OAEP with sha256 encryption.\n   */\n  publicKeysForOaepWithSha256?: string[]\n  /**\n   * The secretForeignKeys are filled at the to many end of a one to many relationship (for example inside Contact for the Patient -> Contacts relationship). Used when we want to find all contacts for a specific patient. These keys are in clear. You can have several to partition the medical document space.\n   */\n  secretForeignKeys?: Array<string>\n  /**\n   * The secretForeignKeys are filled at the to many end of a one to many relationship (for example inside Contact for the Patient -> Contacts relationship). Used when we want to find the patient for a specific contact. These keys are the encrypted id (using the hcParty key for the delegate) that can be found in clear inside the patient. ids encrypted using the hcParty keys.\n   */\n  cryptedForeignKeys?: { [key: string]: Array<Delegation> }\n  /**\n   * When a document is created, the responsible generates a cryptographically random master key (never to be used for something else than referencing from other entities). He/she encrypts it using his own AES exchange key and stores it as a delegation. The responsible is thus always in the delegations as well\n   */\n  delegations?: { [key: string]: Array<Delegation> }\n  /**\n   * When a document needs to be encrypted, the responsible generates a cryptographically random master key (different from the delegation key, never to appear in clear anywhere in the db. He/she encrypts it using his own AES exchange key and stores it as a delegation\n   */\n  encryptionKeys?: { [key: string]: Array<Delegation> }\n  /**\n   * The base64 encoded data of this object, formatted as JSON and encrypted in AES using the random master key from encryptionKeys.\n   */\n  encryptedSelf?: string\n  /**\n   * The id of the medical location where this entity was created.\n   */\n  medicalLocationId?: string\n  nonDuplicateIds?: Array<string>\n  encryptedAdministrativesDocuments?: Array<string>\n  comment?: string\n  warning?: string\n  fatherBirthCountry?: CodeStub\n  birthCountry?: CodeStub\n  nativeCountry?: CodeStub\n  socialStatus?: CodeStub\n  mainSourceOfIncome?: CodeStub\n  schoolingInfos?: Array<SchoolingInfo>\n  employementInfos?: Array<EmploymentInfo>\n}\nexport namespace Patient {\n  export type GenderEnum = 'male' | 'female' | 'indeterminate' | 'changed' | 'changedToMale' | 'changedToFemale' | 'unknown'\n  export const GenderEnum = {\n    Male: 'male' as GenderEnum,\n    Female: 'female' as GenderEnum,\n    Indeterminate: 'indeterminate' as GenderEnum,\n    Changed: 'changed' as GenderEnum,\n    ChangedToMale: 'changedToMale' as GenderEnum,\n    ChangedToFemale: 'changedToFemale' as GenderEnum,\n    Unknown: 'unknown' as GenderEnum,\n  }\n  export type BirthSexEnum = 'male' | 'female' | 'indeterminate' | 'changed' | 'changedToMale' | 'changedToFemale' | 'unknown'\n  export const BirthSexEnum = {\n    Male: 'male' as BirthSexEnum,\n    Female: 'female' as BirthSexEnum,\n    Indeterminate: 'indeterminate' as BirthSexEnum,\n    Changed: 'changed' as BirthSexEnum,\n    ChangedToMale: 'changedToMale' as BirthSexEnum,\n    ChangedToFemale: 'changedToFemale' as BirthSexEnum,\n    Unknown: 'unknown' as BirthSexEnum,\n  }\n  export type DeactivationReasonEnum = 'deceased' | 'moved' | 'other_doctor' | 'retired' | 'no_contact' | 'unknown' | 'none'\n  export const DeactivationReasonEnum = {\n    Deceased: 'deceased' as DeactivationReasonEnum,\n    Moved: 'moved' as DeactivationReasonEnum,\n    OtherDoctor: 'other_doctor' as DeactivationReasonEnum,\n    Retired: 'retired' as DeactivationReasonEnum,\n    NoContact: 'no_contact' as DeactivationReasonEnum,\n    Unknown: 'unknown' as DeactivationReasonEnum,\n    None: 'none' as DeactivationReasonEnum,\n  }\n  export type PersonalStatusEnum =\n    | 'single'\n    | 'in_couple'\n    | 'married'\n    | 'separated'\n    | 'divorced'\n    | 'divorcing'\n    | 'widowed'\n    | 'widower'\n    | 'complicated'\n    | 'unknown'\n    | 'contract'\n    | 'other'\n    | 'annulled'\n    | 'polygamous'\n  export const PersonalStatusEnum = {\n    Single: 'single' as PersonalStatusEnum,\n    InCouple: 'in_couple' as PersonalStatusEnum,\n    Married: 'married' as PersonalStatusEnum,\n    Separated: 'separated' as PersonalStatusEnum,\n    Divorced: 'divorced' as PersonalStatusEnum,\n    Divorcing: 'divorcing' as PersonalStatusEnum,\n    Widowed: 'widowed' as PersonalStatusEnum,\n    Widower: 'widower' as PersonalStatusEnum,\n    Complicated: 'complicated' as PersonalStatusEnum,\n    Unknown: 'unknown' as PersonalStatusEnum,\n    Contract: 'contract' as PersonalStatusEnum,\n    Other: 'other' as PersonalStatusEnum,\n    Annulled: 'annulled' as PersonalStatusEnum,\n    Polygamous: 'polygamous' as PersonalStatusEnum,\n  }\n}\n"]}
+{"version":3,"file":"Patient.js","sourceRoot":"","sources":["../../../icc-api/model/Patient.ts"],"names":[],"mappings":";;;AA0BA;;GAEG;AACH,+CAAuC;AAGvC,MAAa,OAAO;IAClB,YAAY,IAAgB;QAC1B,IAAI,WAAW,GAA8B,EAAE,CAAA;QAC/C,IAAI,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE;YAClB,IAAI,OAAO,IAAI,CAAC,OAAO,KAAK,QAAQ,EAAE;gBACpC,WAAW,CAAC,OAAO,GAAG,IAAA,qBAAO,EAAC,IAAI,CAAC,OAAO,CAAC,CAAA;aAC5C;iBAAM,IAAI,IAAI,CAAC,OAAO,YAAY,WAAW,IAAI,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;gBAClF,WAAW,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAA;aACnC;iBAAM;gBACL,MAAM,IAAI,KAAK,CAAC,6BAA6B,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;aACpE;SACF;QACD,MAAM,CAAC,MAAM,CAAC,IAAe,EAAE,IAAI,EAAE,WAAW,CAAC,CAAA;IACnD,CAAC;CA8RF;AA3SD,0BA2SC;AACD,WAAiB,OAAO;IAET,kBAAU,GAAG;QACxB,IAAI,EAAE,MAAoB;QAC1B,MAAM,EAAE,QAAsB;QAC9B,aAAa,EAAE,eAA6B;QAC5C,OAAO,EAAE,SAAuB;QAChC,aAAa,EAAE,eAA6B;QAC5C,eAAe,EAAE,iBAA+B;QAChD,OAAO,EAAE,SAAuB;KACjC,CAAA;IAEY,oBAAY,GAAG;QAC1B,IAAI,EAAE,MAAsB;QAC5B,MAAM,EAAE,QAAwB;QAChC,aAAa,EAAE,eAA+B;QAC9C,OAAO,EAAE,SAAyB;QAClC,aAAa,EAAE,eAA+B;QAC9C,eAAe,EAAE,iBAAiC;QAClD,OAAO,EAAE,SAAyB;KACnC,CAAA;IAEY,8BAAsB,GAAG;QACpC,QAAQ,EAAE,UAAoC;QAC9C,KAAK,EAAE,OAAiC;QACxC,WAAW,EAAE,cAAwC;QACrD,OAAO,EAAE,SAAmC;QAC5C,SAAS,EAAE,YAAsC;QACjD,OAAO,EAAE,SAAmC;QAC5C,IAAI,EAAE,MAAgC;KACvC,CAAA;IAgBY,0BAAkB,GAAG;QAChC,MAAM,EAAE,QAA8B;QACtC,QAAQ,EAAE,WAAiC;QAC3C,OAAO,EAAE,SAA+B;QACxC,SAAS,EAAE,WAAiC;QAC5C,QAAQ,EAAE,UAAgC;QAC1C,SAAS,EAAE,WAAiC;QAC5C,OAAO,EAAE,SAA+B;QACxC,OAAO,EAAE,SAA+B;QACxC,WAAW,EAAE,aAAmC;QAChD,OAAO,EAAE,SAA+B;QACxC,QAAQ,EAAE,UAAgC;QAC1C,KAAK,EAAE,OAA6B;QACpC,QAAQ,EAAE,UAAgC;QAC1C,UAAU,EAAE,YAAkC;KAC/C,CAAA;AACH,CAAC,EA9DgB,OAAO,GAAP,eAAO,KAAP,eAAO,QA8DvB","sourcesContent":["/**\n * iCure Data Stack API Documentation\n * The iCure Data Stack Application API is the native interface to iCure. This version is obsolete, please use v2.\n *\n * OpenAPI spec version: v1\n *\n *\n * NOTE: This class is auto generated by the swagger code generator program.\n * https://github.com/swagger-api/swagger-codegen.git\n * Do not edit the class manually.\n */\nimport { Address } from './Address'\nimport { CodeStub } from './CodeStub'\nimport { Delegation } from './Delegation'\nimport { EmploymentInfo } from './EmploymentInfo'\nimport { FinancialInstitutionInformation } from './FinancialInstitutionInformation'\nimport { Identifier } from './Identifier'\nimport { Insurability } from './Insurability'\nimport { MedicalHouseContract } from './MedicalHouseContract'\nimport { Partnership } from './Partnership'\nimport { PatientHealthCareParty } from './PatientHealthCareParty'\nimport { PersonName } from './PersonName'\nimport { PropertyStub } from './PropertyStub'\nimport { SchoolingInfo } from './SchoolingInfo'\nimport { Annotation } from './Annotation'\n\n/**\n * This entity is a root level object. It represents a patient It is serialized in JSON and saved in the underlying icure-patient CouchDB database.\n */\nimport { b64_2ab } from './ModelHelper'\nimport { SecurityMetadata } from './SecurityMetadata'\nimport { EntityWithDelegationTypeName } from '../../icc-x-api/utils/EntityWithDelegationTypeName'\nexport class Patient {\n  constructor(json: JSON | any) {\n    let pictureData: { picture?: ArrayBuffer } = {}\n    if (!!json.picture) {\n      if (typeof json.picture === 'string') {\n        pictureData.picture = b64_2ab(json.picture)\n      } else if (json.picture instanceof ArrayBuffer || ArrayBuffer.isView(json.picture)) {\n        pictureData.picture = json.picture\n      } else {\n        throw new Error(`Invalid type for picture: ${typeof json.picture}`)\n      }\n    }\n    Object.assign(this as Patient, json, pictureData)\n  }\n\n  /**\n   * the Id of the patient. We encourage using either a v4 UUID or a HL7 Id.\n   */\n  id?: string\n  /**\n   * the revision of the patient in the database, used for conflict management / optimistic locking.\n   */\n  rev?: string\n  identifier?: Array<Identifier>\n  /**\n   * The timestamp (unix epoch in ms) of creation of this entity, will be filled automatically if missing. Not enforced by the application server.\n   */\n  created?: number\n  /**\n   * The date (unix epoch in ms) of the latest modification of this entity, will be filled automatically if missing. Not enforced by the application server.\n   */\n  modified?: number\n  /**\n   * The id of the User that has created this entity, will be filled automatically if missing. Not enforced by the application server.\n   */\n  author?: string\n  /**\n   * The id of the HealthcareParty that is responsible for this entity, will be filled automatically if missing. Not enforced by the application server.\n   */\n  responsible?: string\n  /**\n   * A tag is an item from a codification system that qualifies an entity as being member of a certain class, whatever the value it might have taken. If the tag qualifies the content of a field, it means that whatever the content of the field, the tag will always apply. For example, the label of a field is qualified using a tag. LOINC is a codification system typically used for tags.\n   */\n  tags?: Array<CodeStub>\n  /**\n   * A code is an item from a codification system that qualifies the content of this entity. SNOMED-CT, ICPC-2 or ICD-10 codifications systems can be used for codes\n   */\n  codes?: Array<CodeStub>\n  /**\n   * Soft delete (unix epoch in ms) timestamp of the object.\n   */\n  endOfLife?: number\n  /**\n   * hard delete (unix epoch in ms) timestamp of the object. Filled automatically when deletePatient is called.\n   */\n  deletionDate?: number\n  /**\n   * the firstname (name) of the patient.\n   */\n  firstName?: string\n  /**\n   * the lastname (surname) of the patient. This is the official lastname that should be used for official administrative purposes.\n   */\n  lastName?: string\n  /**\n   * the list of all names of the patient, also containing the official full name information. Ordered by preference of use. First element is therefore the official name used for the patient in the application\n   */\n  names?: Array<PersonName>\n  /**\n   * the name of the company this patient is member of.\n   */\n  companyName?: string\n  /**\n   * the list of languages spoken by the patient ordered by fluency (alpha-2 code http://www.loc.gov/standards/iso639-2/ascii_8bits.html).\n   */\n  languages?: Array<string>\n  /**\n   * the list of addresses (with address type).\n   */\n  addresses?: Array<Address>\n  /**\n   * Mr., Ms., Pr., Dr. ...\n   */\n  civility?: string\n  /**\n   * the gender of the patient: male, female, indeterminate, changed, changedToMale, changedToFemale, unknown\n   */\n  gender?: Patient.GenderEnum\n  /**\n   * the birth sex of the patient: male, female, indeterminate, unknown\n   */\n  birthSex?: Patient.BirthSexEnum\n  /**\n   * The id of the patient this patient has been merged with.\n   */\n  mergeToPatientId?: string\n  /**\n   * The ids of the patients that have been merged inside this patient.\n   */\n  mergedIds?: Array<string>\n  /**\n   * An alias of the person, nickname, ...\n   */\n  alias?: string\n  /**\n   * Is the patient active (boolean).\n   */\n  active?: boolean\n  /**\n   * When not active, the reason for deactivation.\n   */\n  deactivationReason?: Patient.DeactivationReasonEnum\n  /**\n   * Deactivation date of the patient\n   */\n  deactivationDate?: number\n  /**\n   * Social security inscription number.\n   */\n  ssin?: string\n  /**\n   * Lastname at birth (can be different of the current name), depending on the country, must be used to design the patient .\n   */\n  maidenName?: string\n  /**\n   * Lastname of the spouse for a married woman, depending on the country, can be used to design the patient.\n   */\n  spouseName?: string\n  /**\n   * Lastname of the partner, should not be used to design the patient.\n   */\n  partnerName?: string\n  /**\n   * any of `single`, `in_couple`, `married`, `separated`, `divorced`, `divorcing`, `widowed`, `widower`, `complicated`, `unknown`, `contract`, `other`.\n   */\n  personalStatus?: Patient.PersonalStatusEnum\n  /**\n   * The birthdate encoded as a fuzzy date on 8 positions (YYYYMMDD) MM and/or DD can be set to 00 if unknown (19740000 is a valid date).\n   */\n  dateOfBirth?: number\n  /**\n   * The date of death encoded as a fuzzy date on 8 positions (YYYYMMDD) MM and/or DD can be set to 00 if unknown (19740000 is a valid date).\n   */\n  dateOfDeath?: number\n  /**\n   * Timestamp of the latest validation of the eID of the person..\n   */\n  timestampOfLatestEidReading?: number\n  /**\n   * The place of birth.\n   */\n  placeOfBirth?: string\n  /**\n   * The place of death.\n   */\n  placeOfDeath?: string\n  /**\n   * Is the patient deceased.\n   */\n  deceased?: boolean\n  /**\n   * The level of education (college degree, undergraduate, phd).\n   */\n  education?: string\n  /**\n   * The current professional activity.\n   */\n  profession?: string\n  /**\n   * A text note (can be confidential, encrypted by default).\n   * @deprecated use notes instead with proper tags\n   */\n  note?: string\n  /**\n   * An administrative note, not confidential.\n   * @deprecated use notes instead with proper tags\n   */\n  administrativeNote?: string\n  /**\n   * A list of localized notes.\n   */\n  notes?: Annotation[]\n  /**\n   * The nationality of the patient.\n   */\n  nationality?: string\n  /**\n   * The race of the patient.\n   */\n  race?: string\n  /**\n   * The ethnicity of the patient.\n   */\n  ethnicity?: string\n  /**\n   * The id of the user that usually handles this patient.\n   */\n  preferredUserId?: string\n  /**\n   * A picture usually saved in JPEG format.\n   */\n  picture?: ArrayBuffer\n  /**\n   * An external (from another source) id with no guarantee or requirement for unicity .\n   */\n  externalId?: string\n  /**\n   * List of insurance coverages (of class Insurability, see below).\n   */\n  insurabilities?: Array<Insurability>\n  /**\n   * List of partners, or persons of contact (of class Partnership, see below).\n   */\n  partnerships?: Array<Partnership>\n  /**\n   * Links (usually for therapeutic reasons) between this patient and healthcare parties (of class PatientHealthcareParty).\n   */\n  patientHealthCareParties?: Array<PatientHealthCareParty>\n  /**\n   * Financial information (Bank, bank account) used to reimburse the patient.\n   */\n  financialInstitutionInformation?: Array<FinancialInstitutionInformation>\n  /**\n   * Contracts between the patient and the healthcare entity.\n   */\n  medicalHouseContracts?: Array<MedicalHouseContract>\n  /**\n   * Codified list of professions exercised by this patient.\n   */\n  patientProfessions?: Array<CodeStub>\n  /**\n   * Extra parameters\n   */\n  parameters?: { [key: string]: Array<string> }\n  /**\n   * Extra properties\n   */\n  properties?: Array<PropertyStub>\n  /**\n   * For each couple of HcParties (delegator and delegate), this map contains the exchange AES key. The delegator is always this hcp, the key of the map is the id of the delegate.The AES exchange key is encrypted using RSA twice : once using this hcp public key (index 0 in the Array) and once using the other hcp public key (index 1 in the Array). For a pair of HcParties. Each HcParty always has one AES exchange key for himself.\n   */\n  hcPartyKeys?: { [key: string]: Array<string> }\n  /**\n   * Extra AES exchange keys, usually the ones we lost access to at some point. The structure is { publicKey: { delegateId: { myPubKey1: aesExKey_for_this, delegatePubKey1: aesExKey_for_delegate } } }\n   */\n  aesExchangeKeys?: { [key: string]: { [key: string]: { [key: string]: string } } }\n  /**\n   * Our private keys encrypted with our public keys. The structure is { publicKey1: { publicKey2: privateKey2_encrypted_with_publicKey1, publicKey3: privateKey3_encrypted_with_publicKey1 } }\n   */\n  transferKeys?: { [key: string]: { [key: string]: string } }\n  /**\n   * The privateKeyShamirPartitions are used to share this hcp's private RSA key with a series of other hcParties using Shamir's algorithm. The key of the map is the hcp Id with whom this partition has been shared. The value is \\\"threshold⎮partition in hex\\\" encrypted using the the partition's holder's public RSA key\n   */\n  privateKeyShamirPartitions?: { [key: string]: string }\n  /**\n   * The public key of this hcp\n   */\n  publicKey?: string\n  /**\n   * The public keys of this actor that are generates using the OAEP Sha-256 standard\n   */\n  publicKeysForOaepWithSha256?: Array<string>\n  /**\n   * The secretForeignKeys are filled at the to many end of a one to many relationship (for example inside Contact for the Patient -> Contacts relationship). Used when we want to find all contacts for a specific patient. These keys are in clear. You can have several to partition the medical document space.\n   */\n  secretForeignKeys?: Array<string>\n  /**\n   * The secretForeignKeys are filled at the to many end of a one to many relationship (for example inside Contact for the Patient -> Contacts relationship). Used when we want to find the patient for a specific contact. These keys are the encrypted id (using the hcParty key for the delegate) that can be found in clear inside the patient. ids encrypted using the hcParty keys.\n   */\n  cryptedForeignKeys?: { [key: string]: Array<Delegation> }\n  /**\n   * When a document is created, the responsible generates a cryptographically random master key (never to be used for something else than referencing from other entities). He/she encrypts it using his own AES exchange key and stores it as a delegation. The responsible is thus always in the delegations as well\n   */\n  delegations?: { [key: string]: Array<Delegation> }\n  /**\n   * When a document needs to be encrypted, the responsible generates a cryptographically random master key (different from the delegation key, never to appear in clear anywhere in the db. He/she encrypts it using his own AES exchange key and stores it as a delegation\n   */\n  encryptionKeys?: { [key: string]: Array<Delegation> }\n  /**\n   * The base64 encoded data of this object, formatted as JSON and encrypted in AES using the random master key from encryptionKeys.\n   */\n  encryptedSelf?: string\n  /**\n   * The id of the medical location where this entity was created.\n   */\n  medicalLocationId?: string\n  nonDuplicateIds?: Array<string>\n  encryptedAdministrativesDocuments?: Array<string>\n  comment?: string\n  warning?: string\n  fatherBirthCountry?: CodeStub\n  birthCountry?: CodeStub\n  nativeCountry?: CodeStub\n  socialStatus?: CodeStub\n  mainSourceOfIncome?: CodeStub\n  schoolingInfos?: Array<SchoolingInfo>\n  employementInfos?: Array<EmploymentInfo>\n  securityMetadata?: SecurityMetadata\n  \n}\nexport namespace Patient {\n  export type GenderEnum = 'male' | 'female' | 'indeterminate' | 'changed' | 'changedToMale' | 'changedToFemale' | 'unknown'\n  export const GenderEnum = {\n    Male: 'male' as GenderEnum,\n    Female: 'female' as GenderEnum,\n    Indeterminate: 'indeterminate' as GenderEnum,\n    Changed: 'changed' as GenderEnum,\n    ChangedToMale: 'changedToMale' as GenderEnum,\n    ChangedToFemale: 'changedToFemale' as GenderEnum,\n    Unknown: 'unknown' as GenderEnum,\n  }\n  export type BirthSexEnum = 'male' | 'female' | 'indeterminate' | 'changed' | 'changedToMale' | 'changedToFemale' | 'unknown'\n  export const BirthSexEnum = {\n    Male: 'male' as BirthSexEnum,\n    Female: 'female' as BirthSexEnum,\n    Indeterminate: 'indeterminate' as BirthSexEnum,\n    Changed: 'changed' as BirthSexEnum,\n    ChangedToMale: 'changedToMale' as BirthSexEnum,\n    ChangedToFemale: 'changedToFemale' as BirthSexEnum,\n    Unknown: 'unknown' as BirthSexEnum,\n  }\n  export type DeactivationReasonEnum = 'deceased' | 'moved' | 'other_doctor' | 'retired' | 'no_contact' | 'unknown' | 'none'\n  export const DeactivationReasonEnum = {\n    Deceased: 'deceased' as DeactivationReasonEnum,\n    Moved: 'moved' as DeactivationReasonEnum,\n    OtherDoctor: 'other_doctor' as DeactivationReasonEnum,\n    Retired: 'retired' as DeactivationReasonEnum,\n    NoContact: 'no_contact' as DeactivationReasonEnum,\n    Unknown: 'unknown' as DeactivationReasonEnum,\n    None: 'none' as DeactivationReasonEnum,\n  }\n  export type PersonalStatusEnum =\n    | 'single'\n    | 'in_couple'\n    | 'married'\n    | 'separated'\n    | 'divorced'\n    | 'divorcing'\n    | 'widowed'\n    | 'widower'\n    | 'complicated'\n    | 'unknown'\n    | 'contract'\n    | 'other'\n    | 'annulled'\n    | 'polygamous'\n  export const PersonalStatusEnum = {\n    Single: 'single' as PersonalStatusEnum,\n    InCouple: 'in_couple' as PersonalStatusEnum,\n    Married: 'married' as PersonalStatusEnum,\n    Separated: 'separated' as PersonalStatusEnum,\n    Divorced: 'divorced' as PersonalStatusEnum,\n    Divorcing: 'divorcing' as PersonalStatusEnum,\n    Widowed: 'widowed' as PersonalStatusEnum,\n    Widower: 'widower' as PersonalStatusEnum,\n    Complicated: 'complicated' as PersonalStatusEnum,\n    Unknown: 'unknown' as PersonalStatusEnum,\n    Contract: 'contract' as PersonalStatusEnum,\n    Other: 'other' as PersonalStatusEnum,\n    Annulled: 'annulled' as PersonalStatusEnum,\n    Polygamous: 'polygamous' as PersonalStatusEnum,\n  }\n}\n"]}

package/icc-api/model/PatientByHcPartyGenderEducationProfession.d.ts

@@ -0,0 +1,31 @@
+/**
+ * iCure Data Stack API Documentation
+ * The iCure Data Stack Application API is the native interface to iCure. This version is obsolete, please use v2.
+ *
+ * OpenAPI spec version: v1
+ *
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ */
+export declare class PatientByHcPartyGenderEducationProfession {
+    constructor(json: JSON | any);
+    desc?: string;
+    healthcarePartyId?: string;
+    gender?: PatientByHcPartyGenderEducationProfession.GenderEnum;
+    education?: string;
+    profession?: string;
+}
+export declare namespace PatientByHcPartyGenderEducationProfession {
+    type GenderEnum = 'M' | 'F' | 'I' | 'C' | 'Y' | 'X' | 'U';
+    const GenderEnum: {
+        M: GenderEnum;
+        F: GenderEnum;
+        I: GenderEnum;
+        C: GenderEnum;
+        Y: GenderEnum;
+        X: GenderEnum;
+        U: GenderEnum;
+    };
+}

package/icc-api/model/PatientByHcPartyGenderEducationProfession.js

@@ -0,0 +1,32 @@
+"use strict";
+/**
+ * iCure Data Stack API Documentation
+ * The iCure Data Stack Application API is the native interface to iCure. This version is obsolete, please use v2.
+ *
+ * OpenAPI spec version: v1
+ *
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PatientByHcPartyGenderEducationProfession = void 0;
+class PatientByHcPartyGenderEducationProfession {
+    constructor(json) {
+        Object.assign(this, json);
+    }
+}
+exports.PatientByHcPartyGenderEducationProfession = PatientByHcPartyGenderEducationProfession;
+(function (PatientByHcPartyGenderEducationProfession) {
+    PatientByHcPartyGenderEducationProfession.GenderEnum = {
+        M: 'M',
+        F: 'F',
+        I: 'I',
+        C: 'C',
+        Y: 'Y',
+        X: 'X',
+        U: 'U',
+    };
+})(PatientByHcPartyGenderEducationProfession = exports.PatientByHcPartyGenderEducationProfession || (exports.PatientByHcPartyGenderEducationProfession = {}));
+//# sourceMappingURL=PatientByHcPartyGenderEducationProfession.js.map

package/icc-api/model/PatientByHcPartyGenderEducationProfession.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PatientByHcPartyGenderEducationProfession.js","sourceRoot":"","sources":["../../../icc-api/model/PatientByHcPartyGenderEducationProfession.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;GAUG;;;AAEH,MAAa,yCAAyC;IACpD,YAAY,IAAgB;QAC1B,MAAM,CAAC,MAAM,CAAC,IAAiD,EAAE,IAAI,CAAC,CAAA;IACxE,CAAC;CAOF;AAVD,8FAUC;AACD,WAAiB,yCAAyC;IAE3C,oDAAU,GAAG;QACxB,CAAC,EAAE,GAAiB;QACpB,CAAC,EAAE,GAAiB;QACpB,CAAC,EAAE,GAAiB;QACpB,CAAC,EAAE,GAAiB;QACpB,CAAC,EAAE,GAAiB;QACpB,CAAC,EAAE,GAAiB;QACpB,CAAC,EAAE,GAAiB;KACrB,CAAA;AACH,CAAC,EAXgB,yCAAyC,GAAzC,iDAAyC,KAAzC,iDAAyC,QAWzD","sourcesContent":["/**\n * iCure Data Stack API Documentation\n * The iCure Data Stack Application API is the native interface to iCure. This version is obsolete, please use v2.\n *\n * OpenAPI spec version: v1\n *\n *\n * NOTE: This class is auto generated by the swagger code generator program.\n * https://github.com/swagger-api/swagger-codegen.git\n * Do not edit the class manually.\n */\n\nexport class PatientByHcPartyGenderEducationProfession {\n  constructor(json: JSON | any) {\n    Object.assign(this as PatientByHcPartyGenderEducationProfession, json)\n  }\n\n  desc?: string\n  healthcarePartyId?: string\n  gender?: PatientByHcPartyGenderEducationProfession.GenderEnum\n  education?: string\n  profession?: string\n}\nexport namespace PatientByHcPartyGenderEducationProfession {\n  export type GenderEnum = 'M' | 'F' | 'I' | 'C' | 'Y' | 'X' | 'U'\n  export const GenderEnum = {\n    M: 'M' as GenderEnum,\n    F: 'F' as GenderEnum,\n    I: 'I' as GenderEnum,\n    C: 'C' as GenderEnum,\n    Y: 'Y' as GenderEnum,\n    X: 'X' as GenderEnum,\n    U: 'U' as GenderEnum,\n  }\n}\n"]}

package/icc-api/model/Receipt.d.ts

@@ -11,6 +11,7 @@
  */
 import { CodeStub } from './CodeStub';
 import { Delegation } from './Delegation';
+import { SecurityMetadata } from './SecurityMetadata';
 export declare class Receipt {
     constructor(json: JSON | any);
     id?: string;
@@ -84,4 +85,5 @@ export declare class Receipt {
      * The base64 encoded data of this object, formatted as JSON and encrypted in AES using the random master key from encryptionKeys.
      */
     encryptedSelf?: string;
+    securityMetadata?: SecurityMetadata;
 }

package/icc-api/model/Receipt.js.map

@@ -1 +1 @@
-{"version":3,"file":"Receipt.js","sourceRoot":"","sources":["../../../icc-api/model/Receipt.ts"],"names":[],"mappings":";;;AAcA,MAAa,OAAO;IAClB,YAAY,IAAgB;QAC1B,MAAM,CAAC,MAAM,CAAC,IAAe,EAAE,IAAI,CAAC,CAAA;IACtC,CAAC;CAiEF;AApED,0BAoEC","sourcesContent":["/**\n * iCure Data Stack API Documentation\n * The iCure Data Stack Application API is the native interface to iCure. This version is obsolete, please use v2.\n *\n * OpenAPI spec version: v1\n *\n *\n * NOTE: This class is auto generated by the swagger code generator program.\n * https://github.com/swagger-api/swagger-codegen.git\n * Do not edit the class manually.\n */\nimport { CodeStub } from './CodeStub'\nimport { Delegation } from './Delegation'\n\nexport class Receipt {\n  constructor(json: JSON | any) {\n    Object.assign(this as Receipt, json)\n  }\n\n  id?: string\n  rev?: string\n  /**\n   * The timestamp (unix epoch in ms) of creation of this entity, will be filled automatically if missing. Not enforced by the application server.\n   */\n  created?: number\n  /**\n   * The date (unix epoch in ms) of the latest modification of this entity, will be filled automatically if missing. Not enforced by the application server.\n   */\n  modified?: number\n  /**\n   * The id of the User that has created this entity, will be filled automatically if missing. Not enforced by the application server.\n   */\n  author?: string\n  /**\n   * The id of the HealthcareParty that is responsible for this entity, will be filled automatically if missing. Not enforced by the application server.\n   */\n  responsible?: string\n  /**\n   * The id of the medical location where this entity was created.\n   */\n  medicalLocationId?: string\n  /**\n   * A tag is an item from a codification system that qualifies an entity as being member of a certain class, whatever the value it might have taken. If the tag qualifies the content of a field, it means that whatever the content of the field, the tag will always apply. For example, the label of a field is qualified using a tag. LOINC is a codification system typically used for tags.\n   */\n  tags?: Array<CodeStub>\n  /**\n   * A code is an item from a codification system that qualifies the content of this entity. SNOMED-CT, ICPC-2 or ICD-10 codifications systems can be used for codes\n   */\n  codes?: Array<CodeStub>\n  /**\n   * Soft delete (unix epoch in ms) timestamp of the object.\n   */\n  endOfLife?: number\n  /**\n   * hard delete (unix epoch in ms) timestamp of the object. Filled automatically when deletePatient is called.\n   */\n  deletionDate?: number\n  attachmentIds?: { [key: string]: string }\n  references?: Array<string>\n  documentId?: string\n  category?: string\n  subCategory?: string\n  /**\n   * The secretForeignKeys are filled at the to many end of a one to many relationship (for example inside Contact for the Patient -> Contacts relationship). Used when we want to find all contacts for a specific patient. These keys are in clear. You can have several to partition the medical document space.\n   */\n  secretForeignKeys?: Array<string>\n  /**\n   * The secretForeignKeys are filled at the to many end of a one to many relationship (for example inside Contact for the Patient -> Contacts relationship). Used when we want to find the patient for a specific contact. These keys are the encrypted id (using the hcParty key for the delegate) that can be found in clear inside the patient. ids encrypted using the hcParty keys.\n   */\n  cryptedForeignKeys?: { [key: string]: Array<Delegation> }\n  /**\n   * When a document is created, the responsible generates a cryptographically random master key (never to be used for something else than referencing from other entities). He/she encrypts it using his own AES exchange key and stores it as a delegation. The responsible is thus always in the delegations as well\n   */\n  delegations?: { [key: string]: Array<Delegation> }\n  /**\n   * When a document needs to be encrypted, the responsible generates a cryptographically random master key (different from the delegation key, never to appear in clear anywhere in the db. He/she encrypts it using his own AES exchange key and stores it as a delegation\n   */\n  encryptionKeys?: { [key: string]: Array<Delegation> }\n  /**\n   * The base64 encoded data of this object, formatted as JSON and encrypted in AES using the random master key from encryptionKeys.\n   */\n  encryptedSelf?: string\n}\n"]}
+{"version":3,"file":"Receipt.js","sourceRoot":"","sources":["../../../icc-api/model/Receipt.ts"],"names":[],"mappings":";;;AAgBA,MAAa,OAAO;IAClB,YAAY,IAAgB;QAC1B,MAAM,CAAC,MAAM,CAAC,IAAe,EAAE,IAAI,CAAC,CAAA;IACtC,CAAC;CAmEF;AAtED,0BAsEC","sourcesContent":["/**\n * iCure Data Stack API Documentation\n * The iCure Data Stack Application API is the native interface to iCure. This version is obsolete, please use v2.\n *\n * OpenAPI spec version: v1\n *\n *\n * NOTE: This class is auto generated by the swagger code generator program.\n * https://github.com/swagger-api/swagger-codegen.git\n * Do not edit the class manually.\n */\nimport { CodeStub } from './CodeStub'\nimport { Delegation } from './Delegation'\nimport { SecurityMetadata } from './SecurityMetadata'\nimport { EntityWithDelegationTypeName } from '../../icc-x-api/utils/EntityWithDelegationTypeName'\n\nexport class Receipt {\n  constructor(json: JSON | any) {\n    Object.assign(this as Receipt, json)\n  }\n\n  id?: string\n  rev?: string\n  /**\n   * The timestamp (unix epoch in ms) of creation of this entity, will be filled automatically if missing. Not enforced by the application server.\n   */\n  created?: number\n  /**\n   * The date (unix epoch in ms) of the latest modification of this entity, will be filled automatically if missing. Not enforced by the application server.\n   */\n  modified?: number\n  /**\n   * The id of the User that has created this entity, will be filled automatically if missing. Not enforced by the application server.\n   */\n  author?: string\n  /**\n   * The id of the HealthcareParty that is responsible for this entity, will be filled automatically if missing. Not enforced by the application server.\n   */\n  responsible?: string\n  /**\n   * The id of the medical location where this entity was created.\n   */\n  medicalLocationId?: string\n  /**\n   * A tag is an item from a codification system that qualifies an entity as being member of a certain class, whatever the value it might have taken. If the tag qualifies the content of a field, it means that whatever the content of the field, the tag will always apply. For example, the label of a field is qualified using a tag. LOINC is a codification system typically used for tags.\n   */\n  tags?: Array<CodeStub>\n  /**\n   * A code is an item from a codification system that qualifies the content of this entity. SNOMED-CT, ICPC-2 or ICD-10 codifications systems can be used for codes\n   */\n  codes?: Array<CodeStub>\n  /**\n   * Soft delete (unix epoch in ms) timestamp of the object.\n   */\n  endOfLife?: number\n  /**\n   * hard delete (unix epoch in ms) timestamp of the object. Filled automatically when deletePatient is called.\n   */\n  deletionDate?: number\n  attachmentIds?: { [key: string]: string }\n  references?: Array<string>\n  documentId?: string\n  category?: string\n  subCategory?: string\n  /**\n   * The secretForeignKeys are filled at the to many end of a one to many relationship (for example inside Contact for the Patient -> Contacts relationship). Used when we want to find all contacts for a specific patient. These keys are in clear. You can have several to partition the medical document space.\n   */\n  secretForeignKeys?: Array<string>\n  /**\n   * The secretForeignKeys are filled at the to many end of a one to many relationship (for example inside Contact for the Patient -> Contacts relationship). Used when we want to find the patient for a specific contact. These keys are the encrypted id (using the hcParty key for the delegate) that can be found in clear inside the patient. ids encrypted using the hcParty keys.\n   */\n  cryptedForeignKeys?: { [key: string]: Array<Delegation> }\n  /**\n   * When a document is created, the responsible generates a cryptographically random master key (never to be used for something else than referencing from other entities). He/she encrypts it using his own AES exchange key and stores it as a delegation. The responsible is thus always in the delegations as well\n   */\n  delegations?: { [key: string]: Array<Delegation> }\n  /**\n   * When a document needs to be encrypted, the responsible generates a cryptographically random master key (different from the delegation key, never to appear in clear anywhere in the db. He/she encrypts it using his own AES exchange key and stores it as a delegation\n   */\n  encryptionKeys?: { [key: string]: Array<Delegation> }\n  /**\n   * The base64 encoded data of this object, formatted as JSON and encrypted in AES using the random master key from encryptionKeys.\n   */\n  encryptedSelf?: string\n  securityMetadata?: SecurityMetadata\n  \n}\n"]}

package/icc-api/model/SecureDelegation.d.ts

@@ -0,0 +1,52 @@
+export declare class SecureDelegation {
+    constructor(json: JSON | any);
+    /**
+     * Optionally the id of the delegator data owner for this [SecureDelegation]. May be null if this information must
+     * be hidden to prevent data leakages (see class documentation for more details).
+     */
+    delegator?: string;
+    /**
+     * Optionally the id of the delegate data owner for this [SecureDelegation]. May be null if this information must
+     * be hidden to prevent data leakages (see class documentation for more details).
+     */
+    delegate?: string;
+    /**
+     * Secret id of the entity holding this [SecureDelegation] (formerly `delegation`). The id will appear in plaintext in the
+     * `secretForeignKeys` field of children entities.
+     */
+    secretIds?: string[];
+    /**
+     * Encrypted aes key used for the encryption of the entity's data (data stored in `encryptedSelf`).
+     */
+    encryptionKeys?: string[];
+    /**
+     * Encrypted id of the entity which owns the entity holding this [SecureDelegation] (formerly `cryptedForeignKey`),
+     * such as the id of the patient for a contact or healthcare element.
+     */
+    owningEntityIds?: string[];
+    /**
+     * Key of the parent delegations in the [SecurityMetadata.secureDelegations]. Users are allowed to modify/delete
+     * only [SecureDelegation] that they can directly access or any children delegations.
+     */
+    parentDelegations?: string[];
+    /**
+     * If both the [delegator] and [delegate] are explicit in this secure delegation this field will hold the id of the exchange
+     * data used for the encryption of this delegation. Otherwise, this will be null.
+     */
+    exchangeDataId?: string;
+    /**
+     * Permissions of users with access to this [SecureDelegation] on the corresponding entity.
+     * The permissions only refer to the actual content of the entity and not to any metadata (excluding the `encryptedSelf`):
+     * any data owner will always be allowed to use the methods to share the with other data owners, even if these method
+     * require to modify the entity and the data owner has read-only permissions.
+     * Delegations without any parents will always have full read-write permissions.
+     */
+    permissions: SecureDelegation.AccessLevelEnum;
+}
+export declare namespace SecureDelegation {
+    type AccessLevelEnum = 'READ' | 'WRITE';
+    const AccessLevelEnum: {
+        READ: AccessLevelEnum;
+        WRITE: AccessLevelEnum;
+    };
+}

package/icc-api/model/SecureDelegation.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SecureDelegation = void 0;
+class SecureDelegation {
+    constructor(json) {
+        Object.assign(this, json);
+    }
+}
+exports.SecureDelegation = SecureDelegation;
+(function (SecureDelegation) {
+    SecureDelegation.AccessLevelEnum = {
+        READ: 'READ',
+        WRITE: 'WRITE',
+    };
+})(SecureDelegation = exports.SecureDelegation || (exports.SecureDelegation = {}));
+//# sourceMappingURL=SecureDelegation.js.map

package/icc-api/model/SecureDelegation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SecureDelegation.js","sourceRoot":"","sources":["../../../icc-api/model/SecureDelegation.ts"],"names":[],"mappings":";;;AAAA,MAAa,gBAAgB;IAC3B,YAAY,IAAgB;QAC1B,MAAM,CAAC,MAAM,CAAC,IAAwB,EAAE,IAAI,CAAC,CAAA;IAC/C,CAAC;CA4CF;AA/CD,4CA+CC;AACD,WAAiB,gBAAgB;IAElB,gCAAe,GAAG;QAC7B,IAAI,EAAE,MAAyB;QAC/B,KAAK,EAAE,OAA0B;KAClC,CAAA;AACH,CAAC,EANgB,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAMhC","sourcesContent":["export class SecureDelegation {\n  constructor(json: JSON | any) {\n    Object.assign(this as SecureDelegation, json)\n  }\n\n  /**\n   * Optionally the id of the delegator data owner for this [SecureDelegation]. May be null if this information must\n   * be hidden to prevent data leakages (see class documentation for more details).\n   */\n  delegator?: string\n  /**\n   * Optionally the id of the delegate data owner for this [SecureDelegation]. May be null if this information must\n   * be hidden to prevent data leakages (see class documentation for more details).\n   */\n  delegate?: string\n  /**\n   * Secret id of the entity holding this [SecureDelegation] (formerly `delegation`). The id will appear in plaintext in the\n   * `secretForeignKeys` field of children entities.\n   */\n  secretIds?: string[]\n  /**\n   * Encrypted aes key used for the encryption of the entity's data (data stored in `encryptedSelf`).\n   */\n  encryptionKeys?: string[]\n  /**\n   * Encrypted id of the entity which owns the entity holding this [SecureDelegation] (formerly `cryptedForeignKey`),\n   * such as the id of the patient for a contact or healthcare element.\n   */\n  owningEntityIds?: string[]\n  /**\n   * Key of the parent delegations in the [SecurityMetadata.secureDelegations]. Users are allowed to modify/delete\n   * only [SecureDelegation] that they can directly access or any children delegations.\n   */\n  parentDelegations?: string[]\n  /**\n   * If both the [delegator] and [delegate] are explicit in this secure delegation this field will hold the id of the exchange\n   * data used for the encryption of this delegation. Otherwise, this will be null.\n   */\n  exchangeDataId?: string\n  /**\n   * Permissions of users with access to this [SecureDelegation] on the corresponding entity.\n   * The permissions only refer to the actual content of the entity and not to any metadata (excluding the `encryptedSelf`):\n   * any data owner will always be allowed to use the methods to share the with other data owners, even if these method\n   * require to modify the entity and the data owner has read-only permissions.\n   * Delegations without any parents will always have full read-write permissions.\n   */\n  permissions!: SecureDelegation.AccessLevelEnum\n}\nexport namespace SecureDelegation {\n  export type AccessLevelEnum = 'READ' | 'WRITE'\n  export const AccessLevelEnum = {\n    READ: 'READ' as AccessLevelEnum,\n    WRITE: 'WRITE' as AccessLevelEnum,\n  }\n}\n"]}

package/icc-api/model/SecurityMetadata.d.ts

@@ -0,0 +1,33 @@
+import { SecureDelegation } from './SecureDelegation';
+/**
+ * Holds information for user-based access control and encryption of entities.
+ */
+export declare class SecurityMetadata {
+    constructor(json: JSON | any);
+    /**
+     * This maps the hex-encoded sha256 hash of a key created by the client using a certain [ExchangeData.accessControlSecret] to the
+     * [SecureDelegation] for the corresponding delegate-delegator pair. This hash is used by the server to perform access control for
+     * anonymous data owners (see [DataOwnerAuthenticationDetails]) and in some cases also by the sdks to quickly find the appropriate
+     * exchange key needed for the decryption of the content of the corresponding [SecureDelegation].
+     *
+     * Note that it is also possible for a secure delegation in this map to have no entry for secretId, encryptionKey or owningEntityId.
+     * This could happen in situations where a user should have access only to the unencrypted content of an entity.
+     */
+    secureDelegations?: {
+        [hash: string]: SecureDelegation;
+    };
+    /**
+     * Holds aliases for secure delegation keys that apply to this entity: `a -> b` means that anyone with key `a` has access to the
+     * secure delegation in `secureDelegations['b']`.
+     *
+     * This map is useful in cases when it is not possible to know for certain if the delegate of a new secure delegation will be able
+     * to produce the access control key we are planning to use. For example the access control key may be produced by a combination of
+     * access control secret and secret foreign key of the entity: what happens if the entity has multiple secret foreign keys? The
+     * delegate may have access to only one of them but not all, so if we chose an unlucky secret foreign key in the creation of the
+     * access control key the delegate will never be able to access the entity. This field allows to essentially create an access control
+     * key and corresponding secure delegation key for each secret foreign key without having to replicate the actual secure delegation.
+     */
+    keysEquivalences?: {
+        [hash: string]: string;
+    };
+}

package/icc-api/model/SecurityMetadata.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SecurityMetadata = void 0;
+/**
+ * Holds information for user-based access control and encryption of entities.
+ */
+class SecurityMetadata {
+    constructor(json) {
+        Object.assign(this, json);
+    }
+}
+exports.SecurityMetadata = SecurityMetadata;
+//# sourceMappingURL=SecurityMetadata.js.map

package/icc-api/model/SecurityMetadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SecurityMetadata.js","sourceRoot":"","sources":["../../../icc-api/model/SecurityMetadata.ts"],"names":[],"mappings":";;;AAEA;;GAEG;AACH,MAAa,gBAAgB;IAC3B,YAAY,IAAgB;QAC1B,MAAM,CAAC,MAAM,CAAC,IAAwB,EAAE,IAAI,CAAC,CAAA;IAC/C,CAAC;CAyBF;AA5BD,4CA4BC","sourcesContent":["import { SecureDelegation } from './SecureDelegation'\n\n/**\n * Holds information for user-based access control and encryption of entities.\n */\nexport class SecurityMetadata {\n  constructor(json: JSON | any) {\n    Object.assign(this as SecurityMetadata, json)\n  }\n\n  /**\n   * This maps the hex-encoded sha256 hash of a key created by the client using a certain [ExchangeData.accessControlSecret] to the\n   * [SecureDelegation] for the corresponding delegate-delegator pair. This hash is used by the server to perform access control for\n   * anonymous data owners (see [DataOwnerAuthenticationDetails]) and in some cases also by the sdks to quickly find the appropriate\n   * exchange key needed for the decryption of the content of the corresponding [SecureDelegation].\n   *\n   * Note that it is also possible for a secure delegation in this map to have no entry for secretId, encryptionKey or owningEntityId.\n   * This could happen in situations where a user should have access only to the unencrypted content of an entity.\n   */\n  secureDelegations?: { [hash: string]: SecureDelegation }\n\n  /**\n   * Holds aliases for secure delegation keys that apply to this entity: `a -> b` means that anyone with key `a` has access to the\n   * secure delegation in `secureDelegations['b']`.\n   *\n   * This map is useful in cases when it is not possible to know for certain if the delegate of a new secure delegation will be able\n   * to produce the access control key we are planning to use. For example the access control key may be produced by a combination of\n   * access control secret and secret foreign key of the entity: what happens if the entity has multiple secret foreign keys? The\n   * delegate may have access to only one of them but not all, so if we chose an unlucky secret foreign key in the creation of the\n   * access control key the delegate will never be able to access the entity. This field allows to essentially create an access control\n   * key and corresponding secure delegation key for each secret foreign key without having to replicate the actual secure delegation.\n   */\n  keysEquivalences?: { [hash: string]: string }\n}\n"]}

package/icc-api/model/Service.d.ts

@@ -14,6 +14,7 @@ import { CodeStub } from './CodeStub';
 import { Content } from './Content';
 import { Delegation } from './Delegation';
 import { Identifier } from './Identifier';
+import { SecurityMetadata } from './SecurityMetadata';
 /**
  * This entity represents a Service. A Service is created in the course a contact. Services include subjective information provided by the patient, such as complaints, reason for visit, feelings, etc. or objective information like bio-metric measures (blood pressure, temperature, heart beat, etc.), or physical exam description, diagnosis, prescription, integration of lab reports from another healthcare party, action plan, etc. Any action performed by the healthcare party which is relevant for the healthcare element of a patient is considered a service. The services can be linked to healthcare elements or other structuring elements of the medical record
  */
@@ -162,4 +163,5 @@ export declare class Service {
      * The base64 encoded data of this object, formatted as JSON and encrypted in AES using the random master key from encryptionKeys.
      */
     encryptedSelf?: string;
+    securityMetadata?: SecurityMetadata;
 }

package/icc-api/model/Service.js.map

@@ -1 +1 @@
-{"version":3,"file":"Service.js","sourceRoot":"","sources":["../../../icc-api/model/Service.ts"],"names":[],"mappings":";;;AAiBA;;GAEG;AACH,MAAa,OAAO;IAClB,YAAY,IAAgB;QAC1B,MAAM,CAAC,MAAM,CAAC,IAAe,EAAE,IAAI,CAAC,CAAA;IACtC,CAAC;CAmIF;AAtID,0BAsIC","sourcesContent":["/**\n * iCure Data Stack API Documentation\n * The iCure Data Stack Application API is the native interface to iCure. This version is obsolete, please use v2.\n *\n * OpenAPI spec version: v1\n *\n *\n * NOTE: This class is auto generated by the swagger code generator program.\n * https://github.com/swagger-api/swagger-codegen.git\n * Do not edit the class manually.\n */\nimport { Annotation } from './Annotation'\nimport { CodeStub } from './CodeStub'\nimport { Content } from './Content'\nimport { Delegation } from './Delegation'\nimport { Identifier } from './Identifier'\n\n/**\n * This entity represents a Service. A Service is created in the course a contact. Services include subjective information provided by the patient, such as complaints, reason for visit, feelings, etc. or objective information like bio-metric measures (blood pressure, temperature, heart beat, etc.), or physical exam description, diagnosis, prescription, integration of lab reports from another healthcare party, action plan, etc. Any action performed by the healthcare party which is relevant for the healthcare element of a patient is considered a service. The services can be linked to healthcare elements or other structuring elements of the medical record\n */\nexport class Service {\n  constructor(json: JSON | any) {\n    Object.assign(this as Service, json)\n  }\n\n  /**\n   * The Id of the Service. We encourage using either a v4 UUID or a HL7 Id.\n   */\n  id?: string\n  /**\n   * The transactionId is used when a single service had to be split into parts for technical reasons. Several services with the same non null transaction id form one single service\n   */\n  transactionId?: string\n  identifier?: Array<Identifier>\n  /**\n   * Id of the contact during which the service is provided\n   */\n  contactId?: string\n  /**\n   * List of IDs of all sub-contacts that link the service to structural elements. Only used when the Service is emitted outside of its contact\n   */\n  subContactIds?: Array<string>\n  /**\n   * List of IDs of all plans of actions (healthcare approaches) as a part of which the Service is provided. Only used when the Service is emitted outside of its contact\n   */\n  plansOfActionIds?: Array<string>\n  /**\n   * List of IDs of all healthcare elements for which the service is provided. Only used when the Service is emitted outside of its contact\n   */\n  healthElementsIds?: Array<string>\n  /**\n   * List of Ids of all forms linked to the Service. Only used when the Service is emitted outside of its contact.\n   */\n  formIds?: Array<string>\n  /**\n   * The secret patient key, encrypted in the patient document, in clear here.\n   */\n  secretForeignKeys?: Array<string>\n  /**\n   * The public patient key, encrypted here for separate Crypto Actors.\n   */\n  cryptedForeignKeys?: { [key: string]: Array<Delegation> }\n  /**\n   * The delegations giving access to connected healthcare information.\n   */\n  delegations?: { [key: string]: Array<Delegation> }\n  /**\n   * The contact secret encryption key used to encrypt the secured properties (like services for example), encrypted for separate Crypto Actors.\n   */\n  encryptionKeys?: { [key: string]: Array<Delegation> }\n  /**\n   * Description / Unambiguous qualification (LOINC code) of the type of information contained in the service. Could be a code to qualify temperature, complaint, diagnostic, ...\n   */\n  label?: string\n  dataClassName?: string\n  /**\n   * Used for sorting services inside an upper object (A contact, a transaction, a FHIR bundle, ...)\n   */\n  index?: number\n  /**\n   * Information contained in the service. Content is localized, using ISO language code as key\n   */\n  content?: { [key: string]: Content }\n  encryptedContent?: string\n  textIndexes?: { [key: string]: string }\n  /**\n   * The date (YYYYMMDDhhmmss) when the Service is noted to have started and also closes on the same date\n   */\n  valueDate?: number\n  /**\n   * The date (YYYYMMDDhhmmss) of the start of the Service\n   */\n  openingDate?: number\n  /**\n   * The date (YYYYMMDDhhmmss) marking the end of the Service\n   */\n  closingDate?: number\n  /**\n   * Id of the form used during the Service\n   */\n  formId?: string\n  /**\n   * The timestamp (unix epoch in ms) of creation of this entity, will be filled automatically if missing. Not enforced by the application server.\n   */\n  created?: number\n  /**\n   * The date (unix epoch in ms) of the latest modification of this entity, will be filled automatically if missing. Not enforced by the application server.\n   */\n  modified?: number\n  /**\n   * Soft delete (unix epoch in ms) timestamp of the object.\n   */\n  endOfLife?: number\n  /**\n   * The id of the User that has created this entity, will be filled automatically if missing. Not enforced by the application server.\n   */\n  author?: string\n  /**\n   * The id of the HealthcareParty that is responsible for this entity, will be filled automatically if missing. Not enforced by the application server.\n   */\n  responsible?: string\n  /**\n   * The id of the medical location where this entity was created.\n   */\n  medicalLocationId?: string\n  /**\n   * Text, comments on the Service provided\n   */\n  comment?: string\n  status?: number\n  /**\n   * List of invoicing codes\n   */\n  invoicingCodes?: Array<string>\n  /**\n   * Comments - Notes recorded by a HCP about this service\n   */\n  notes?: Array<Annotation>\n  /**\n   * Links towards related services (possibly in other contacts)\n   */\n  qualifiedLinks?: { [key: string]: { [key: string]: string } }\n  /**\n   * A code is an item from a codification system that qualifies the content of this entity. SNOMED-CT, ICPC-2 or ICD-10 codifications systems can be used for codes\n   */\n  codes?: Array<CodeStub>\n  /**\n   * A tag is an item from a codification system that qualifies an entity as being member of a certain class, whatever the value it might have taken. If the tag qualifies the content of a field, it means that whatever the content of the field, the tag will always apply. For example, the label of a field is qualified using a tag. LOINC is a codification system typically used for tags.\n   */\n  tags?: Array<CodeStub>\n  /**\n   * The base64 encoded data of this object, formatted as JSON and encrypted in AES using the random master key from encryptionKeys.\n   */\n  encryptedSelf?: string\n}\n"]}
+{"version":3,"file":"Service.js","sourceRoot":"","sources":["../../../icc-api/model/Service.ts"],"names":[],"mappings":";;;AAmBA;;GAEG;AACH,MAAa,OAAO;IAClB,YAAY,IAAgB;QAC1B,MAAM,CAAC,MAAM,CAAC,IAAe,EAAE,IAAI,CAAC,CAAA;IACtC,CAAC;CAoIF;AAvID,0BAuIC","sourcesContent":["/**\n * iCure Data Stack API Documentation\n * The iCure Data Stack Application API is the native interface to iCure. This version is obsolete, please use v2.\n *\n * OpenAPI spec version: v1\n *\n *\n * NOTE: This class is auto generated by the swagger code generator program.\n * https://github.com/swagger-api/swagger-codegen.git\n * Do not edit the class manually.\n */\nimport { Annotation } from './Annotation'\nimport { CodeStub } from './CodeStub'\nimport { Content } from './Content'\nimport { Delegation } from './Delegation'\nimport { Identifier } from './Identifier'\nimport { SecurityMetadata } from './SecurityMetadata'\nimport { EntityWithDelegationTypeName } from '../../icc-x-api/utils/EntityWithDelegationTypeName'\n\n/**\n * This entity represents a Service. A Service is created in the course a contact. Services include subjective information provided by the patient, such as complaints, reason for visit, feelings, etc. or objective information like bio-metric measures (blood pressure, temperature, heart beat, etc.), or physical exam description, diagnosis, prescription, integration of lab reports from another healthcare party, action plan, etc. Any action performed by the healthcare party which is relevant for the healthcare element of a patient is considered a service. The services can be linked to healthcare elements or other structuring elements of the medical record\n */\nexport class Service {\n  constructor(json: JSON | any) {\n    Object.assign(this as Service, json)\n  }\n\n  /**\n   * The Id of the Service. We encourage using either a v4 UUID or a HL7 Id.\n   */\n  id?: string\n  /**\n   * The transactionId is used when a single service had to be split into parts for technical reasons. Several services with the same non null transaction id form one single service\n   */\n  transactionId?: string\n  identifier?: Array<Identifier>\n  /**\n   * Id of the contact during which the service is provided\n   */\n  contactId?: string\n  /**\n   * List of IDs of all sub-contacts that link the service to structural elements. Only used when the Service is emitted outside of its contact\n   */\n  subContactIds?: Array<string>\n  /**\n   * List of IDs of all plans of actions (healthcare approaches) as a part of which the Service is provided. Only used when the Service is emitted outside of its contact\n   */\n  plansOfActionIds?: Array<string>\n  /**\n   * List of IDs of all healthcare elements for which the service is provided. Only used when the Service is emitted outside of its contact\n   */\n  healthElementsIds?: Array<string>\n  /**\n   * List of Ids of all forms linked to the Service. Only used when the Service is emitted outside of its contact.\n   */\n  formIds?: Array<string>\n  /**\n   * The secret patient key, encrypted in the patient document, in clear here.\n   */\n  secretForeignKeys?: Array<string>\n  /**\n   * The public patient key, encrypted here for separate Crypto Actors.\n   */\n  cryptedForeignKeys?: { [key: string]: Array<Delegation> }\n  /**\n   * The delegations giving access to connected healthcare information.\n   */\n  delegations?: { [key: string]: Array<Delegation> }\n  /**\n   * The contact secret encryption key used to encrypt the secured properties (like services for example), encrypted for separate Crypto Actors.\n   */\n  encryptionKeys?: { [key: string]: Array<Delegation> }\n  /**\n   * Description / Unambiguous qualification (LOINC code) of the type of information contained in the service. Could be a code to qualify temperature, complaint, diagnostic, ...\n   */\n  label?: string\n  dataClassName?: string\n  /**\n   * Used for sorting services inside an upper object (A contact, a transaction, a FHIR bundle, ...)\n   */\n  index?: number\n  /**\n   * Information contained in the service. Content is localized, using ISO language code as key\n   */\n  content?: { [key: string]: Content }\n  encryptedContent?: string\n  textIndexes?: { [key: string]: string }\n  /**\n   * The date (YYYYMMDDhhmmss) when the Service is noted to have started and also closes on the same date\n   */\n  valueDate?: number\n  /**\n   * The date (YYYYMMDDhhmmss) of the start of the Service\n   */\n  openingDate?: number\n  /**\n   * The date (YYYYMMDDhhmmss) marking the end of the Service\n   */\n  closingDate?: number\n  /**\n   * Id of the form used during the Service\n   */\n  formId?: string\n  /**\n   * The timestamp (unix epoch in ms) of creation of this entity, will be filled automatically if missing. Not enforced by the application server.\n   */\n  created?: number\n  /**\n   * The date (unix epoch in ms) of the latest modification of this entity, will be filled automatically if missing. Not enforced by the application server.\n   */\n  modified?: number\n  /**\n   * Soft delete (unix epoch in ms) timestamp of the object.\n   */\n  endOfLife?: number\n  /**\n   * The id of the User that has created this entity, will be filled automatically if missing. Not enforced by the application server.\n   */\n  author?: string\n  /**\n   * The id of the HealthcareParty that is responsible for this entity, will be filled automatically if missing. Not enforced by the application server.\n   */\n  responsible?: string\n  /**\n   * The id of the medical location where this entity was created.\n   */\n  medicalLocationId?: string\n  /**\n   * Text, comments on the Service provided\n   */\n  comment?: string\n  status?: number\n  /**\n   * List of invoicing codes\n   */\n  invoicingCodes?: Array<string>\n  /**\n   * Comments - Notes recorded by a HCP about this service\n   */\n  notes?: Array<Annotation>\n  /**\n   * Links towards related services (possibly in other contacts)\n   */\n  qualifiedLinks?: { [key: string]: { [key: string]: string } }\n  /**\n   * A code is an item from a codification system that qualifies the content of this entity. SNOMED-CT, ICPC-2 or ICD-10 codifications systems can be used for codes\n   */\n  codes?: Array<CodeStub>\n  /**\n   * A tag is an item from a codification system that qualifies an entity as being member of a certain class, whatever the value it might have taken. If the tag qualifies the content of a field, it means that whatever the content of the field, the tag will always apply. For example, the label of a field is qualified using a tag. LOINC is a codification system typically used for tags.\n   */\n  tags?: Array<CodeStub>\n  /**\n   * The base64 encoded data of this object, formatted as JSON and encrypted in AES using the random master key from encryptionKeys.\n   */\n  encryptedSelf?: string\n  securityMetadata?: SecurityMetadata\n}\n"]}

package/icc-api/model/TimeTable.d.ts

@@ -12,6 +12,7 @@
 import { CodeStub } from './CodeStub';
 import { Delegation } from './Delegation';
 import { TimeTableItem } from './TimeTableItem';
+import { SecurityMetadata } from './SecurityMetadata';
 export declare class TimeTable {
     constructor(json: JSON | any);
     id?: string;
@@ -83,4 +84,5 @@ export declare class TimeTable {
      * The base64 encoded data of this object, formatted as JSON and encrypted in AES using the random master key from encryptionKeys.
      */
     encryptedSelf?: string;
+    securityMetadata?: SecurityMetadata;
 }

package/icc-api/model/TimeTable.js.map

@@ -1 +1 @@
-{"version":3,"file":"TimeTable.js","sourceRoot":"","sources":["../../../icc-api/model/TimeTable.ts"],"names":[],"mappings":";;;AAeA,MAAa,SAAS;IACpB,YAAY,IAAgB;QAC1B,MAAM,CAAC,MAAM,CAAC,IAAiB,EAAE,IAAI,CAAC,CAAA;IACxC,CAAC;CAiEF;AApED,8BAoEC","sourcesContent":["/**\n * iCure Data Stack API Documentation\n * The iCure Data Stack Application API is the native interface to iCure. This version is obsolete, please use v2.\n *\n * OpenAPI spec version: v1\n *\n *\n * NOTE: This class is auto generated by the swagger code generator program.\n * https://github.com/swagger-api/swagger-codegen.git\n * Do not edit the class manually.\n */\nimport { CodeStub } from './CodeStub'\nimport { Delegation } from './Delegation'\nimport { TimeTableItem } from './TimeTableItem'\n\nexport class TimeTable {\n  constructor(json: JSON | any) {\n    Object.assign(this as TimeTable, json)\n  }\n\n  id?: string\n  rev?: string\n  /**\n   * The timestamp (unix epoch in ms) of creation of this entity, will be filled automatically if missing. Not enforced by the application server.\n   */\n  created?: number\n  /**\n   * The date (unix epoch in ms) of the latest modification of this entity, will be filled automatically if missing. Not enforced by the application server.\n   */\n  modified?: number\n  /**\n   * The id of the User that has created this entity, will be filled automatically if missing. Not enforced by the application server.\n   */\n  author?: string\n  /**\n   * The id of the HealthcareParty that is responsible for this entity, will be filled automatically if missing. Not enforced by the application server.\n   */\n  responsible?: string\n  /**\n   * The id of the medical location where this entity was created.\n   */\n  medicalLocationId?: string\n  /**\n   * A tag is an item from a codification system that qualifies an entity as being member of a certain class, whatever the value it might have taken. If the tag qualifies the content of a field, it means that whatever the content of the field, the tag will always apply. For example, the label of a field is qualified using a tag. LOINC is a codification system typically used for tags.\n   */\n  tags?: Array<CodeStub>\n  /**\n   * A code is an item from a codification system that qualifies the content of this entity. SNOMED-CT, ICPC-2 or ICD-10 codifications systems can be used for codes\n   */\n  codes?: Array<CodeStub>\n  /**\n   * Soft delete (unix epoch in ms) timestamp of the object.\n   */\n  endOfLife?: number\n  /**\n   * hard delete (unix epoch in ms) timestamp of the object. Filled automatically when deletePatient is called.\n   */\n  deletionDate?: number\n  name?: string\n  agendaId?: string\n  startTime?: number\n  endTime?: number\n  items?: Array<TimeTableItem>\n  /**\n   * The secretForeignKeys are filled at the to many end of a one to many relationship (for example inside Contact for the Patient -> Contacts relationship). Used when we want to find all contacts for a specific patient. These keys are in clear. You can have several to partition the medical document space.\n   */\n  secretForeignKeys?: Array<string>\n  /**\n   * The secretForeignKeys are filled at the to many end of a one to many relationship (for example inside Contact for the Patient -> Contacts relationship). Used when we want to find the patient for a specific contact. These keys are the encrypted id (using the hcParty key for the delegate) that can be found in clear inside the patient. ids encrypted using the hcParty keys.\n   */\n  cryptedForeignKeys?: { [key: string]: Array<Delegation> }\n  /**\n   * When a document is created, the responsible generates a cryptographically random master key (never to be used for something else than referencing from other entities). He/she encrypts it using his own AES exchange key and stores it as a delegation. The responsible is thus always in the delegations as well\n   */\n  delegations?: { [key: string]: Array<Delegation> }\n  /**\n   * When a document needs to be encrypted, the responsible generates a cryptographically random master key (different from the delegation key, never to appear in clear anywhere in the db. He/she encrypts it using his own AES exchange key and stores it as a delegation\n   */\n  encryptionKeys?: { [key: string]: Array<Delegation> }\n  /**\n   * The base64 encoded data of this object, formatted as JSON and encrypted in AES using the random master key from encryptionKeys.\n   */\n  encryptedSelf?: string\n}\n"]}
+{"version":3,"file":"TimeTable.js","sourceRoot":"","sources":["../../../icc-api/model/TimeTable.ts"],"names":[],"mappings":";;;AAiBA,MAAa,SAAS;IACpB,YAAY,IAAgB;QAC1B,MAAM,CAAC,MAAM,CAAC,IAAiB,EAAE,IAAI,CAAC,CAAA;IACxC,CAAC;CAmEF;AAtED,8BAsEC","sourcesContent":["/**\n * iCure Data Stack API Documentation\n * The iCure Data Stack Application API is the native interface to iCure. This version is obsolete, please use v2.\n *\n * OpenAPI spec version: v1\n *\n *\n * NOTE: This class is auto generated by the swagger code generator program.\n * https://github.com/swagger-api/swagger-codegen.git\n * Do not edit the class manually.\n */\nimport { CodeStub } from './CodeStub'\nimport { Delegation } from './Delegation'\nimport { TimeTableItem } from './TimeTableItem'\nimport { SecurityMetadata } from './SecurityMetadata'\nimport { EntityWithDelegationTypeName } from '../../icc-x-api/utils/EntityWithDelegationTypeName'\n\nexport class TimeTable {\n  constructor(json: JSON | any) {\n    Object.assign(this as TimeTable, json)\n  }\n\n  id?: string\n  rev?: string\n  /**\n   * The timestamp (unix epoch in ms) of creation of this entity, will be filled automatically if missing. Not enforced by the application server.\n   */\n  created?: number\n  /**\n   * The date (unix epoch in ms) of the latest modification of this entity, will be filled automatically if missing. Not enforced by the application server.\n   */\n  modified?: number\n  /**\n   * The id of the User that has created this entity, will be filled automatically if missing. Not enforced by the application server.\n   */\n  author?: string\n  /**\n   * The id of the HealthcareParty that is responsible for this entity, will be filled automatically if missing. Not enforced by the application server.\n   */\n  responsible?: string\n  /**\n   * The id of the medical location where this entity was created.\n   */\n  medicalLocationId?: string\n  /**\n   * A tag is an item from a codification system that qualifies an entity as being member of a certain class, whatever the value it might have taken. If the tag qualifies the content of a field, it means that whatever the content of the field, the tag will always apply. For example, the label of a field is qualified using a tag. LOINC is a codification system typically used for tags.\n   */\n  tags?: Array<CodeStub>\n  /**\n   * A code is an item from a codification system that qualifies the content of this entity. SNOMED-CT, ICPC-2 or ICD-10 codifications systems can be used for codes\n   */\n  codes?: Array<CodeStub>\n  /**\n   * Soft delete (unix epoch in ms) timestamp of the object.\n   */\n  endOfLife?: number\n  /**\n   * hard delete (unix epoch in ms) timestamp of the object. Filled automatically when deletePatient is called.\n   */\n  deletionDate?: number\n  name?: string\n  agendaId?: string\n  startTime?: number\n  endTime?: number\n  items?: Array<TimeTableItem>\n  /**\n   * The secretForeignKeys are filled at the to many end of a one to many relationship (for example inside Contact for the Patient -> Contacts relationship). Used when we want to find all contacts for a specific patient. These keys are in clear. You can have several to partition the medical document space.\n   */\n  secretForeignKeys?: Array<string>\n  /**\n   * The secretForeignKeys are filled at the to many end of a one to many relationship (for example inside Contact for the Patient -> Contacts relationship). Used when we want to find the patient for a specific contact. These keys are the encrypted id (using the hcParty key for the delegate) that can be found in clear inside the patient. ids encrypted using the hcParty keys.\n   */\n  cryptedForeignKeys?: { [key: string]: Array<Delegation> }\n  /**\n   * When a document is created, the responsible generates a cryptographically random master key (never to be used for something else than referencing from other entities). He/she encrypts it using his own AES exchange key and stores it as a delegation. The responsible is thus always in the delegations as well\n   */\n  delegations?: { [key: string]: Array<Delegation> }\n  /**\n   * When a document needs to be encrypted, the responsible generates a cryptographically random master key (different from the delegation key, never to appear in clear anywhere in the db. He/she encrypts it using his own AES exchange key and stores it as a delegation\n   */\n  encryptionKeys?: { [key: string]: Array<Delegation> }\n  /**\n   * The base64 encoded data of this object, formatted as JSON and encrypted in AES using the random master key from encryptionKeys.\n   */\n  encryptedSelf?: string\n  securityMetadata?: SecurityMetadata\n  \n}\n"]}

package/icc-api/model/Topic.d.ts

@@ -0,0 +1,95 @@
+import { CodeStub } from "./CodeStub";
+import { SecurityMetadata } from "./SecurityMetadata";
+import { Delegation } from "./Delegation";
+export declare class Topic {
+    constructor(json: JSON | any);
+    /**
+     * The id of the topic. We encourage using either a v4 UUID or a HL7 Id.
+     */
+    id?: string;
+    /**
+     * The revision of the topic in the database, used for conflict management / optimistic locking.
+     */
+    rev?: string;
+    /**
+     * The timestamp (unix epoch in ms) of creation of this entity, will be filled automatically if missing. Not enforced by the application server.
+     */
+    created?: number;
+    /**
+     * The timestamp (unix epoch in ms) of the latest modification of this entity, will be filled automatically if missing. Not enforced by the application server.
+     */
+    modified?: number;
+    /**
+     * Name/basic description of the topic
+     */
+    description?: string;
+    /**
+     * A tag is an item from a codification system that qualifies an entity as being member of a certain class, whatever the value it might have taken. If the tag qualifies the content of a field, it means that whatever the content of the field, the tag will always apply. For example, the label of a field is qualified using a tag. LOINC is a codification system typically used for tags.
+     */
+    tags?: Array<CodeStub>;
+    /**
+     * A code is an item from a codification system that qualifies the content of this entity. SNOMED-CT, ICPC-2 or ICD-10 codifications systems can be used for codes
+     */
+    codes?: Array<CodeStub>;
+    /**
+     * The id of the User that has created this entity, will be filled automatically if missing. Not enforced by the application server.
+     */
+    author?: string;
+    /**
+     * The id of the HealthcareParty that is responsible for this entity, will be filled automatically if missing. Not enforced by the application server.
+     */
+    responsible?: string;
+    /**
+     * The id of the medical location where this entity was created.
+     */
+    medicalLocationId?: string;
+    /**
+     * Soft delete (unix epoch in ms) timestamp of the object.
+     */
+    endOfLife?: number;
+    /**
+     * hard delete (unix epoch in ms) timestamp of the object. Filled automatically when deletePatient is called.
+     */
+    deletionDate?: number;
+    /**
+     * List of participants to the topic and their role in the topic {@link TopicRole}
+     *
+     * This should not be used directly, in the future the format may change. Make sure to only edit this through methods of {@link IccTopicXApi}.
+     */
+    activeParticipants?: {
+        [key: string]: TopicRole;
+    };
+    linkedServices?: string[];
+    linkedHealthElements?: string[];
+    securityMetadata?: SecurityMetadata;
+    /**
+     * The secretForeignKeys are filled at the to many end of a one to many relationship (for example inside Contact for the Patient -> Contacts relationship). Used when we want to find all contacts for a specific patient. These keys are in clear. You can have several to partition the medical document space.
+     */
+    secretForeignKeys?: Array<string>;
+    /**
+     * The secretForeignKeys are filled at the to many end of a one to many relationship (for example inside Contact for the Patient -> Contacts relationship). Used when we want to find the patient for a specific contact. These keys are the encrypted id (using the hcParty key for the delegate) that can be found in clear inside the patient. ids encrypted using the hcParty keys.
+     */
+    cryptedForeignKeys?: {
+        [key: string]: Array<Delegation>;
+    };
+    /**
+     * When a document is created, the responsible generates a cryptographically random master key (never to be used for something else than referencing from other entities). He/she encrypts it using his own AES exchange key and stores it as a delegation. The responsible is thus always in the delegations as well
+     */
+    delegations?: {
+        [key: string]: Array<Delegation>;
+    };
+    /**
+     * When a document needs to be encrypted, the responsible generates a cryptographically random master key (different from the delegation key, never to appear in clear anywhere in the db. He/she encrypts it using his own AES exchange key and stores it as a delegation     */
+    encryptionKeys?: {
+        [key: string]: Array<Delegation>;
+    };
+    /**
+     * The base64 encoded data of this object, formatted as JSON and encrypted in AES using the random master key from encryptionKeys.
+     */
+    encryptedSelf?: string;
+}
+export declare enum TopicRole {
+    PARTICIPANT = "PARTICIPANT",
+    ADMIN = "ADMIN",
+    OWNER = "OWNER"
+}

package/icc-api/model/Topic.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TopicRole = exports.Topic = void 0;
+class Topic {
+    constructor(json) {
+        Object.assign(this, json);
+    }
+}
+exports.Topic = Topic;
+var TopicRole;
+(function (TopicRole) {
+    TopicRole["PARTICIPANT"] = "PARTICIPANT";
+    TopicRole["ADMIN"] = "ADMIN";
+    TopicRole["OWNER"] = "OWNER";
+})(TopicRole = exports.TopicRole || (exports.TopicRole = {}));
+//# sourceMappingURL=Topic.js.map

package/icc-api/model/Topic.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Topic.js","sourceRoot":"","sources":["../../../icc-api/model/Topic.ts"],"names":[],"mappings":";;;AAKA,MAAa,KAAK;IACd,YAAY,IAAgB;QACxB,MAAM,CAAC,MAAM,CAAC,IAAa,EAAE,IAAI,CAAC,CAAA;IACtC,CAAC;CAmFJ;AAtFD,sBAsFC;AAED,IAAY,SAIX;AAJD,WAAY,SAAS;IACjB,wCAA2B,CAAA;IAC3B,4BAAe,CAAA;IACf,4BAAe,CAAA;AACnB,CAAC,EAJW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAIpB","sourcesContent":["import {CodeStub} from \"./CodeStub\";\nimport {SecurityMetadata} from \"./SecurityMetadata\";\nimport {Delegation} from \"./Delegation\";\nimport {EntityWithDelegationTypeName} from \"../../icc-x-api/utils/EntityWithDelegationTypeName\";\n\nexport class Topic {\n    constructor(json: JSON | any) {\n        Object.assign(this as Topic, json)\n    }\n\n    /**\n     * The id of the topic. We encourage using either a v4 UUID or a HL7 Id.\n     */\n    id?: string\n    /**\n     * The revision of the topic in the database, used for conflict management / optimistic locking.\n     */\n    rev?: string\n    /**\n     * The timestamp (unix epoch in ms) of creation of this entity, will be filled automatically if missing. Not enforced by the application server.\n     */\n    created?: number\n    /**\n     * The timestamp (unix epoch in ms) of the latest modification of this entity, will be filled automatically if missing. Not enforced by the application server.\n     */\n    modified?: number\n    /**\n     * Name/basic description of the topic\n     */\n    description?: string\n    /**\n     * A tag is an item from a codification system that qualifies an entity as being member of a certain class, whatever the value it might have taken. If the tag qualifies the content of a field, it means that whatever the content of the field, the tag will always apply. For example, the label of a field is qualified using a tag. LOINC is a codification system typically used for tags.\n     */\n    tags?: Array<CodeStub>\n    /**\n     * A code is an item from a codification system that qualifies the content of this entity. SNOMED-CT, ICPC-2 or ICD-10 codifications systems can be used for codes\n     */\n    codes?: Array<CodeStub>\n    /**\n     * The id of the User that has created this entity, will be filled automatically if missing. Not enforced by the application server.\n     */\n    author?: string\n    /**\n     * The id of the HealthcareParty that is responsible for this entity, will be filled automatically if missing. Not enforced by the application server.\n     */\n    responsible?: string\n    /**\n     * The id of the medical location where this entity was created.\n     */\n    medicalLocationId?: string\n    /**\n     * Soft delete (unix epoch in ms) timestamp of the object.\n     */\n    endOfLife?: number\n    /**\n     * hard delete (unix epoch in ms) timestamp of the object. Filled automatically when deletePatient is called.\n     */\n    deletionDate?: number\n    /**\n     * List of participants to the topic and their role in the topic {@link TopicRole}\n     *\n     * This should not be used directly, in the future the format may change. Make sure to only edit this through methods of {@link IccTopicXApi}.\n     */\n    activeParticipants?: { [key: string]: TopicRole }\n\n    linkedServices?: string[]\n\n    linkedHealthElements?: string[]\n\n    securityMetadata?: SecurityMetadata\n    /**\n     * The secretForeignKeys are filled at the to many end of a one to many relationship (for example inside Contact for the Patient -> Contacts relationship). Used when we want to find all contacts for a specific patient. These keys are in clear. You can have several to partition the medical document space.\n     */\n    secretForeignKeys?: Array<string>\n    /**\n     * The secretForeignKeys are filled at the to many end of a one to many relationship (for example inside Contact for the Patient -> Contacts relationship). Used when we want to find the patient for a specific contact. These keys are the encrypted id (using the hcParty key for the delegate) that can be found in clear inside the patient. ids encrypted using the hcParty keys.\n     */\n\n    cryptedForeignKeys?: { [key: string]: Array<Delegation> }\n    /**\n     * When a document is created, the responsible generates a cryptographically random master key (never to be used for something else than referencing from other entities). He/she encrypts it using his own AES exchange key and stores it as a delegation. The responsible is thus always in the delegations as well\n     */\n    delegations?: { [key: string]: Array<Delegation> }\n    /**\n     * When a document needs to be encrypted, the responsible generates a cryptographically random master key (different from the delegation key, never to appear in clear anywhere in the db. He/she encrypts it using his own AES exchange key and stores it as a delegation     */\n    encryptionKeys?: { [key: string]: Array<Delegation> }\n    /**\n     * The base64 encoded data of this object, formatted as JSON and encrypted in AES using the random master key from encryptionKeys.\n     */\n    encryptedSelf?: string\n    \n}\n\nexport enum TopicRole {\n    PARTICIPANT = 'PARTICIPANT',\n    ADMIN = 'ADMIN',\n    OWNER = 'OWNER',\n}\n"]}

package/icc-api/model/internal/ExchangeData.d.ts

@@ -0,0 +1,64 @@
+/**
+ * @internal this entity is meant for internal use only
+ */
+export declare class ExchangeData {
+    constructor(json: JSON | any);
+    /**
+     * the Id of the exchange data. We encourage using either a v4 UUID or a HL7 Id.
+     */
+    id?: string;
+    /**
+     * the revision of the exchange data in the database, used for conflict management / optimistic locking.
+     */
+    rev?: string;
+    /**
+     * ID of the data owner which created this exchange data, in order to share some data with the [delegate].
+     */
+    delegator: string;
+    /**
+     * ID of a data owner which can use this exchange data to access data shared with him by [delegator].
+     */
+    delegate: string;
+    /**
+     * Aes key to use for sharing data from the delegator to the delegate, encrypted with the public keys of both delegate
+     * and delegator. This key should never be sent decrypted to the server, as it allows to read medical data.
+     */
+    exchangeKey: {
+        [keyPairFingerprint: string]: string;
+    };
+    /**
+     * Key used for access control to data shared from the delegator to the delegate, encrypted with the public keys of both
+     * delegate and delegator.
+     *
+     * This key will be used by the client to calculate the keys of [HasSecureDelegationsAccessControl.securityMetadata] which
+     * allows to implement a form of access control where the identity of data owners with access to a specific entity can't be
+     * deduced from the database alone. This is useful for example to allow patients to access their medical data without creating
+     * a deducible link between the patient and the medical data in the database.
+     *
+     * There are no strict requirements on how the client should use this secret to create the security metadata key, but for
+     * authentication the client must be able to provide a 128 bit long access control key (see [DataOwnerAuthenticationDetails.accessControlKeys])
+     * which once hashed using sha256 will give the key of the security metadata.
+     * However, in order to avoid introducing undesired links between entities which could be detrimental to the patients privacy
+     * the access control keys should be created also using information on the entity class and confidentiality level of information
+     * in applications where hcps share information using a hierarchical structure.
+     * ```
+     * accessControlKey = sha256Bytes(accessControlSecret + entityClass + confidentialityLevel).take(16)
+     * securityMetadataKey = sha256Hex(accessControlKey)
+     * ```
+     */
+    accessControlSecret: {
+        [keyPairFingerprint: string]: string;
+    };
+    /**
+     * Signature to ensure the key data has not been tampered with: when creating new exchange data the delegator will hash
+     * the content of [exchangeKey] and [accessControlSecret] then use his trusted private keys to sign this hash. This field
+     * will contain the signature by fingerprint of the public key to use for verification.
+     */
+    signature: {
+        [keyPairFingerprint: string]: string;
+    };
+    /**
+     * hard delete (unix epoch in ms) timestamp of the object. Filled automatically when the delete method is called.
+     */
+    deletionDate?: number;
+}