@icure/api 4.1.11 → 4.1.14

package/icc-api/model/Permission.ts

@@ -1,30 +0,0 @@
-/**
- * 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 { PermissionItem } from './PermissionItem'
-
-/**
- * If permission to modify patient data is granted or revoked
- */
-export class Permission {
-  constructor(json: JSON | any) {
-    Object.assign(this as Permission, json)
-  }
-
-  /**
-   * Granted permissions.
-   */
-  grants?: Array<PermissionItem>
-  /**
-   * Revoked permissions.
-   */
-  revokes?: Array<PermissionItem>
-}

package/icc-api/model/PermissionCriterion.ts

@@ -1,46 +0,0 @@
-/**
- * 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 PermissionCriterion {
-  constructor(json: JSON | any) {
-    Object.assign(this as PermissionCriterion, json)
-  }
-
-  negative?: boolean
-  currentUser?: PermissionCriterion.CurrentUserEnum
-  dataType?: PermissionCriterion.DataTypeEnum
-  patientStatus?: string
-}
-export namespace PermissionCriterion {
-  export type CurrentUserEnum =
-    | 'DATA_CREATION_USER'
-    | 'DATA_MODIFICATION_USER'
-    | 'PATIENT_CREATION_USER'
-    | 'PATIENT_MODIFICATION_USER'
-    | 'PATIENT_REFERENCE_HC_USER'
-    | 'PATIENT_HC_TEAM_USER'
-  export const CurrentUserEnum = {
-    DATACREATIONUSER: 'DATA_CREATION_USER' as CurrentUserEnum,
-    DATAMODIFICATIONUSER: 'DATA_MODIFICATION_USER' as CurrentUserEnum,
-    PATIENTCREATIONUSER: 'PATIENT_CREATION_USER' as CurrentUserEnum,
-    PATIENTMODIFICATIONUSER: 'PATIENT_MODIFICATION_USER' as CurrentUserEnum,
-    PATIENTREFERENCEHCUSER: 'PATIENT_REFERENCE_HC_USER' as CurrentUserEnum,
-    PATIENTHCTEAMUSER: 'PATIENT_HC_TEAM_USER' as CurrentUserEnum,
-  }
-  export type DataTypeEnum = 'ADMINISTRATIVE' | 'HEALTH' | 'SENSITIVE' | 'CONFIDENTIAL'
-  export const DataTypeEnum = {
-    ADMINISTRATIVE: 'ADMINISTRATIVE' as DataTypeEnum,
-    HEALTH: 'HEALTH' as DataTypeEnum,
-    SENSITIVE: 'SENSITIVE' as DataTypeEnum,
-    CONFIDENTIAL: 'CONFIDENTIAL' as DataTypeEnum,
-  }
-}

package/icc-api/model/PermissionItem.ts

@@ -1,51 +0,0 @@
-/**
- * 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 { Predicate } from './Predicate'
-
-/**
- * Revoked permissions.
- */
-export class PermissionItem {
-  constructor(json: JSON | any) {
-    Object.assign(this as PermissionItem, json)
-  }
-
-  type?: PermissionItem.TypeEnum
-  predicate?: Predicate
-}
-export namespace PermissionItem {
-  export type TypeEnum =
-    | 'AUTHENTICATE'
-    | 'ADMIN'
-    | 'PATIENT_VIEW'
-    | 'PATIENT_CREATE'
-    | 'PATIENT_CHANGE_DELETE'
-    | 'MEDICAL_DATA_VIEW'
-    | 'MEDICAL_DATA_CREATE'
-    | 'MEDICAL_CHANGE_DELETE'
-    | 'FINANCIAL_DATA_VIEW'
-    | 'FINANCIAL_DATA_CREATE'
-    | 'FINANCIAL_CHANGE_DELETE'
-  export const TypeEnum = {
-    AUTHENTICATE: 'AUTHENTICATE' as TypeEnum,
-    ADMIN: 'ADMIN' as TypeEnum,
-    PATIENTVIEW: 'PATIENT_VIEW' as TypeEnum,
-    PATIENTCREATE: 'PATIENT_CREATE' as TypeEnum,
-    PATIENTCHANGEDELETE: 'PATIENT_CHANGE_DELETE' as TypeEnum,
-    MEDICALDATAVIEW: 'MEDICAL_DATA_VIEW' as TypeEnum,
-    MEDICALDATACREATE: 'MEDICAL_DATA_CREATE' as TypeEnum,
-    MEDICALCHANGEDELETE: 'MEDICAL_CHANGE_DELETE' as TypeEnum,
-    FINANCIALDATAVIEW: 'FINANCIAL_DATA_VIEW' as TypeEnum,
-    FINANCIALDATACREATE: 'FINANCIAL_DATA_CREATE' as TypeEnum,
-    FINANCIALCHANGEDELETE: 'FINANCIAL_CHANGE_DELETE' as TypeEnum,
-  }
-}

