@icure/cardinal-sdk 3.0.0-PREVIEW-4 → 3.0.0-PREVIEW.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (293) hide show
  1. package/Kotlin-DateTime-library-kotlinx-datetime.mjs +1 -1
  2. package/api/CalendarItemApi.d.mts +20 -0
  3. package/api/CalendarItemBasicApi.d.mts +20 -0
  4. package/api/ContactApi.d.mts +20 -0
  5. package/api/ContactBasicApi.d.mts +20 -0
  6. package/api/DeviceApi.d.mts +20 -0
  7. package/api/HealthElementApi.d.mts +20 -0
  8. package/api/HealthElementBasicApi.d.mts +20 -0
  9. package/api/HealthcarePartyApi.d.mts +20 -0
  10. package/api/MaintenanceTaskApi.d.mts +20 -0
  11. package/api/MaintenanceTaskBasicApi.d.mts +20 -0
  12. package/api/MessageApi.d.mts +20 -0
  13. package/api/MessageBasicApi.d.mts +20 -0
  14. package/api/PatientApi.d.mts +20 -0
  15. package/api/PatientBasicApi.d.mts +20 -0
  16. package/api/RelatedPersonApi.d.mts +20 -0
  17. package/api/TopicApi.d.mts +20 -0
  18. package/api/TopicBasicApi.d.mts +20 -0
  19. package/api/UserApi.d.mts +20 -0
  20. package/cardinal-sdk-ts.mjs +43373 -43280
  21. package/cardinal-sdk.mjs +84479 -82911
  22. package/kotlin-kotlin-stdlib.mjs +6 -6
  23. package/kotlinx-coroutines-core.mjs +1 -1
  24. package/kotlinx-serialization-kotlinx-serialization-json.mjs +12 -0
  25. package/model/AccessLog.d.mts +7 -14
  26. package/model/AccessLog.mjs +6 -12
  27. package/model/Agenda.d.mts +3 -6
  28. package/model/Agenda.mjs +3 -6
  29. package/model/CalendarItem.d.mts +8 -16
  30. package/model/CalendarItem.mjs +6 -12
  31. package/model/CalendarItemOccupancy.d.mts +2 -4
  32. package/model/CalendarItemOccupancy.mjs +2 -4
  33. package/model/CalendarItemType.d.mts +2 -4
  34. package/model/CalendarItemType.mjs +2 -4
  35. package/model/Classification.d.mts +5 -10
  36. package/model/Classification.mjs +4 -8
  37. package/model/Code.d.mts +1 -2
  38. package/model/Code.mjs +1 -2
  39. package/model/Contact.d.mts +34 -71
  40. package/model/Contact.mjs +26 -54
  41. package/model/CryptoActorStub.d.mts +1 -2
  42. package/model/CryptoActorStub.mjs +1 -2
  43. package/model/DataOwnerRegistrationSuccess.d.mts +1 -2
  44. package/model/DataOwnerRegistrationSuccess.mjs +1 -2
  45. package/model/DataOwnerType.d.mts +1 -2
  46. package/model/DataOwnerType.mjs +1 -2
  47. package/model/Device.d.mts +1 -2
  48. package/model/Device.mjs +1 -2
  49. package/model/Document.d.mts +3 -6
  50. package/model/Document.mjs +2 -4
  51. package/model/FrontEndMigration.d.mts +2 -4
  52. package/model/FrontEndMigration.mjs +2 -4
  53. package/model/Group.d.mts +9 -2
  54. package/model/Group.mjs +14 -2
  55. package/model/HealthElement.d.mts +20 -40
  56. package/model/HealthElement.mjs +14 -28
  57. package/model/HealthcareParty.d.mts +4 -9
  58. package/model/HealthcareParty.mjs +4 -9
  59. package/model/IndexingInfo.d.mts +1 -2
  60. package/model/IndexingInfo.mjs +1 -2
  61. package/model/Insurance.d.mts +1 -2
  62. package/model/Insurance.mjs +1 -2
  63. package/model/Invoice.d.mts +3 -6
  64. package/model/Invoice.mjs +2 -4
  65. package/model/MaintenanceTask.d.mts +8 -16
  66. package/model/MaintenanceTask.mjs +6 -12
  67. package/model/Message.d.mts +3 -6
  68. package/model/Message.mjs +2 -4
  69. package/model/PaginatedDocumentKeyIdPair.d.mts +1 -2
  70. package/model/PaginatedDocumentKeyIdPair.mjs +1 -2
  71. package/model/PaginatedList.d.mts +2 -4
  72. package/model/PaginatedList.mjs +2 -4
  73. package/model/PaginationError.d.mts +2 -4
  74. package/model/PaginationError.mjs +1 -2
  75. package/model/Patient.d.mts +6 -12
  76. package/model/Patient.mjs +4 -8
  77. package/model/PropertyTypeStub.d.mts +1 -2
  78. package/model/PropertyTypeStub.mjs +1 -2
  79. package/model/Receipt.d.mts +6 -12
  80. package/model/Receipt.mjs +4 -8
  81. package/model/RelatedPerson.d.mts +8 -18
  82. package/model/RelatedPerson.mjs +6 -14
  83. package/model/Role.d.mts +4 -8
  84. package/model/Role.mjs +4 -8
  85. package/model/Topic.d.mts +3 -6
  86. package/model/Topic.mjs +2 -4
  87. package/model/User.d.mts +2 -4
  88. package/model/User.mjs +2 -4
  89. package/model/base/CodeStub.d.mts +1 -2
  90. package/model/base/CodeStub.mjs +1 -2
  91. package/model/base/CryptoActor.d.mts +37 -74
  92. package/model/base/DataOwner.d.mts +1 -2
  93. package/model/base/DataOwnerGroupLink.d.mts +2 -4
  94. package/model/base/DataOwnerGroupLink.mjs +2 -4
  95. package/model/base/DataOwnerGroupLinkType.d.mts +1 -2
  96. package/model/base/DataOwnerGroupLinkType.mjs +1 -2
  97. package/model/base/DataOwnerHierarchyInfo.d.mts +2 -4
  98. package/model/base/DataOwnerHierarchyInfo.mjs +2 -4
  99. package/model/base/HasCodes.d.mts +1 -2
  100. package/model/base/HasEncryptionMetadata.d.mts +1 -2
  101. package/model/base/HasIdentifier.d.mts +1 -2
  102. package/model/base/HasTags.d.mts +1 -2
  103. package/model/base/ICureDocument.d.mts +1 -2
  104. package/model/base/LinkQualification.d.mts +7 -17
  105. package/model/base/LinkQualification.mjs +7 -17
  106. package/model/base/StoredDocument.d.mts +1 -2
  107. package/model/couchdb/Basic.d.mts +1 -2
  108. package/model/couchdb/Basic.mjs +1 -2
  109. package/model/couchdb/DatabaseInfo.d.mts +1 -2
  110. package/model/couchdb/DatabaseInfo.mjs +1 -2
  111. package/model/couchdb/DesignDocument.d.mts +1 -2
  112. package/model/couchdb/DesignDocument.mjs +1 -2
  113. package/model/couchdb/GroupDatabasesInfo.d.mts +1 -2
  114. package/model/couchdb/GroupDatabasesInfo.mjs +1 -2
  115. package/model/couchdb/Remote.d.mts +1 -2
  116. package/model/couchdb/Remote.mjs +1 -2
  117. package/model/couchdb/ReplicatorDocument.d.mts +1 -2
  118. package/model/couchdb/ReplicatorDocument.mjs +1 -2
  119. package/model/data/LabelledOccurence.d.mts +1 -2
  120. package/model/data/LabelledOccurence.mjs +1 -2
  121. package/model/embed/AdministrationQuantity.d.mts +1 -2
  122. package/model/embed/AdministrationQuantity.mjs +1 -2
  123. package/model/embed/AgendaSlottingAlgorithm.d.mts +1 -2
  124. package/model/embed/AgendaSlottingAlgorithm.mjs +1 -2
  125. package/model/embed/Annotation.d.mts +6 -12
  126. package/model/embed/Annotation.mjs +4 -8
  127. package/model/embed/AsserterType.d.mts +6 -12
  128. package/model/embed/AsserterType.mjs +6 -12
  129. package/model/embed/CareTeamMember.d.mts +3 -6
  130. package/model/embed/CareTeamMember.mjs +2 -4
  131. package/model/embed/CareTeamMembership.d.mts +3 -6
  132. package/model/embed/CareTeamMembership.mjs +2 -4
  133. package/model/embed/Content.d.mts +3 -6
  134. package/model/embed/Content.mjs +2 -4
  135. package/model/embed/DataAttachment.d.mts +5 -10
  136. package/model/embed/DataAttachment.mjs +5 -10
  137. package/model/embed/DatabaseSynchronization.d.mts +1 -2
  138. package/model/embed/DatabaseSynchronization.mjs +1 -2
  139. package/model/embed/DeletedAttachment.d.mts +2 -4
  140. package/model/embed/DeletedAttachment.mjs +2 -4
  141. package/model/embed/DocumentStatus.d.mts +1 -2
  142. package/model/embed/DocumentStatus.mjs +1 -2
  143. package/model/embed/EmbeddedTimeTableItem.d.mts +1 -2
  144. package/model/embed/EmbeddedTimeTableItem.mjs +1 -2
  145. package/model/embed/Encryptable.d.mts +1 -2
  146. package/model/embed/Episode.d.mts +3 -6
  147. package/model/embed/Episode.mjs +2 -4
  148. package/model/embed/FinancialInstitutionInformation.d.mts +3 -6
  149. package/model/embed/FinancialInstitutionInformation.mjs +2 -4
  150. package/model/embed/Gender.d.mts +1 -2
  151. package/model/embed/Gender.mjs +1 -2
  152. package/model/embed/GroupStatus.d.mts +10 -0
  153. package/model/embed/GroupStatus.mjs +12 -0
  154. package/model/embed/HealthElementAsserter.d.mts +23 -46
  155. package/model/embed/HealthElementAsserter.mjs +20 -40
  156. package/model/embed/HealthElementQualifiedLink.d.mts +2 -4
  157. package/model/embed/HealthElementQualifiedLink.mjs +1 -2
  158. package/model/embed/InvoicingCode.d.mts +18 -6
  159. package/model/embed/InvoicingCode.mjs +22 -4
  160. package/model/embed/Measure.d.mts +1 -2
  161. package/model/embed/Measure.mjs +1 -2
  162. package/model/embed/MedicalHouseContract.d.mts +3 -6
  163. package/model/embed/MedicalHouseContract.mjs +2 -4
  164. package/model/embed/MessageReadStatus.d.mts +1 -2
  165. package/model/embed/MessageReadStatus.mjs +1 -2
  166. package/model/embed/MhcSignatureType.d.mts +1 -2
  167. package/model/embed/MhcSignatureType.mjs +1 -2
  168. package/model/embed/PartnerType.d.mts +1 -2
  169. package/model/embed/PartnerType.mjs +1 -2
  170. package/model/embed/Partnership.d.mts +6 -12
  171. package/model/embed/Partnership.mjs +4 -8
  172. package/model/embed/PartnershipType.d.mts +1 -2
  173. package/model/embed/PartnershipType.mjs +1 -2
  174. package/model/embed/PersonName.d.mts +1 -2
  175. package/model/embed/PersonName.mjs +1 -2
  176. package/model/embed/ReceiptBlobType.d.mts +1 -2
  177. package/model/embed/ReceiptBlobType.mjs +1 -2
  178. package/model/embed/ReferenceRange.d.mts +1 -2
  179. package/model/embed/ReferenceRange.mjs +1 -2
  180. package/model/embed/RegimenItem.d.mts +2 -4
  181. package/model/embed/RegimenItem.mjs +2 -4
  182. package/model/embed/Renewal.d.mts +1 -2
  183. package/model/embed/Renewal.mjs +1 -2
  184. package/model/embed/ResourceGroupAllocationSchedule.d.mts +1 -2
  185. package/model/embed/ResourceGroupAllocationSchedule.mjs +1 -2
  186. package/model/embed/RoleConfiguration.d.mts +1 -2
  187. package/model/embed/RoleConfiguration.mjs +1 -2
  188. package/model/embed/SecureDelegation.d.mts +2 -4
  189. package/model/embed/SecureDelegation.mjs +2 -4
  190. package/model/embed/SecurityMetadata.d.mts +1 -2
  191. package/model/embed/Service.d.mts +35 -70
  192. package/model/embed/Service.mjs +26 -52
  193. package/model/embed/TelecomType.d.mts +1 -2
  194. package/model/embed/TelecomType.mjs +1 -2
  195. package/model/embed/TimeSeries.d.mts +1 -2
  196. package/model/embed/TimeSeries.mjs +1 -2
  197. package/model/embed/TypedValue.d.mts +3 -6
  198. package/model/embed/TypedValue.mjs +2 -4
  199. package/model/embed/UserAccessLevel.d.mts +2 -4
  200. package/model/embed/UserAccessLevel.mjs +2 -4
  201. package/model/embed/form/template/Action.d.mts +1 -2
  202. package/model/embed/form/template/Action.mjs +1 -2
  203. package/model/embed/form/template/Field.d.mts +2 -4
  204. package/model/embed/form/template/FieldsGroup.d.mts +1 -2
  205. package/model/embed/form/template/FieldsGroup.mjs +1 -2
  206. package/model/embed/form/template/FormTemplateLayout.d.mts +1 -2
  207. package/model/embed/form/template/FormTemplateLayout.mjs +1 -2
  208. package/model/embed/form/template/Launcher.d.mts +1 -2
  209. package/model/embed/form/template/Launcher.mjs +1 -2
  210. package/model/embed/form/template/Section.d.mts +1 -2
  211. package/model/embed/form/template/Section.mjs +1 -2
  212. package/model/embed/form/template/StructureElement.d.mts +1 -2
  213. package/model/filter/predicate/Predicate.d.mts +1 -2
  214. package/model/security/AlwaysPermissionItem.d.mts +1 -2
  215. package/model/security/AlwaysPermissionItem.mjs +1 -2
  216. package/model/security/AuthenticationToken.d.mts +1 -2
  217. package/model/security/AuthenticationToken.mjs +1 -2
  218. package/model/security/ExternalJwtConfig.d.mts +3 -6
  219. package/model/security/ExternalJwtConfig.mjs +2 -4
  220. package/model/security/LoginIdentifier.d.mts +1 -2
  221. package/model/security/LoginIdentifier.mjs +1 -2
  222. package/model/security/OperationToken.d.mts +1 -2
  223. package/model/security/OperationToken.mjs +1 -2
  224. package/model/security/PermissionItem.d.mts +1 -2
  225. package/model/security/PermissionType.d.mts +1 -2
  226. package/model/security/PermissionType.mjs +1 -2
  227. package/model.d.mts +1 -0
  228. package/model.mjs +1 -0
  229. package/options/SdkOptions.d.mts +67 -0
  230. package/options/SdkOptions.mjs +27 -1
  231. package/package.json +1 -1
  232. package/api/ApplicationSettingsApi.d.mts +0 -6
  233. package/api/ApplicationSettingsApi.mjs +0 -1
  234. package/api/DocumentTemplateApi.d.mts +0 -22
  235. package/api/DocumentTemplateApi.mjs +0 -1
  236. package/api/EntityReferenceApi.d.mts +0 -5
  237. package/api/EntityReferenceApi.mjs +0 -1
  238. package/api/EntityTemplateApi.d.mts +0 -24
  239. package/api/EntityTemplateApi.mjs +0 -1
  240. package/api/KeywordApi.d.mts +0 -14
  241. package/api/KeywordApi.mjs +0 -1
  242. package/api/MedicalLocationApi.d.mts +0 -17
  243. package/api/MedicalLocationApi.mjs +0 -1
  244. package/api/TarificationApi.d.mts +0 -27
  245. package/api/TarificationApi.mjs +0 -1
  246. package/api/TimeTableApi.d.mts +0 -26
  247. package/api/TimeTableApi.mjs +0 -1
  248. package/crypto/entities/DelegateShareOptions.d.mts +0 -9
  249. package/crypto/entities/DelegateShareOptions.mjs +0 -8
  250. package/crypto/entities/ShareAllPatientDataOptions.d.mts +0 -49
  251. package/crypto/entities/ShareAllPatientDataOptions.mjs +0 -58
  252. package/filters/ClassificationFilters.d.mts +0 -27
  253. package/filters/ClassificationFilters.mjs +0 -8
  254. package/filters/MedicalLocationFilters.d.mts +0 -8
  255. package/filters/MedicalLocationFilters.mjs +0 -6
  256. package/filters/TimeTableFilters.d.mts +0 -12
  257. package/filters/TimeTableFilters.mjs +0 -6
  258. package/model/ApplicationSettings.d.mts +0 -87
  259. package/model/ApplicationSettings.mjs +0 -256
  260. package/model/DocumentTemplate.d.mts +0 -35
  261. package/model/DocumentTemplate.mjs +0 -162
  262. package/model/EntityReference.d.mts +0 -10
  263. package/model/EntityReference.mjs +0 -46
  264. package/model/EntityTemplate.d.mts +0 -16
  265. package/model/EntityTemplate.mjs +0 -81
  266. package/model/Keyword.d.mts +0 -23
  267. package/model/Keyword.mjs +0 -99
  268. package/model/ListOfIds.d.mts +0 -6
  269. package/model/ListOfIds.mjs +0 -28
  270. package/model/MedicalLocation.d.mts +0 -28
  271. package/model/MedicalLocation.mjs +0 -116
  272. package/model/Tarification.d.mts +0 -50
  273. package/model/Tarification.mjs +0 -178
  274. package/model/TimeTable.d.mts +0 -25
  275. package/model/TimeTable.mjs +0 -111
  276. package/model/base/AppendixType.d.mts +0 -5
  277. package/model/base/AppendixType.mjs +0 -7
  278. package/model/base/CodeFlag.d.mts +0 -80
  279. package/model/base/CodeFlag.mjs +0 -82
  280. package/model/base/ReportVersion.d.mts +0 -3
  281. package/model/base/ReportVersion.mjs +0 -5
  282. package/model/embed/KeywordSubword.d.mts +0 -8
  283. package/model/embed/KeywordSubword.mjs +0 -35
  284. package/model/embed/LetterValue.d.mts +0 -9
  285. package/model/embed/LetterValue.mjs +0 -47
  286. package/model/embed/Periodicity.d.mts +0 -8
  287. package/model/embed/Periodicity.mjs +0 -36
  288. package/model/embed/TimeTableHour.d.mts +0 -7
  289. package/model/embed/TimeTableHour.mjs +0 -35
  290. package/model/embed/TimeTableItem.d.mts +0 -19
  291. package/model/embed/TimeTableItem.mjs +0 -96
  292. package/model/embed/Valorisation.d.mts +0 -56
  293. package/model/embed/Valorisation.mjs +0 -188
