@icure/api 7.1.5 → 7.1.6

package/icc-api/model/Telecom.ts

@@ -0,0 +1,64 @@
+/**
+ * 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.
+ */
+
+/**
+ * This entity represents available contact details of a user, reachable by telecom methods
+ */
+export class Telecom {
+  constructor(json: JSON | any) {
+    Object.assign(this as Telecom, json)
+  }
+
+  /**
+   * The type of telecom method being used, ex: landline phone, mobile phone, email, fax, etc.
+   */
+  telecomType?: Telecom.TelecomTypeEnum
+  telecomNumber?: string
+  telecomDescription?: string
+  /**
+   * The base64 encoded data of this object, formatted as JSON and encrypted in AES using the random master key from encryptionKeys.
+   */
+  encryptedSelf?: string
+}
+export namespace Telecom {
+  export type TelecomTypeEnum =
+    | 'mobile'
+    | 'phone'
+    | 'email'
+    | 'fax'
+    | 'skype'
+    | 'im'
+    | 'medibridge'
+    | 'ehealthbox'
+    | 'apicrypt'
+    | 'web'
+    | 'print'
+    | 'disk'
+    | 'other'
+    | 'pager'
+  export const TelecomTypeEnum = {
+    Mobile: 'mobile' as TelecomTypeEnum,
+    Phone: 'phone' as TelecomTypeEnum,
+    Email: 'email' as TelecomTypeEnum,
+    Fax: 'fax' as TelecomTypeEnum,
+    Skype: 'skype' as TelecomTypeEnum,
+    Im: 'im' as TelecomTypeEnum,
+    Medibridge: 'medibridge' as TelecomTypeEnum,
+    Ehealthbox: 'ehealthbox' as TelecomTypeEnum,
+    Apicrypt: 'apicrypt' as TelecomTypeEnum,
+    Web: 'web' as TelecomTypeEnum,
+    Print: 'print' as TelecomTypeEnum,
+    Disk: 'disk' as TelecomTypeEnum,
+    Other: 'other' as TelecomTypeEnum,
+    Pager: 'pager' as TelecomTypeEnum,
+  }
+}

package/icc-api/model/TimeSeries.ts

@@ -0,0 +1,28 @@
+/**
+ * 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.
+ */
+
+/**
+ * A high frequency time-series containing the ts in ms from the start (double) and the values
+ */
+export class TimeSeries {
+  constructor(json: JSON | any) {
+    Object.assign(this as TimeSeries, json)
+  }
+
+  fields?: Array<string>
+  samples?: Array<Array<number>>
+  min?: Array<number>
+  max?: Array<number>
+  mean?: Array<number>
+  median?: Array<number>
+  variance?: Array<number>
+}

package/icc-api/model/TimeTable.ts