package/icc-api/model/PersonName.ts

@@ -1,66 +0,0 @@
-/**
- * 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.
- */
-
-/**
- * Non preferred name information of a person
- */
-export class PersonName {
-  constructor(json: JSON | any) {
-    Object.assign(this as PersonName, json)
-  }
-
-  /**
-   * Family name (often called 'Surname')
-   */
-  lastName?: string
-  /**
-   * Given names (not always 'first'). Includes middle names. This repeating element order: Given Names appear in the correct order for presenting the name
-   */
-  firstNames?: Array<string>
-  /**
-   * Starting date of time period when name is/was valid for use. Date encoded as a fuzzy date on 8 positions (YYYYMMDD)
-   */
-  start?: number
-  /**
-   * Ending date of time period when name is/was valid for use. Date encoded as a fuzzy date on 8 positions (YYYYMMDD)
-   */
-  end?: number
-  /**
-   * Parts that come before the name. This repeating element order: Prefixes appear in the correct order for presenting the name
-   */
-  prefix?: Array<string>
-  /**
-   * Parts that come after the name. This repeating element order: Suffixes appear in the correct order for presenting the name
-   */
-  suffix?: Array<string>
-  /**
-   * Text representation of the full name
-   */
-  text?: string
-  /**
-   * What is the use of this name
-   */
-  use?: PersonName.UseEnum
-}
-export namespace PersonName {
-  export type UseEnum = 'usual' | 'official' | 'temp' | 'nickname' | 'anonymous' | 'maiden' | 'old' | 'other'
-  export const UseEnum = {
-    Usual: 'usual' as UseEnum,
-    Official: 'official' as UseEnum,
-    Temp: 'temp' as UseEnum,
-    Nickname: 'nickname' as UseEnum,
-    Anonymous: 'anonymous' as UseEnum,
-    Maiden: 'maiden' as UseEnum,
-    Old: 'old' as UseEnum,
-    Other: 'other' as UseEnum,
-  }
-}

package/icc-api/model/PharmaceuticalForm.ts

@@ -1,29 +0,0 @@
-/**
- * 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 PharmaceuticalForm {
-  constructor(json: JSON | any) {
-    Object.assign(this as PharmaceuticalForm, json)
-  }
-
-  id?: string
-  rev?: string
-  /**
-   * hard delete (unix epoch in ms) timestamp of the object. Filled automatically when deletePatient is called.
-   */
-  deletionDate?: number
-  code?: string
-  name?: SamText
-  standardForms?: Array<CodeStub>
-}

package/icc-api/model/PharmaceuticalFormStub.ts

@@ -1,24 +0,0 @@
-/**
- * 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 PharmaceuticalFormStub {
-  constructor(json: JSON | any) {
-    Object.assign(this as PharmaceuticalFormStub, json)
-  }
-
-  id?: string
-  code?: string
-  name?: SamText
-  standardForms?: Array<CodeStub>
-}

package/icc-api/model/Place.ts

@@ -1,27 +0,0 @@
-/**
- * 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 { Address } from './Address'
-
-export class Place {
-  constructor(json: JSON | any) {
-    Object.assign(this as Place, json)
-  }
-
-  id?: string
-  rev?: string
-  /**
-   * hard delete (unix epoch in ms) timestamp of the object. Filled automatically when deletePatient is called.
-   */
-  deletionDate?: number
-  name?: string
-  address?: Address
-}

package/icc-api/model/PlanOfAction.ts