@@ -8,8 +8,7 @@ import { Versionable } from './Versionable.mjs';
8
8
  *
9
9
  *
10
10
  * Interface for entities that participate in the iCure end-to-end encryption system.
11
- * A CryptoActor holds the cryptographic keys and key exchange material needed for secure data
12
- * sharing.
11
+ * A CryptoActor holds the cryptographic keys and key exchange material needed for secure data sharing.
13
12
  */
14
13
  export interface CryptoActor extends Versionable<string> {
15
14
  hcPartyKeys: {
@@ -35,149 +34,113 @@ export interface CryptoActor extends Versionable<string> {
35
34
  /**
36
35
  *
37
36
  *
38
- * The links to the data owners representing the organizations, administrative units or other
39
- * loose groups of
37
+ * The links to the data owners representing the organizations, administrative units or other loose groups of
40
38
  * healthcare parties this crypto actor belongs to.
41
- * There are different types of links, which have different implication on access control and
42
- * requirements for
39
+ * There are different types of links, which have different implication on access control and requirements for
43
40
  * sharing data among all members of the group.
44
41
  *
45
- * This list should be considered as unordered, and it may not contain two links pointing to the
46
- * same data owner,
42
+ * This list should be considered as unordered, and it may not contain two links pointing to the same data owner,
47
43
  * regardless of type.
48
44
  *
49
45
  * # Membership propagation
50
46
  *
51
- * All links are transitive, whatever their type: every directly linked group is a group of the
52
- * actor, and the groups
53
- * of a group are also groups of the actor (applied recursively). An actor is therefore a member
54
- * of every group
47
+ * All links are transitive, whatever their type: every directly linked group is a group of the actor, and the groups
48
+ * of a group are also groups of the actor (applied recursively). An actor is therefore a member of every group
55
49
  * reachable through a path of links.
56
50
  *
57
- * For example with `hcp -parent-> department -simple-> building -simple-> campus`: the groups of
58
- * `hcp` are
51
+ * For example with `hcp -parent-> department -simple-> building -simple-> campus`: the groups of `hcp` are
59
52
  * `department`, `building` and `campus`.
60
53
  *
61
- * There may however be restrictions in place on how propagation when the link type changes:
62
- * propagation from a
54
+ * There may however be restrictions in place on how propagation when the link type changes: propagation from a
63
55
  * parent link to a simple link is allowed, but the opposite is not.
64
- * A group membership such as `hcp -parent-> department -simple-> building -parent-> campus` is
65
- * not allowed: while
66
- * the relationships of `building` are technically valid the full membership for `department` or
67
- * `hcp` is invalid,
56
+ * A group membership such as `hcp -parent-> department -simple-> building -parent-> campus` is not allowed: while
57
+ * the relationships of `building` are technically valid the full membership for `department` or `hcp` is invalid,
68
58
  * and a user associated with a data owner that has invalid membership is not allowed to login.
69
59
  *
70
60
  * # Why groups instead of direct sharing with members
71
61
  *
72
- * By using groups of data owners instead of directly sharing data with each data owner in a group
73
- * you gain two
62
+ * By using groups of data owners instead of directly sharing data with each data owner in a group you gain two
74
63
  * major advantages:
75
64
  * - Reduced size of metadata on entities
76
- * - Possibility of dynamically adding peoples to a group without having to update all the
77
- * entities that they should
65
+ * - Possibility of dynamically adding peoples to a group without having to update all the entities that they should
78
66
  * be able to access
79
67
  *
80
- * In a full-scale system where data is massively shared between groups of users using data owner
81
- * groups is the
68
+ * In a full-scale system where data is massively shared between groups of users using data owner groups is the
82
69
  * only realistic choice available.
83
70
  */
84
71
  dataOwnerGroups: Array<DataOwnerGroupLink>;
85
72
  /**
86
73
  *
87
- * The links to the data owners representing the organizations, administrative units or other loose
88
- * groups of
74
+ * The links to the data owners representing the organizations, administrative units or other loose groups of
89
75
  * healthcare parties this crypto actor belongs to.
90
- * There are different types of links, which have different implication on access control and
91
- * requirements for
76
+ * There are different types of links, which have different implication on access control and requirements for
92
77
  * sharing data among all members of the group.
93
78
  *
94
- * This list should be considered as unordered, and it may not contain two links pointing to the
95
- * same data owner,
79
+ * This list should be considered as unordered, and it may not contain two links pointing to the same data owner,
96
80
  * regardless of type.
97
81
  *
98
82
  * # Membership propagation
99
83
  *
100
- * All links are transitive, whatever their type: every directly linked group is a group of the
101
- * actor, and the groups
102
- * of a group are also groups of the actor (applied recursively). An actor is therefore a member of
103
- * every group
84
+ * All links are transitive, whatever their type: every directly linked group is a group of the actor, and the groups
85
+ * of a group are also groups of the actor (applied recursively). An actor is therefore a member of every group
104
86
  * reachable through a path of links.
105
87
  *
106
- * For example with `hcp -parent-> department -simple-> building -simple-> campus`: the groups of
107
- * `hcp` are
88
+ * For example with `hcp -parent-> department -simple-> building -simple-> campus`: the groups of `hcp` are
108
89
  * `department`, `building` and `campus`.
109
90
  *
110
- * There may however be restrictions in place on how propagation when the link type changes:
111
- * propagation from a
91
+ * There may however be restrictions in place on how propagation when the link type changes: propagation from a
112
92
  * parent link to a simple link is allowed, but the opposite is not.
113
- * A group membership such as `hcp -parent-> department -simple-> building -parent-> campus` is not
114
- * allowed: while
115
- * the relationships of `building` are technically valid the full membership for `department` or
116
- * `hcp` is invalid,
93
+ * A group membership such as `hcp -parent-> department -simple-> building -parent-> campus` is not allowed: while
94
+ * the relationships of `building` are technically valid the full membership for `department` or `hcp` is invalid,
117
95
  * and a user associated with a data owner that has invalid membership is not allowed to login.
118
96
  *
119
97
  * # Why groups instead of direct sharing with members
120
98
  *
121
- * By using groups of data owners instead of directly sharing data with each data owner in a group
122
- * you gain two
99
+ * By using groups of data owners instead of directly sharing data with each data owner in a group you gain two
123
100
  * major advantages:
124
101
  * - Reduced size of metadata on entities
125
- * - Possibility of dynamically adding peoples to a group without having to update all the entities
126
- * that they should
102
+ * - Possibility of dynamically adding peoples to a group without having to update all the entities that they should
127
103
  * be able to access
128
104
  *
129
- * In a full-scale system where data is massively shared between groups of users using data owner
130
- * groups is the
105
+ * In a full-scale system where data is massively shared between groups of users using data owner groups is the
131
106
  * only realistic choice available.
132
107
  * /
133
108
  */
134
109
  groupLinkType: DataOwnerGroupLinkType | undefined;
135
110
  /**
136
111
  *
137
- * The links to the data owners representing the organizations, administrative units or other loose
138
- * groups of
112
+ * The links to the data owners representing the organizations, administrative units or other loose groups of
139
113
  * healthcare parties this crypto actor belongs to.
140
- * There are different types of links, which have different implication on access control and
141
- * requirements for
114
+ * There are different types of links, which have different implication on access control and requirements for
142
115
  * sharing data among all members of the group.
143
116
  *
144
- * This list should be considered as unordered, and it may not contain two links pointing to the
145
- * same data owner,
117
+ * This list should be considered as unordered, and it may not contain two links pointing to the same data owner,
146
118
  * regardless of type.
147
119
  *
148
120
  * # Membership propagation
149
121
  *
150
- * All links are transitive, whatever their type: every directly linked group is a group of the
151
- * actor, and the groups
152
- * of a group are also groups of the actor (applied recursively). An actor is therefore a member of
153
- * every group
122
+ * All links are transitive, whatever their type: every directly linked group is a group of the actor, and the groups
123
+ * of a group are also groups of the actor (applied recursively). An actor is therefore a member of every group
154
124
  * reachable through a path of links.
155
125
  *
156
- * For example with `hcp -parent-> department -simple-> building -simple-> campus`: the groups of
157
- * `hcp` are
126
+ * For example with `hcp -parent-> department -simple-> building -simple-> campus`: the groups of `hcp` are
158
127
  * `department`, `building` and `campus`.
159
128
  *
160
- * There may however be restrictions in place on how propagation when the link type changes:
161
- * propagation from a
129
+ * There may however be restrictions in place on how propagation when the link type changes: propagation from a
162
130
  * parent link to a simple link is allowed, but the opposite is not.
163
- * A group membership such as `hcp -parent-> department -simple-> building -parent-> campus` is not
164
- * allowed: while
165
- * the relationships of `building` are technically valid the full membership for `department` or
166
- * `hcp` is invalid,
131
+ * A group membership such as `hcp -parent-> department -simple-> building -parent-> campus` is not allowed: while
132
+ * the relationships of `building` are technically valid the full membership for `department` or `hcp` is invalid,
167
133
  * and a user associated with a data owner that has invalid membership is not allowed to login.
168
134
  *
169
135
  * # Why groups instead of direct sharing with members
170
136
  *
171
- * By using groups of data owners instead of directly sharing data with each data owner in a group
172
- * you gain two
137
+ * By using groups of data owners instead of directly sharing data with each data owner in a group you gain two
173
138
  * major advantages:
174
139
  * - Reduced size of metadata on entities
175
- * - Possibility of dynamically adding peoples to a group without having to update all the entities
176
- * that they should
140
+ * - Possibility of dynamically adding peoples to a group without having to update all the entities that they should
177
141
  * be able to access
178
142
  *
179
- * In a full-scale system where data is massively shared between groups of users using data owner
180
- * groups is the
143
+ * In a full-scale system where data is massively shared between groups of users using data owner groups is the
181
144
  * only realistic choice available.
182
145
  * /
183
146
  */
@@ -3,8 +3,7 @@ import { PropertyStub } from '../PropertyStub.mjs';
3
3
  *
4
4
  *
5
5
  * Interface for entities that own and control access to encrypted data in the iCure system.
6
- * Data owners (such as healthcare parties, patients, and devices) can grant access to their data
7
- * through delegations.
6
+ * Data owners (such as healthcare parties, patients, and devices) can grant access to their data through delegations.
8
7
  */
9
8
  export interface DataOwner {
10
9
  properties: Array<PropertyStub>;
@@ -1,10 +1,8 @@
1
1
  /**
2
2
  *
3
3
  *
4
- * A link from a crypto actor to a data owner that represents a group it belongs to. The type of
5
- * the link is not
6
- * declared here: it is intrinsic to the linked data owner itself, see
7
- * [CryptoActorDto.groupLinkType].
4
+ * A link from a crypto actor to a data owner that represents a group it belongs to. The type of the link is not
5
+ * declared here: it is intrinsic to the linked data owner itself, see [CryptoActorDto.groupLinkType].
8
6
  */
9
7
  export declare class DataOwnerGroupLink {
10
8
  /**
@@ -3,10 +3,8 @@ import { expectString, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
3
3
  /**
4
4
  *
5
5
  *
6
- * A link from a crypto actor to a data owner that represents a group it belongs to. The type of
7
- * the link is not
8
- * declared here: it is intrinsic to the linked data owner itself, see
9
- * [CryptoActorDto.groupLinkType].
6
+ * A link from a crypto actor to a data owner that represents a group it belongs to. The type of the link is not
7
+ * declared here: it is intrinsic to the linked data owner itself, see [CryptoActorDto.groupLinkType].
10
8
  */
11
9
  export class DataOwnerGroupLink {
12
10
  constructor(partial) {
@@ -3,8 +3,7 @@
3
3
  *
4
4
  * The nature of the link between a crypto actor and a data owner representing one of its groups.
5
5
  *
6
- * This is intrinsic to the *target* of the link (see [CryptoActorDto.groupLinkType]): every link
7
- * pointing at a
6
+ * This is intrinsic to the *target* of the link (see [CryptoActorDto.groupLinkType]): every link pointing at a
8
7
  * given data owner has the same type, whoever declares it.
9
8
  */
10
9
  export declare enum DataOwnerGroupLinkType {
@@ -4,8 +4,7 @@
4
4
  *
5
5
  * The nature of the link between a crypto actor and a data owner representing one of its groups.
6
6
  *
7
- * This is intrinsic to the *target* of the link (see [CryptoActorDto.groupLinkType]): every link
8
- * pointing at a
7
+ * This is intrinsic to the *target* of the link (see [CryptoActorDto.groupLinkType]): every link pointing at a
9
8
  * given data owner has the same type, whoever declares it.
10
9
  */
11
10
  export var DataOwnerGroupLinkType;
@@ -20,10 +20,8 @@ export declare class DataOwnerHierarchyInfo {
20
20
  /**
21
21
  *
22
22
  *
23
- * One node for each group the data owner is directly linked to, through the legacy parentId or a
24
- * dataOwnerGroups
25
- * link, in the declaration order of the links. A group reachable through multiple paths appears
26
- * in each path.
23
+ * One node for each group the data owner is directly linked to, through the legacy parentId or a dataOwnerGroups
24
+ * link, in the declaration order of the links. A group reachable through multiple paths appears in each path.
27
25
  */
28
26
  links: Array<DataOwnerHierarchyInfo.HierarchyNode>;
29
27
  constructor(partial: Partial<DataOwnerHierarchyInfo> & Pick<DataOwnerHierarchyInfo, "dataOwnerType">);
@@ -14,10 +14,8 @@ export class DataOwnerHierarchyInfo {
14
14
  /**
15
15
  *
16
16
  *
17
- * One node for each group the data owner is directly linked to, through the legacy parentId or a
18
- * dataOwnerGroups
19
- * link, in the declaration order of the links. A group reachable through multiple paths appears
20
- * in each path.
17
+ * One node for each group the data owner is directly linked to, through the legacy parentId or a dataOwnerGroups
18
+ * link, in the declaration order of the links. A group reachable through multiple paths appears in each path.
21
19
  */
22
20
  this.links = [];
23
21
  this.id = (_a = partial.id) !== null && _a !== void 0 ? _a : randomUuid();
@@ -2,8 +2,7 @@ import { CodeStub } from './CodeStub.mjs';
2
2
  /**
3
3
  *
4
4
  *
5
- * Interface for entities that can be qualified with codes from codification systems such as
6
- * SNOMED-CT, ICPC-2, or ICD-10.
5
+ * Interface for entities that can be qualified with codes from codification systems such as SNOMED-CT, ICPC-2, or ICD-10.
7
6
  */
8
7
  export interface HasCodes {
9
8
  codes: Array<CodeStub>;
@@ -4,8 +4,7 @@ import { Versionable } from './Versionable.mjs';
4
4
  /**
5
5
  *
6
6
  *
7
- * Interface for entities that hold encryption metadata used for end-to-end encryption and access
8
- * control.
7
+ * Interface for entities that hold encryption metadata used for end-to-end encryption and access control.
9
8
  * This includes delegation keys, encrypted foreign keys, and security metadata.
10
9
  */
11
10
  export interface HasEncryptionMetadata extends Versionable<string> {
@@ -2,8 +2,7 @@ import { Identifier } from './Identifier.mjs';
2
2
  /**
3
3
  *
4
4
  *
5
- * Interface for entities that can be identified uniquely and unambiguously by a set of
6
- * identifiers.
5
+ * Interface for entities that can be identified uniquely and unambiguously by a set of identifiers.
7
6
  */
8
7
  export interface HasIdentifier {
9
8
  identifier: Array<Identifier>;
@@ -2,8 +2,7 @@ import { CodeStub } from './CodeStub.mjs';
2
2
  /**
3
3
  *
4
4
  *
5
- * Interface for entities that can be classified using tags from codification systems such as
6
- * LOINC.
5
+ * Interface for entities that can be classified using tags from codification systems such as LOINC.
7
6
  * Tags qualify an entity as belonging to a certain class regardless of its value.
8
7
  */
9
8
  export interface HasTags {
@@ -5,8 +5,7 @@ import { Identifiable } from './Identifiable.mjs';
5
5
  *
6
6
  *
7
7
  * Interface for iCure document entities that track creation and modification metadata.
8
- * Extends [IdentifiableDto], [HasTagsDto], and [HasCodesDto] to provide a common base for all
9
- * medical documents.
8
+ * Extends [IdentifiableDto], [HasTagsDto], and [HasCodesDto] to provide a common base for all medical documents.
10
9
  */
11
10
  export interface ICureDocument<T> extends Identifiable<T>, HasTags, HasCodes {
12
11
  created: number | undefined;
@@ -5,29 +5,19 @@
5
5
  *
6
6
  * - [narrower] means that the linked codes have a narrower interpretation
7
7
  * - [parent] means that the linked code(s) is the parent of this code
8
- * - [sequence] means that the linked codes are a sequence of codes that are part of the current
9
- * code
10
- * - [basedOn] means a plan, proposal or order that is fulfilled in whole or in part by this event.
11
- * For example, a MedicationRequest may require a patient to have laboratory test performed before it
12
- * is dispensed.
13
- * - [derivedFrom] means the target resource that represents a measurement from which the service
14
- * value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound
15
- * image.
8
+ * - [sequence] means that the linked codes are a sequence of codes that are part of the current code
9
+ * - [basedOn] means a plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.
10
+ * - [derivedFrom] means the target resource that represents a measurement from which the service value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.
16
11
  * - [device] means the device used to generate the service data
17
- * - [focus] means the actual focus of a service when it is not the patient of record representing
18
- * something or someone associated with the patient such as a spouse, parent, fetus, or donor. For
19
- * example, fetus observations in a mother's record.
20
- * - [hasMember] means this service is a group service (e.g. a battery, a panel of tests, a set of
21
- * vital sign measurements) that includes the target as a member of the group
12
+ * - [focus] means the actual focus of a service when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record.
13
+ * - [hasMember] means this service is a group service (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group
22
14
  * - [performer] means who was responsible for asserting the observed value as "true".
23
15
  * - [specimen] means the specimen that was used when this service was made
24
16
  * - [request] why the specimen was collected
25
17
  *
26
- * When creating a link, we encourage creating single direction links. The reverse link can be
27
- * found through a view
18
+ * When creating a link, we encourage creating single direction links. The reverse link can be found through a view
28
19
  *
29
- * Favour parent over child as it is better (for conflicts) to change 5 different documents once
30
- * instead of changing 5 times the same document
20
+ * Favour parent over child as it is better (for conflicts) to change 5 different documents once instead of changing 5 times the same document
31
21
  */
32
22
  export declare enum LinkQualification {
33
23
  Exact = "Exact",
@@ -6,29 +6,19 @@
6
6
  *
7
7
  * - [narrower] means that the linked codes have a narrower interpretation
8
8
  * - [parent] means that the linked code(s) is the parent of this code
9
- * - [sequence] means that the linked codes are a sequence of codes that are part of the current
10
- * code
11
- * - [basedOn] means a plan, proposal or order that is fulfilled in whole or in part by this event.
12
- * For example, a MedicationRequest may require a patient to have laboratory test performed before it
13
- * is dispensed.
14
- * - [derivedFrom] means the target resource that represents a measurement from which the service
15
- * value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound
16
- * image.
9
+ * - [sequence] means that the linked codes are a sequence of codes that are part of the current code
10
+ * - [basedOn] means a plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed.
11
+ * - [derivedFrom] means the target resource that represents a measurement from which the service value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image.
17
12
  * - [device] means the device used to generate the service data
18
- * - [focus] means the actual focus of a service when it is not the patient of record representing
19
- * something or someone associated with the patient such as a spouse, parent, fetus, or donor. For
20
- * example, fetus observations in a mother's record.
21
- * - [hasMember] means this service is a group service (e.g. a battery, a panel of tests, a set of
22
- * vital sign measurements) that includes the target as a member of the group
13
+ * - [focus] means the actual focus of a service when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record.
14
+ * - [hasMember] means this service is a group service (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group
23
15
  * - [performer] means who was responsible for asserting the observed value as "true".
24
16
  * - [specimen] means the specimen that was used when this service was made
25
17
  * - [request] why the specimen was collected
26
18
  *
27
- * When creating a link, we encourage creating single direction links. The reverse link can be
28
- * found through a view
19
+ * When creating a link, we encourage creating single direction links. The reverse link can be found through a view
29
20
  *
30
- * Favour parent over child as it is better (for conflicts) to change 5 different documents once
31
- * instead of changing 5 times the same document
21
+ * Favour parent over child as it is better (for conflicts) to change 5 different documents once instead of changing 5 times the same document
32
22
  */
33
23
  export var LinkQualification;
34
24
  (function (LinkQualification) {
@@ -2,8 +2,7 @@ import { Versionable } from './Versionable.mjs';
2
2
  /**
3
3
  *
4
4
  *
5
- * Interface for entities that are persisted as CouchDB documents and support hard deletion via a
6
- * deletion timestamp.
5
+ * Interface for entities that are persisted as CouchDB documents and support hard deletion via a deletion timestamp.
7
6
  */
8
7
  export interface StoredDocument extends Versionable<string> {
9
8
  deletionDate: number | undefined;
@@ -1,7 +1,6 @@
1
1
  /**
2
2
  *
3
- * Data transfer object representing basic authentication credentials for a CouchDB remote
4
- * connection.
3
+ * Data transfer object representing basic authentication credentials for a CouchDB remote connection.
5
4
  * /
6
5
  */
7
6
  export declare class Basic {
@@ -2,8 +2,7 @@
2
2
  import { expectString, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
3
3
  /**
4
4
  *
5
- * Data transfer object representing basic authentication credentials for a CouchDB remote
6
- * connection.
5
+ * Data transfer object representing basic authentication credentials for a CouchDB remote connection.
7
6
  * /
8
7
  */
9
8
  export class Basic {
@@ -1,7 +1,6 @@
1
1
  /**
2
2
  *
3
- * Data transfer object containing information about a CouchDB database, including size metrics and
4
- * cluster configuration.
3
+ * Data transfer object containing information about a CouchDB database, including size metrics and cluster configuration.
5
4
  * /
6
5
  */
7
6
  export declare class DatabaseInfo {
@@ -3,8 +3,7 @@ import { expectNumber, expectString, extractEntry } from '../../internal/JsonDec
3
3
  import { randomUuid } from '../../utils/Id.mjs';
4
4
  /**
5
5
  *
6
- * Data transfer object containing information about a CouchDB database, including size metrics and
7
- * cluster configuration.
6
+ * Data transfer object containing information about a CouchDB database, including size metrics and cluster configuration.
8
7
  * /
9
8
  */
10
9
  export class DatabaseInfo {
@@ -2,8 +2,7 @@ import { View } from './View.mjs';
2
2
  /**
3
3
  *
4
4
  *
5
- * Data transfer object representing a CouchDB design document, which contains views, lists, shows,
6
- * filters,
5
+ * Data transfer object representing a CouchDB design document, which contains views, lists, shows, filters,
7
6
  * and update handlers used for querying and transforming data.
8
7
  */
9
8
  export declare class DesignDocument {
@@ -5,8 +5,7 @@ import { View } from './View.mjs';
5
5
  /**
6
6
  *
7
7
  *
8
- * Data transfer object representing a CouchDB design document, which contains views, lists, shows,
9
- * filters,
8
+ * Data transfer object representing a CouchDB design document, which contains views, lists, shows, filters,
10
9
  * and update handlers used for querying and transforming data.
11
10
  */
12
11
  export class DesignDocument {
@@ -1,8 +1,7 @@
1
1
  import { DatabaseInfo } from './DatabaseInfo.mjs';
2
2
  /**
3
3
  *
4
- * Data transfer object aggregating database information for all databases belonging to a specific
5
- * group,
4
+ * Data transfer object aggregating database information for all databases belonging to a specific group,
6
5
  * including their storage sizes and GCP storage usage.
7
6
  * /
8
7
  */
@@ -3,8 +3,7 @@ import { expectArray, expectNumber, expectObject, expectString, extractEntry } f
3
3
  import { DatabaseInfo } from './DatabaseInfo.mjs';
4
4
  /**
5
5
  *
6
- * Data transfer object aggregating database information for all databases belonging to a specific
7
- * group,
6
+ * Data transfer object aggregating database information for all databases belonging to a specific group,
8
7
  * including their storage sizes and GCP storage usage.
9
8
  * /
10
9
  */
@@ -1,8 +1,7 @@
1
1
  import { RemoteAuthentication } from './RemoteAuthentication.mjs';
2
2
  /**
3
3
  *
4
- * Data transfer object representing a remote CouchDB endpoint with its URL and optional
5
- * authentication.
4
+ * Data transfer object representing a remote CouchDB endpoint with its URL and optional authentication.
6
5
  * /
7
6
  */
8
7
  export declare class Remote {
@@ -3,8 +3,7 @@ import { expectObject, expectString, extractEntry } from '../../internal/JsonDec
3
3
  import { RemoteAuthentication } from './RemoteAuthentication.mjs';
4
4
  /**
5
5
  *
6
- * Data transfer object representing a remote CouchDB endpoint with its URL and optional
7
- * authentication.
6
+ * Data transfer object representing a remote CouchDB endpoint with its URL and optional authentication.
8
7
  * /
9
8
  */
10
9
  export class Remote {
@@ -3,8 +3,7 @@ import { Remote } from './Remote.mjs';
3
3
  import { ReplicationStats } from './ReplicationStats.mjs';
4
4
  /**
5
5
  *
6
- * Data transfer object representing a CouchDB replicator document that tracks the state of a
7
- * replication task.
6
+ * Data transfer object representing a CouchDB replicator document that tracks the state of a replication task.
8
7
  * /
9
8
  */
10
9
  export declare class ReplicatorDocument implements Versionable<string> {
@@ -5,8 +5,7 @@ import { Remote } from './Remote.mjs';
5
5
  import { ReplicationStats } from './ReplicationStats.mjs';
6
6
  /**
7
7
  *
8
- * Data transfer object representing a CouchDB replicator document that tracks the state of a
9
- * replication task.
8
+ * Data transfer object representing a CouchDB replicator document that tracks the state of a replication task.
10
9
  * /
11
10
  */
12
11
  export class ReplicatorDocument {
@@ -1,7 +1,6 @@
1
1
  /**
2
2
  *
3
- * Data transfer object representing a labelled occurrence count, typically used for aggregation
4
- * results.
3
+ * Data transfer object representing a labelled occurrence count, typically used for aggregation results.
5
4
  * /
6
5
  */
7
6
  export declare class LabelledOccurence {
@@ -2,8 +2,7 @@
2
2
  import { expectNumber, expectString, extractEntry } from '../../internal/JsonDecodeUtils.mjs';
3
3
  /**
4
4
  *
5
- * Data transfer object representing a labelled occurrence count, typically used for aggregation
6
- * results.
5
+ * Data transfer object representing a labelled occurrence count, typically used for aggregation results.
7
6
  * /
8
7
  */
9
8
  export class LabelledOccurence {
@@ -1,8 +1,7 @@
1
1
  import { CodeStub } from '../base/CodeStub.mjs';
2
2
  /**
3
3
  *
4
- * Represents a quantity for medication administration, including the numeric amount and the unit of
5
- * administration.
4
+ * Represents a quantity for medication administration, including the numeric amount and the unit of administration.
6
5
  * /
7
6
  */
8
7
  export declare class AdministrationQuantity {
@@ -3,8 +3,7 @@ import { expectNumber, expectObject, expectString, extractEntry } from '../../in
3
3
  import { CodeStub } from '../base/CodeStub.mjs';
4
4
  /**
5
5
  *
6
- * Represents a quantity for medication administration, including the numeric amount and the unit of
7
- * administration.
6
+ * Represents a quantity for medication administration, including the numeric amount and the unit of administration.
8
7
  * /
9
8
  */
10
9
  export class AdministrationQuantity {
@@ -3,8 +3,7 @@ export declare namespace AgendaSlottingAlgorithm {
3
3
  /**
4
4
  *
5
5
  *
6
- * The appointments can be taken at fixed intervals of [intervalMinutes] starting from the
7
- * beginning of the
6
+ * The appointments can be taken at fixed intervals of [intervalMinutes] starting from the beginning of the
8
7
  * scheduled working hours for the available timetable item.
9
8
  * # Example
10
9
  * - Time table item scheduled 09:30-12:00, 12:45-14:00
@@ -5,8 +5,7 @@ export var AgendaSlottingAlgorithm;
5
5
  /**
6
6
  *
7
7
  *
8
- * The appointments can be taken at fixed intervals of [intervalMinutes] starting from the
9
- * beginning of the
8
+ * The appointments can be taken at fixed intervals of [intervalMinutes] starting from the beginning of the
10
9
  * scheduled working hours for the available timetable item.
11
10
  * # Example
12
11
  * - Time table item scheduled 09:30-12:00, 12:45-14:00