@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
@@ -367,7 +367,7 @@ function addFormatStructureForDate(structure) {
367
367
  function addFormatStructureForTime(structure) {
368
368
  this.g40(structure);
369
369
  }
370
- initMetadataForInterface(AbstractWithDateTimeBuilder, 'AbstractWithDateTimeBuilder', VOID, VOID, [AbstractWithDateBuilder, AbstractWithTimeBuilder, WithTime, WithDate]);
370
+ initMetadataForInterface(AbstractWithDateTimeBuilder, 'AbstractWithDateTimeBuilder', VOID, VOID, [AbstractWithDateBuilder, AbstractWithTimeBuilder, WithDate, WithTime]);
371
371
  initMetadataForClass(Builder_0, 'Builder', VOID, VOID, [AbstractDateTimeFormatBuilder, AbstractWithDateTimeBuilder]);
372
372
  initMetadataForClass(LocalDateTimeFormat, 'LocalDateTimeFormat', VOID, AbstractDateTimeFormat);
373
373
  function set_fractionOfSecond(value) {
@@ -496,6 +496,26 @@ export interface CalendarItemApi {
496
496
  /**
497
497
  *
498
498
  * Subscribe to receive real-time notifications when an entity is updated.
499
+ *
500
+ * # Access control
501
+ *
502
+ * The subscription will only receive notifications about entities that the SDK user can access; currently this
503
+ * validation varies slightly from standard read methods.
504
+ *
505
+ * ## Encryptable entities
506
+ *
507
+ * Applies the same access control rules as the standard read methods; depending on the permissions of the user the
508
+ * entity might need to have a direct delegation to the user, or to a parent, or if the user has the permission to
509
+ * read any entity of the type regardless of delegations then all notification of entities (matching the filter)
510
+ * will be received.
511
+ *
512
+ * ## Healthcare party
513
+ *
514
+ * Currently, regardless of user permissions, only notifications about healthcare parties that have the current SDK
515
+ * data owner as a DIRECT link will be returned.
516
+ *
517
+ * This behaviour is not in line with current Cardinal SDK ideology and is subject to change in future versions.
518
+ *
499
519
  * @param events the type of events that will be notified to the subscription
500
520
  * @param filter the subscription will receive notifications only for entities matching this filter, you should
501
521
  * make the filter as restrictive as possible.
@@ -261,6 +261,26 @@ export interface CalendarItemBasicApi {
261
261
  /**
262
262
  *
263
263
  * Subscribe to receive real-time notifications when an entity is updated.
264
+ *
265
+ * # Access control
266
+ *
267
+ * The subscription will only receive notifications about entities that the SDK user can access; currently this
268
+ * validation varies slightly from standard read methods.
269
+ *
270
+ * ## Encryptable entities
271
+ *
272
+ * Applies the same access control rules as the standard read methods; depending on the permissions of the user the
273
+ * entity might need to have a direct delegation to the user, or to a parent, or if the user has the permission to
274
+ * read any entity of the type regardless of delegations then all notification of entities (matching the filter)
275
+ * will be received.
276
+ *
277
+ * ## Healthcare party
278
+ *
279
+ * Currently, regardless of user permissions, only notifications about healthcare parties that have the current SDK
280
+ * data owner as a DIRECT link will be returned.
281
+ *
282
+ * This behaviour is not in line with current Cardinal SDK ideology and is subject to change in future versions.
283
+ *
264
284
  * @param events the type of events that will be notified to the subscription
265
285
  * @param filter the subscription will receive notifications only for entities matching this filter, you should
266
286
  * make the filter as restrictive as possible.
@@ -510,6 +510,26 @@ export interface ContactApi {
510
510
  /**
511
511
  *
512
512
  * Subscribe to receive real-time notifications when an entity is updated.
513
+ *
514
+ * # Access control
515
+ *
516
+ * The subscription will only receive notifications about entities that the SDK user can access; currently this
517
+ * validation varies slightly from standard read methods.
518
+ *
519
+ * ## Encryptable entities
520
+ *
521
+ * Applies the same access control rules as the standard read methods; depending on the permissions of the user the
522
+ * entity might need to have a direct delegation to the user, or to a parent, or if the user has the permission to
523
+ * read any entity of the type regardless of delegations then all notification of entities (matching the filter)
524
+ * will be received.
525
+ *
526
+ * ## Healthcare party
527
+ *
528
+ * Currently, regardless of user permissions, only notifications about healthcare parties that have the current SDK
529
+ * data owner as a DIRECT link will be returned.
530
+ *
531
+ * This behaviour is not in line with current Cardinal SDK ideology and is subject to change in future versions.
532
+ *
513
533
  * @param events the type of events that will be notified to the subscription
514
534
  * @param filter the subscription will receive notifications only for entities matching this filter, you should
515
535
  * make the filter as restrictive as possible.
@@ -303,6 +303,26 @@ export interface ContactBasicApi {
303
303
  /**
304
304
  *
305
305
  * Subscribe to receive real-time notifications when an entity is updated.
306
+ *
307
+ * # Access control
308
+ *
309
+ * The subscription will only receive notifications about entities that the SDK user can access; currently this
310
+ * validation varies slightly from standard read methods.
311
+ *
312
+ * ## Encryptable entities
313
+ *
314
+ * Applies the same access control rules as the standard read methods; depending on the permissions of the user the
315
+ * entity might need to have a direct delegation to the user, or to a parent, or if the user has the permission to
316
+ * read any entity of the type regardless of delegations then all notification of entities (matching the filter)
317
+ * will be received.
318
+ *
319
+ * ## Healthcare party
320
+ *
321
+ * Currently, regardless of user permissions, only notifications about healthcare parties that have the current SDK
322
+ * data owner as a DIRECT link will be returned.
323
+ *
324
+ * This behaviour is not in line with current Cardinal SDK ideology and is subject to change in future versions.
325
+ *
306
326
  * @param events the type of events that will be notified to the subscription
307
327
  * @param filter the subscription will receive notifications only for entities matching this filter, you should
308
328
  * make the filter as restrictive as possible.
@@ -63,6 +63,26 @@ export interface DeviceApi {
63
63
  /**
64
64
  *
65
65
  * Subscribe to receive real-time notifications when an entity is updated.
66
+ *
67
+ * # Access control
68
+ *
69
+ * The subscription will only receive notifications about entities that the SDK user can access; currently this
70
+ * validation varies slightly from standard read methods.
71
+ *
72
+ * ## Encryptable entities
73
+ *
74
+ * Applies the same access control rules as the standard read methods; depending on the permissions of the user the
75
+ * entity might need to have a direct delegation to the user, or to a parent, or if the user has the permission to
76
+ * read any entity of the type regardless of delegations then all notification of entities (matching the filter)
77
+ * will be received.
78
+ *
79
+ * ## Healthcare party
80
+ *
81
+ * Currently, regardless of user permissions, only notifications about healthcare parties that have the current SDK
82
+ * data owner as a DIRECT link will be returned.
83
+ *
84
+ * This behaviour is not in line with current Cardinal SDK ideology and is subject to change in future versions.
85
+ *
66
86
  * @param events the type of events that will be notified to the subscription
67
87
  * @param filter the subscription will receive notifications only for entities matching this filter, you should
68
88
  * make the filter as restrictive as possible.
@@ -408,6 +408,26 @@ export interface HealthElementApi {
408
408
  /**
409
409
  *
410
410
  * Subscribe to receive real-time notifications when an entity is updated.
411
+ *
412
+ * # Access control
413
+ *
414
+ * The subscription will only receive notifications about entities that the SDK user can access; currently this
415
+ * validation varies slightly from standard read methods.
416
+ *
417
+ * ## Encryptable entities
418
+ *
419
+ * Applies the same access control rules as the standard read methods; depending on the permissions of the user the
420
+ * entity might need to have a direct delegation to the user, or to a parent, or if the user has the permission to
421
+ * read any entity of the type regardless of delegations then all notification of entities (matching the filter)
422
+ * will be received.
423
+ *
424
+ * ## Healthcare party
425
+ *
426
+ * Currently, regardless of user permissions, only notifications about healthcare parties that have the current SDK
427
+ * data owner as a DIRECT link will be returned.
428
+ *
429
+ * This behaviour is not in line with current Cardinal SDK ideology and is subject to change in future versions.
430
+ *
411
431
  * @param events the type of events that will be notified to the subscription
412
432
  * @param filter the subscription will receive notifications only for entities matching this filter, you should
413
433
  * make the filter as restrictive as possible.
@@ -210,6 +210,26 @@ export interface HealthElementBasicApi {
210
210
  /**
211
211
  *
212
212
  * Subscribe to receive real-time notifications when an entity is updated.
213
+ *
214
+ * # Access control
215
+ *
216
+ * The subscription will only receive notifications about entities that the SDK user can access; currently this
217
+ * validation varies slightly from standard read methods.
218
+ *
219
+ * ## Encryptable entities
220
+ *
221
+ * Applies the same access control rules as the standard read methods; depending on the permissions of the user the
222
+ * entity might need to have a direct delegation to the user, or to a parent, or if the user has the permission to
223
+ * read any entity of the type regardless of delegations then all notification of entities (matching the filter)
224
+ * will be received.
225
+ *
226
+ * ## Healthcare party
227
+ *
228
+ * Currently, regardless of user permissions, only notifications about healthcare parties that have the current SDK
229
+ * data owner as a DIRECT link will be returned.
230
+ *
231
+ * This behaviour is not in line with current Cardinal SDK ideology and is subject to change in future versions.
232
+ *
213
233
  * @param events the type of events that will be notified to the subscription
214
234
  * @param filter the subscription will receive notifications only for entities matching this filter, you should
215
235
  * make the filter as restrictive as possible.
@@ -137,6 +137,26 @@ export interface HealthcarePartyApi {
137
137
  /**
138
138
  *
139
139
  * Subscribe to receive real-time notifications when an entity is updated.
140
+ *
141
+ * # Access control
142
+ *
143
+ * The subscription will only receive notifications about entities that the SDK user can access; currently this
144
+ * validation varies slightly from standard read methods.
145
+ *
146
+ * ## Encryptable entities
147
+ *
148
+ * Applies the same access control rules as the standard read methods; depending on the permissions of the user the
149
+ * entity might need to have a direct delegation to the user, or to a parent, or if the user has the permission to
150
+ * read any entity of the type regardless of delegations then all notification of entities (matching the filter)
151
+ * will be received.
152
+ *
153
+ * ## Healthcare party
154
+ *
155
+ * Currently, regardless of user permissions, only notifications about healthcare parties that have the current SDK
156
+ * data owner as a DIRECT link will be returned.
157
+ *
158
+ * This behaviour is not in line with current Cardinal SDK ideology and is subject to change in future versions.
159
+ *
140
160
  * @param events the type of events that will be notified to the subscription
141
161
  * @param filter the subscription will receive notifications only for entities matching this filter, you should
142
162
  * make the filter as restrictive as possible.
@@ -296,6 +296,26 @@ export interface MaintenanceTaskApi {
296
296
  /**
297
297
  *
298
298
  * Subscribe to receive real-time notifications when an entity is updated.
299
+ *
300
+ * # Access control
301
+ *
302
+ * The subscription will only receive notifications about entities that the SDK user can access; currently this
303
+ * validation varies slightly from standard read methods.
304
+ *
305
+ * ## Encryptable entities
306
+ *
307
+ * Applies the same access control rules as the standard read methods; depending on the permissions of the user the
308
+ * entity might need to have a direct delegation to the user, or to a parent, or if the user has the permission to
309
+ * read any entity of the type regardless of delegations then all notification of entities (matching the filter)
310
+ * will be received.
311
+ *
312
+ * ## Healthcare party
313
+ *
314
+ * Currently, regardless of user permissions, only notifications about healthcare parties that have the current SDK
315
+ * data owner as a DIRECT link will be returned.
316
+ *
317
+ * This behaviour is not in line with current Cardinal SDK ideology and is subject to change in future versions.
318
+ *
299
319
  * @param events the type of events that will be notified to the subscription
300
320
  * @param filter the subscription will receive notifications only for entities matching this filter, you should
301
321
  * make the filter as restrictive as possible.
@@ -162,6 +162,26 @@ export interface MaintenanceTaskBasicApi {
162
162
  /**
163
163
  *
164
164
  * Subscribe to receive real-time notifications when an entity is updated.
165
+ *
166
+ * # Access control
167
+ *
168
+ * The subscription will only receive notifications about entities that the SDK user can access; currently this
169
+ * validation varies slightly from standard read methods.
170
+ *
171
+ * ## Encryptable entities
172
+ *
173
+ * Applies the same access control rules as the standard read methods; depending on the permissions of the user the
174
+ * entity might need to have a direct delegation to the user, or to a parent, or if the user has the permission to
175
+ * read any entity of the type regardless of delegations then all notification of entities (matching the filter)
176
+ * will be received.
177
+ *
178
+ * ## Healthcare party
179
+ *
180
+ * Currently, regardless of user permissions, only notifications about healthcare parties that have the current SDK
181
+ * data owner as a DIRECT link will be returned.
182
+ *
183
+ * This behaviour is not in line with current Cardinal SDK ideology and is subject to change in future versions.
184
+ *
165
185
  * @param events the type of events that will be notified to the subscription
166
186
  * @param filter the subscription will receive notifications only for entities matching this filter, you should
167
187
  * make the filter as restrictive as possible.
@@ -437,6 +437,26 @@ export interface MessageApi {
437
437
  /**
438
438
  *
439
439
  * Subscribe to receive real-time notifications when an entity is updated.
440
+ *
441
+ * # Access control
442
+ *
443
+ * The subscription will only receive notifications about entities that the SDK user can access; currently this
444
+ * validation varies slightly from standard read methods.
445
+ *
446
+ * ## Encryptable entities
447
+ *
448
+ * Applies the same access control rules as the standard read methods; depending on the permissions of the user the
449
+ * entity might need to have a direct delegation to the user, or to a parent, or if the user has the permission to
450
+ * read any entity of the type regardless of delegations then all notification of entities (matching the filter)
451
+ * will be received.
452
+ *
453
+ * ## Healthcare party
454
+ *
455
+ * Currently, regardless of user permissions, only notifications about healthcare parties that have the current SDK
456
+ * data owner as a DIRECT link will be returned.
457
+ *
458
+ * This behaviour is not in line with current Cardinal SDK ideology and is subject to change in future versions.
459
+ *
440
460
  * @param events the type of events that will be notified to the subscription
441
461
  * @param filter the subscription will receive notifications only for entities matching this filter, you should
442
462
  * make the filter as restrictive as possible.
@@ -254,6 +254,26 @@ export interface MessageBasicApi {
254
254
  /**
255
255
  *
256
256
  * Subscribe to receive real-time notifications when an entity is updated.
257
+ *
258
+ * # Access control
259
+ *
260
+ * The subscription will only receive notifications about entities that the SDK user can access; currently this
261
+ * validation varies slightly from standard read methods.
262
+ *
263
+ * ## Encryptable entities
264
+ *
265
+ * Applies the same access control rules as the standard read methods; depending on the permissions of the user the
266
+ * entity might need to have a direct delegation to the user, or to a parent, or if the user has the permission to
267
+ * read any entity of the type regardless of delegations then all notification of entities (matching the filter)
268
+ * will be received.
269
+ *
270
+ * ## Healthcare party
271
+ *
272
+ * Currently, regardless of user permissions, only notifications about healthcare parties that have the current SDK
273
+ * data owner as a DIRECT link will be returned.
274
+ *
275
+ * This behaviour is not in line with current Cardinal SDK ideology and is subject to change in future versions.
276
+ *
257
277
  * @param events the type of events that will be notified to the subscription
258
278
  * @param filter the subscription will receive notifications only for entities matching this filter, you should
259
279
  * make the filter as restrictive as possible.
@@ -521,6 +521,26 @@ export interface PatientApi {
521
521
  /**
522
522
  *
523
523
  * Subscribe to receive real-time notifications when an entity is updated.
524
+ *
525
+ * # Access control
526
+ *
527
+ * The subscription will only receive notifications about entities that the SDK user can access; currently this
528
+ * validation varies slightly from standard read methods.
529
+ *
530
+ * ## Encryptable entities
531
+ *
532
+ * Applies the same access control rules as the standard read methods; depending on the permissions of the user the
533
+ * entity might need to have a direct delegation to the user, or to a parent, or if the user has the permission to
534
+ * read any entity of the type regardless of delegations then all notification of entities (matching the filter)
535
+ * will be received.
536
+ *
537
+ * ## Healthcare party
538
+ *
539
+ * Currently, regardless of user permissions, only notifications about healthcare parties that have the current SDK
540
+ * data owner as a DIRECT link will be returned.
541
+ *
542
+ * This behaviour is not in line with current Cardinal SDK ideology and is subject to change in future versions.
543
+ *
524
544
  * @param events the type of events that will be notified to the subscription
525
545
  * @param filter the subscription will receive notifications only for entities matching this filter, you should
526
546
  * make the filter as restrictive as possible.
@@ -279,6 +279,26 @@ export interface PatientBasicApi {
279
279
  /**
280
280
  *
281
281
  * Subscribe to receive real-time notifications when an entity is updated.
282
+ *
283
+ * # Access control
284
+ *
285
+ * The subscription will only receive notifications about entities that the SDK user can access; currently this
286
+ * validation varies slightly from standard read methods.
287
+ *
288
+ * ## Encryptable entities
289
+ *
290
+ * Applies the same access control rules as the standard read methods; depending on the permissions of the user the
291
+ * entity might need to have a direct delegation to the user, or to a parent, or if the user has the permission to
292
+ * read any entity of the type regardless of delegations then all notification of entities (matching the filter)
293
+ * will be received.
294
+ *
295
+ * ## Healthcare party
296
+ *
297
+ * Currently, regardless of user permissions, only notifications about healthcare parties that have the current SDK
298
+ * data owner as a DIRECT link will be returned.
299
+ *
300
+ * This behaviour is not in line with current Cardinal SDK ideology and is subject to change in future versions.
301
+ *
282
302
  * @param events the type of events that will be notified to the subscription
283
303
  * @param filter the subscription will receive notifications only for entities matching this filter, you should
284
304
  * make the filter as restrictive as possible.
@@ -365,6 +365,26 @@ export interface RelatedPersonApi {
365
365
  /**
366
366
  *
367
367
  * Subscribe to receive real-time notifications when an entity is updated.
368
+ *
369
+ * # Access control
370
+ *
371
+ * The subscription will only receive notifications about entities that the SDK user can access; currently this
372
+ * validation varies slightly from standard read methods.
373
+ *
374
+ * ## Encryptable entities
375
+ *
376
+ * Applies the same access control rules as the standard read methods; depending on the permissions of the user the
377
+ * entity might need to have a direct delegation to the user, or to a parent, or if the user has the permission to
378
+ * read any entity of the type regardless of delegations then all notification of entities (matching the filter)
379
+ * will be received.
380
+ *
381
+ * ## Healthcare party
382
+ *
383
+ * Currently, regardless of user permissions, only notifications about healthcare parties that have the current SDK
384
+ * data owner as a DIRECT link will be returned.
385
+ *
386
+ * This behaviour is not in line with current Cardinal SDK ideology and is subject to change in future versions.
387
+ *
368
388
  * @param events the type of events that will be notified to the subscription
369
389
  * @param filter the subscription will receive notifications only for entities matching this filter, you should
370
390
  * make the filter as restrictive as possible.
@@ -396,6 +396,26 @@ export interface TopicApi {
396
396
  /**
397
397
  *
398
398
  * Subscribe to receive real-time notifications when an entity is updated.
399
+ *
400
+ * # Access control
401
+ *
402
+ * The subscription will only receive notifications about entities that the SDK user can access; currently this
403
+ * validation varies slightly from standard read methods.
404
+ *
405
+ * ## Encryptable entities
406
+ *
407
+ * Applies the same access control rules as the standard read methods; depending on the permissions of the user the
408
+ * entity might need to have a direct delegation to the user, or to a parent, or if the user has the permission to
409
+ * read any entity of the type regardless of delegations then all notification of entities (matching the filter)
410
+ * will be received.
411
+ *
412
+ * ## Healthcare party
413
+ *
414
+ * Currently, regardless of user permissions, only notifications about healthcare parties that have the current SDK
415
+ * data owner as a DIRECT link will be returned.
416
+ *
417
+ * This behaviour is not in line with current Cardinal SDK ideology and is subject to change in future versions.
418
+ *
399
419
  * @param events the type of events that will be notified to the subscription
400
420
  * @param filter the subscription will receive notifications only for entities matching this filter, you should
401
421
  * make the filter as restrictive as possible.
@@ -232,6 +232,26 @@ export interface TopicBasicApi {
232
232
  /**
233
233
  *
234
234
  * Subscribe to receive real-time notifications when an entity is updated.
235
+ *
236
+ * # Access control
237
+ *
238
+ * The subscription will only receive notifications about entities that the SDK user can access; currently this
239
+ * validation varies slightly from standard read methods.
240
+ *
241
+ * ## Encryptable entities
242
+ *
243
+ * Applies the same access control rules as the standard read methods; depending on the permissions of the user the
244
+ * entity might need to have a direct delegation to the user, or to a parent, or if the user has the permission to
245
+ * read any entity of the type regardless of delegations then all notification of entities (matching the filter)
246
+ * will be received.
247
+ *
248
+ * ## Healthcare party
249
+ *
250
+ * Currently, regardless of user permissions, only notifications about healthcare parties that have the current SDK
251
+ * data owner as a DIRECT link will be returned.
252
+ *
253
+ * This behaviour is not in line with current Cardinal SDK ideology and is subject to change in future versions.
254
+ *
235
255
  * @param events the type of events that will be notified to the subscription
236
256
  * @param filter the subscription will receive notifications only for entities matching this filter, you should
237
257
  * make the filter as restrictive as possible.
package/api/UserApi.d.mts CHANGED
@@ -153,6 +153,26 @@ export interface UserApi {
153
153
  /**
154
154
  *
155
155
  * Subscribe to receive real-time notifications when an entity is updated.
156
+ *
157
+ * # Access control
158
+ *
159
+ * The subscription will only receive notifications about entities that the SDK user can access; currently this
160
+ * validation varies slightly from standard read methods.
161
+ *
162
+ * ## Encryptable entities
163
+ *
164
+ * Applies the same access control rules as the standard read methods; depending on the permissions of the user the
165
+ * entity might need to have a direct delegation to the user, or to a parent, or if the user has the permission to
166
+ * read any entity of the type regardless of delegations then all notification of entities (matching the filter)
167
+ * will be received.
168
+ *
169
+ * ## Healthcare party
170
+ *
171
+ * Currently, regardless of user permissions, only notifications about healthcare parties that have the current SDK
172
+ * data owner as a DIRECT link will be returned.
173
+ *
174
+ * This behaviour is not in line with current Cardinal SDK ideology and is subject to change in future versions.
175
+ *
156
176
  * @param events the type of events that will be notified to the subscription
157
177
  * @param filter the subscription will receive notifications only for entities matching this filter, you should
158
178
  * make the filter as restrictive as possible.