@@ -1,114 +0,0 @@
-/**
- * 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 { CareTeamMembership } from './CareTeamMembership'
-import { CodeStub } from './CodeStub'
-
-/**
- * List of healthcare approaches.
- */
-export class PlanOfAction {
-  constructor(json: JSON | any) {
-    Object.assign(this as PlanOfAction, json)
-  }
-
-  id?: 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
-  /**
-   * The id of the hcp who prescribed this healthcare approach
-   */
-  prescriberId?: string
-  /**
-   * The date (unix epoch in ms) when the healthcare approach is noted to have started and also closes on the same date
-   */
-  valueDate?: number
-  /**
-   * The date (unix epoch in ms) of the start of the healthcare approach.
-   */
-  openingDate?: number
-  /**
-   * The date (unix epoch in ms) marking the end of the healthcare approach.
-   */
-  closingDate?: number
-  /**
-   * The date (unix epoch in ms) when the healthcare approach has to be carried out.
-   */
-  deadlineDate?: number
-  /**
-   * The name of the healthcare approach.
-   */
-  name?: string
-  /**
-   * Description of the healthcare approach.
-   */
-  descr?: string
-  /**
-   * Note about the healthcare approach.
-   */
-  note?: string
-  /**
-   * Id of the opening contact when the healthcare approach was created.
-   */
-  idOpeningContact?: string
-  /**
-   * Id of the closing contact for the healthcare approach.
-   */
-  idClosingContact?: string
-  /**
-   * bit 0: active/inactive, bit 1: relevant/irrelevant, bit 2 : present/absent, ex: 0 = active,relevant and present
-   */
-  status?: number
-  documentIds?: Array<string>
-  /**
-   * The number of individual cares already performed in the course of this healthcare approach
-   */
-  numberOfCares?: number
-  /**
-   * Members of the careteam involved in this approach
-   */
-  careTeamMemberships?: Array<CareTeamMembership>
-  relevant?: boolean
-  /**
-   * 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/Predicate.ts

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

package/icc-api/model/Pricing.ts

@@ -1,21 +0,0 @@
-/**
- * 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 { SamText } from './SamText'
-
-export class Pricing {
-  constructor(json: JSON | any) {
-    Object.assign(this as Pricing, json)
-  }
-
-  quantity?: number
-  label?: SamText
-}

package/icc-api/model/PropertyStub.ts

@@ -1,31 +0,0 @@
-/**
- * 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 { PropertyTypeStub } from './PropertyTypeStub'
-import { TypedValueObject } from './TypedValueObject'
-
-/**
- * Extra properties
- */
-export class PropertyStub {
-  constructor(json: JSON | any) {
-    Object.assign(this as PropertyStub, json)
-  }
-
-  id?: string
-  type?: PropertyTypeStub
-  typedValue?: TypedValueObject
-  deletionDate?: number
-  /**
-   * 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/PropertyTypeStub.ts

@@ -1,32 +0,0 @@
-/**
- * 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 PropertyTypeStub {
-  constructor(json: JSON | any) {
-    Object.assign(this as PropertyTypeStub, json)
-  }
-
-  identifier?: string
-  type?: PropertyTypeStub.TypeEnum
-}
-export namespace PropertyTypeStub {
-  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/PublicKey.ts

@@ -1,20 +0,0 @@
-/**
- * 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 PublicKey {
-  constructor(json: JSON | any) {
-    Object.assign(this as PublicKey, json)
-  }
-
-  hcPartyId?: string
-  hexString?: string
-}

package/icc-api/model/Quantity.ts

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

package/icc-api/model/Receipt.ts

@@ -1,83 +0,0 @@
-/**
- * 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'
-
-export class Receipt {
-  constructor(json: JSON | any) {
-    Object.assign(this as Receipt, 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
-  attachmentIds?: { [key: string]: string }
-  references?: Array<string>
-  documentId?: string
-  category?: string
-  subCategory?: 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 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/ReferralPeriod.ts

@@ -1,33 +0,0 @@
-/**
- * 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.
- */
-
-/**
- * Time periods
- */
-export class ReferralPeriod {
-  constructor(json: JSON | any) {
-    Object.assign(this as ReferralPeriod, json)
-  }
-
-  /**
-   * The date (unix epoch in ms) when the referral period initiated, will be filled instantaneously.
-   */
-  startDate?: number
-  /**
-   * The date (unix epoch in ms) the referral period ended, will be instantaneously filled.
-   */
-  endDate?: number
-  /**
-   * Comments made during the referral.
-   */
-  comment?: string
-}