@@ -0,0 +1,84 @@
+/**
+ * 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.
+ */
+import { CodeStub } from './CodeStub'
+import { Delegation } from './Delegation'
+import { TimeTableItem } from './TimeTableItem'
+
+export class TimeTable {
+  constructor(json: JSON | any) {
+    Object.assign(this as TimeTable, json)
+  }
+
+  id?: string
+  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 date (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
+  /**
+   * 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
+  /**
+   * 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>
+  /**
+   * 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
+  name?: string
+  agendaId?: string
+  startTime?: number
+  endTime?: number
+  items?: Array<TimeTableItem>
+  /**
+   * 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
+}

package/icc-api/model/TimeTableHour.ts

@@ -0,0 +1,20 @@
+/**
+ * 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 class TimeTableHour {
+  constructor(json: JSON | any) {
+    Object.assign(this as TimeTableHour, json)
+  }
+
+  startHour?: number
+  endHour?: number
+}

package/icc-api/model/TimeTableItem.ts

@@ -0,0 +1,30 @@
+/**
+ * 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.
+ */
+import { TimeTableHour } from './TimeTableHour'
+
+export class TimeTableItem {
+  constructor(json: JSON | any) {
+    Object.assign(this as TimeTableItem, json)
+  }
+
+  rruleStartDate?: number
+  rrule?: string
+  days?: Array<string>
+  recurrenceTypes?: Array<string>
+  hours?: Array<TimeTableHour>
+  calendarItemTypeId?: string
+  homeVisit?: boolean
+  placeId?: string
+  publicTimeTableItem?: boolean
+  acceptsNewPatient?: boolean
+  unavailable?: boolean
+}

package/icc-api/model/TokenWithGroup.ts

@@ -0,0 +1,21 @@
+/**
+ * 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 class TokenWithGroup {
+  constructor(json: JSON | any) {
+    Object.assign(this as TokenWithGroup, json)
+  }
+
+  token?: string
+  groupId?: string
+  groupName?: string
+}

package/icc-api/model/TypedValueObject.ts

@@ -0,0 +1,40 @@
+/**
+ * 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 class TypedValueObject {
+  constructor(json: JSON | any) {
+    Object.assign(this as TypedValueObject, json)
+  }
+
+  type?: TypedValueObject.TypeEnum
+  booleanValue?: boolean
+  integerValue?: number
+  doubleValue?: number
+  stringValue?: string
+  dateValue?: number
+  /**
+   * The base64 encoded data of this object, formatted as JSON and encrypted in AES using the random master key from encryptionKeys.
+   */
+  encryptedSelf?: string
+}
+export namespace TypedValueObject {
+  export type TypeEnum = 'BOOLEAN' | 'INTEGER' | 'DOUBLE' | 'STRING' | 'DATE' | 'CLOB' | 'JSON'
+  export const TypeEnum = {
+    BOOLEAN: 'BOOLEAN' as TypeEnum,
+    INTEGER: 'INTEGER' as TypeEnum,
+    DOUBLE: 'DOUBLE' as TypeEnum,
+    STRING: 'STRING' as TypeEnum,
+    DATE: 'DATE' as TypeEnum,
+    CLOB: 'CLOB' as TypeEnum,
+    JSON: 'JSON' as TypeEnum,
+  }
+}

package/icc-api/model/Unit.ts

@@ -0,0 +1,17 @@
+/**
+ * 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 class Unit {
+  constructor(json: JSON | any) {
+    Object.assign(this as Unit, json)
+  }
+}

package/icc-api/model/User.ts

@@ -0,0 +1,173 @@
+/**
+ * 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.
+ */
+import { AuthenticationToken } from './AuthenticationToken'
+import { Permission } from './Permission'
+import { PropertyStub } from './PropertyStub'
+
+/**
+ * This entity is a root level object. It represents an user that can log in to the iCure platform. It is serialized in JSON and saved in the underlying icure-base CouchDB database.
+ */
+export class User {
+  constructor(json: JSON | any) {
+    Object.assign(this as User, json)
+  }
+
+  /**
+   * the Id of the user. We encourage using either a v4 UUID or a HL7 Id.
+   */
+  id?: string
+  /**
+   * the revision of the user in the database, used for conflict management / optimistic locking.
+   */
+  rev?: string
+  /**
+   * hard delete (unix epoch in ms) timestamp of the object. Filled automatically when deletePatient is called.
+   */
+  deletionDate?: number
+  created?: number
+  /**
+   * Last name of the user. This is the official last name that should be used for official administrative purposes.
+   */
+  name?: string
+  /**
+   * Extra properties for the user. Those properties are typed (see class Property)
+   */
+  properties?: Array<PropertyStub>
+  /**
+   * If permission to modify patient data is granted or revoked
+   */
+  permissions?: Array<Permission>
+  /**
+   * Roles specified for the user
+   */
+  roles?: Array<string>
+  /**
+   * Authorization source for user. 'Database', 'ldap' or 'token'
+   */
+  type?: User.TypeEnum
+  /**
+   * State of user's activeness: 'Active', 'Disabled' or 'Registering'
+   */
+  status?: User.StatusEnum
+  /**
+   * Username for this user. We encourage using an email address
+   */
+  login?: string
+  /**
+   * Hashed version of the password (BCrypt is used for hashing)
+   */
+  passwordHash?: string
+  /**
+   * Secret token used to verify 2fa
+   */
+  secret?: string
+  /**
+   * Whether the user has activated two factors authentication
+   */
+  use2fa?: boolean
+  /**
+   * id of the group (practice/hospital) the user is member of
+   */
+  groupId?: string
+  /**
+   * Id of the healthcare party if the user is a healthcare party.
+   */
+  healthcarePartyId?: string
+  /**
+   * Id of the patient if the user is a patient
+   */
+  patientId?: string
+  /**
+   * Id of the device if the user is a device
+   */
+  deviceId?: string
+  /**
+   * Delegations that are automatically generated client side when a new database object is created by this user
+   */
+  autoDelegations?: { [key in User.AutoDelegationTagEnum]?: Array<string> }
+  /**
+   * the timestamp (unix epoch in ms) of creation of the user, will be filled automatically if missing. Not enforced by the application server.
+   */
+  createdDate?: number
+  /**
+   * the timestamp (unix epoch in ms) of the latest validation of the terms of use of the application
+   */
+  termsOfUseDate?: number
+  /**
+   * email address of the user (used for token exchange or password recovery).
+   */
+  email?: string
+  /**
+   * mobile phone of the user (used for token exchange or password recovery).
+   */
+  mobilePhone?: string
+  applicationTokens?: { [key: string]: string }
+  /**
+   * Encrypted and time-limited Authentication tokens used for inter-applications authentication
+   */
+  authenticationTokens?: { [key: string]: AuthenticationToken }
+}
+export namespace User {
+  export type TypeEnum = 'database' | 'ldap' | 'token'
+  export const TypeEnum = {
+    Database: 'database' as TypeEnum,
+    Ldap: 'ldap' as TypeEnum,
+    Token: 'token' as TypeEnum,
+  }
+  export type StatusEnum = 'ACTIVE' | 'DISABLED' | 'REGISTERING'
+  export const StatusEnum = {
+    ACTIVE: 'ACTIVE' as StatusEnum,
+    DISABLED: 'DISABLED' as StatusEnum,
+    REGISTERING: 'REGISTERING' as StatusEnum,
+  }
+  export type AutoDelegationTagEnum =
+    | 'all'
+    | 'administrativeData'
+    | 'generalInformation'
+    | 'financialInformation'
+    | 'medicalInformation'
+    | 'sensitiveInformation'
+    | 'confidentialInformation'
+    | 'cdItemRisk'
+    | 'cdItemFamilyRisk'
+    | 'cdItemHealthcareelement'
+    | 'cdItemHealthcareapproach'
+    | 'cdItemAllergy'
+    | 'cdItemDiagnosis'
+    | 'cdItemLab'
+    | 'cdItemResult'
+    | 'cdItemParameter'
+    | 'cdItemMedication'
+    | 'cdItemTreatment'
+    | 'cdItemVaccine'
+  export const AutoDelegationTagEnum = {
+    all: 'all' as AutoDelegationTagEnum,
+    administrativeData: 'administrativeData' as AutoDelegationTagEnum,
+    generalInformation: 'generalInformation' as AutoDelegationTagEnum,
+    financialInformation: 'financialInformation' as AutoDelegationTagEnum,
+    medicalInformation: 'medicalInformation' as AutoDelegationTagEnum,
+    sensitiveInformation: 'sensitiveInformation' as AutoDelegationTagEnum,
+    confidentialInformation: 'confidentialInformation' as AutoDelegationTagEnum,
+    cdItemRisk: 'cdItemRisk' as AutoDelegationTagEnum,
+    cdItemFamilyRisk: 'cdItemFamilyRisk' as AutoDelegationTagEnum,
+    cdItemHealthcareelement: 'cdItemHealthcareelement' as AutoDelegationTagEnum,
+    cdItemHealthcareapproach: 'cdItemHealthcareapproach' as AutoDelegationTagEnum,
+    cdItemAllergy: 'cdItemAllergy' as AutoDelegationTagEnum,
+    cdItemDiagnosis: 'cdItemDiagnosis' as AutoDelegationTagEnum,
+    cdItemLab: 'cdItemLab' as AutoDelegationTagEnum,
+    cdItemResult: 'cdItemResult' as AutoDelegationTagEnum,
+    cdItemParameter: 'cdItemParameter' as AutoDelegationTagEnum,
+    cdItemMedication: 'cdItemMedication' as AutoDelegationTagEnum,
+    cdItemTreatment: 'cdItemTreatment' as AutoDelegationTagEnum,
+    cdItemVaccine: 'cdItemVaccine' as AutoDelegationTagEnum,
+  }
+}

package/icc-api/model/UserAndHealthcareParty.ts

@@ -0,0 +1,25 @@
+/**
+ * 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.
+ */
+import { HealthcareParty } from './HealthcareParty'
+import { User } from './User'
+
+/**
+ * This entity embeds a User and its linked Healthcare Party.
+ */
+export class UserAndHealthcareParty {
+  constructor(json: JSON | any) {
+    Object.assign(this as UserAndHealthcareParty, json)
+  }
+
+  user?: User
+  healthcareParty?: HealthcareParty
+}

package/icc-api/model/UserGroup.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.
+ */
+import { Group } from './Group'
+
+export class UserGroup {
+  constructor(json: JSON | any) {
+    Object.assign(this as UserGroup, json)
+  }
+
+  groupId?: string
+  groupName?: string
+  groupsHierarchy?: Array<Group>
+  userId?: string
+  login?: string
+  name?: string
+  email?: string
+  phone?: string
+  patientId?: string
+  healthcarePartyId?: string
+  deviceId?: string
+  nameOfParentOfTopmostGroupInHierarchy?: string
+}

package/icc-api/model/Valorisation.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 class Valorisation {
+  constructor(json: JSON | any) {
+    Object.assign(this as Valorisation, json)
+  }
+
+  startOfValidity?: number
+  endOfValidity?: number
+  predicate?: string
+  totalAmount?: number
+  reimbursement?: number
+  patientIntervention?: number
+  doctorSupplement?: number
+  vat?: number
+  label?: { [key: string]: string }
+  /**
+   * The base64 encoded data of this object, formatted as JSON and encrypted in AES using the random master key from encryptionKeys.
+   */
+  encryptedSelf?: string
+}

package/icc-api/model/Verse.ts

@@ -0,0 +1,65 @@
+/**
+ * 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.
+ */
+import { AddedDocument } from './AddedDocument'
+
+export class Verse {
+  constructor(json: JSON | any) {
+    Object.assign(this as Verse, json)
+  }
+
+  id?: string
+  rev?: string
+  /**
+   * hard delete (unix epoch in ms) timestamp of the object. Filled automatically when deletePatient is called.
+   */
+  deletionDate?: number
+  chapterName?: string
+  paragraphName?: string
+  verseSeq?: number
+  startDate?: number
+  createdTms?: number
+  createdUserId?: string
+  endDate?: number
+  verseNum?: number
+  verseSeqParent?: number
+  verseLevel?: number
+  verseType?: string
+  checkBoxInd?: string
+  minCheckNum?: number
+  andClauseNum?: number
+  textFr?: string
+  textNl?: string
+  requestType?: string
+  agreementTerm?: number
+  agreementTermUnit?: string
+  maxPackageNumber?: number
+  purchasingAdvisorQualList?: string
+  legalReference?: string
+  modificationDate?: number
+  addedDocuments?: Array<AddedDocument>
+  agreementYearMax?: number
+  agreementRenewalMax?: number
+  sexRestricted?: string
+  minimumAgeAuthorized?: number
+  maximumAgeAuthorized?: number
+  maximumContentQuantity?: number
+  maximumContentUnit?: string
+  maximumStrengthQuantity?: number
+  maximumStrengthUnit?: string
+  maximumDurationQuantity?: number
+  maximumDurationUnit?: string
+  otherAddedDocumentInd?: string
+  minimumAgeAuthorizedUnit?: string
+  maximumAgeAuthorizedUnit?: string
+  modificationStatus?: string
+  children?: Array<Verse>
+}

package/icc-api/model/VirtualForm.ts

@@ -0,0 +1,22 @@
+/**
+ * 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.
+ */
+import { CodeStub } from './CodeStub'
+import { SamText } from './SamText'
+
+export class VirtualForm {
+  constructor(json: JSON | any) {
+    Object.assign(this as VirtualForm, json)
+  }
+
+  name?: SamText
+  standardForms?: Array<CodeStub>
+}