-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapiary.apib
1363 lines (1091 loc) · 59.1 KB
/
apiary.apib
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
FORMAT: 1A
HOST: https://api-meamedica-tst.azurewebsites.net/
# meamedica API
## Scope & Status
This is an API to define and disclose methods to interact with medical data.
This API will be continuously updated and developed to provide methods that
can be used in several medical areas.
#### Current Business Areas
- Dental Practices
#### Current API Status
- Operating normally but may be subject to changes without prior notice.
## Ownership
Although public, this API blueprint is developed and made available
by **[Insight Pharma Services BV](http://www.insightpharma.nl)**. It is possible
that some of the methods here described are already developed to fullfil a
specific client need. Any questions, comments or requests can therefore be sent
to the contacts available in our site. You can also follow us on
[twitter](https://twitter.com/mijnmedicijn) or [facebook](https://www.facebook.com/mijnmedicijn).
## Information Security
This API is hosted in a [Microsoft Azure](https://azure.microsoft.com/en-us/overview/what-is-azure/)
infrastructure which is one of the most recognized cloud services available. Among
several other technological aspects, Microsoft Azure is also known for a high security
level and for this matter it is compliant with the ISO industry standards
[ISO27001](https://azure.microsoft.com/en-us/support/trust-center/compliance/iso27001/)
(Information Security Management Standards) and [ISO27018](https://azure.microsoft.com/en-us/support/trust-center/compliance/iso27018/)
(Protection of Personally Identifiable Information in public clouds).
## Disclaimer
Absolutely nothing is granted by the direct or indirect use of the content
hereby described. This API contains references to medical terms and/or concepts
that exist in the Netherlands. These terms and/or concepts might not apply to
other countries.
# Group Common API
## Authentication > Get Token [/access/get?clientKey={clientKey}]
+ Parameters
+ clientKey: b2c38708d821833daf11 (required, string) - subscription client key as an encoded string
### API Definition [GET]
***Description***
This method is used to get a token based on a valid client key. Clients will
receive their client key when they have an agreement to use this API service.
This token must then be used in all other requests to API methods here described
(search for the `token` keyword).
***Usage***
The request must contain the `clientKey`. The response will be in the field `Token`.
It is an authorized and encrypted string that includes a timestamp to make it valid
during a specific time period and will be similar to:
*xe24csp34lqem662sbvyzbtz2z6pfclflpnlbm5aowrlazvhu5benfhsa64srg3e3teaka45llnue===*
***Response***
| HTTP Code | API Code | Found in | Description |
| :--------: | :----------------- | :-------------- | :---------------------------- |
| 400 | ClientKey.Missing | `message` field | No ClientKey was given. |
| 401 | ClientKey.NoAccess | `message` field | ClientKey is not valid. |
| 200 | `token` | `Token` field | A valid token was issued. |
| 200 | Unexpected.Error | `Token` field | Contact us via [email](<mailto:[email protected]>). |
***Please note:*** in all the methods the `message` field can be found in the following
JSON structure in the response:
```
{
"status": <http-error-code>,
"source": "<full-url-called>",
"message": "ClientKey.NoAccess"
}
```
+ Response 200 (application/json)
{
"Token": "string"
}
## Current Version > Get [/version]
### API Definition [GET]
***Description***
This method is used to get the current version of this API mainly for informative
purposes. Nothing is expected in the request or as an URL parameter.
***Usage and Response***
No input is necessary to call this method so the response will just show the
current version. No other possible values can be given. No errors can occur.
+ Response 200 (application/json)
{
"Version": "string"
}
# Group Practice API
## Create [/practice/create]
### API Definition [POST]
***Description***
This method should be used to create a new dental practice. Besides some basic data
about the practice we should get the practice AGB code and also an email for administrative
contact purposes. It should also be given the number of patients currently registered.
***Usage***
The request must contain the `token` and some information about the practice:
- Unique identifier - AGB code
- Identification - Name, Number of patients, Administrative email
- Geographic location - Address, Postal code, City
***Response***
| HTTP Code | API Code | Found in | Description |
| :--------: | :----------------- | :-------------- | :------------------------------- |
| 400 | Token.Missing | `message` field | No Token was given. |
| 401 | ClientKey.NoAccess | `message` field | ClientKey is not valid. |
| 401 | Token.Expired | `message` field | Token is no longer valid. |
| 400 | Missing.Parameters | `message` field | Required parameters are missing. |
| 200 | Practice.Exists | `Result` field | Practice AGB already exists. |
| 200 | Practice.NotAdded | `Result` field | Practice was not created. |
| 200 | Practice.Duplicate | `Result` field | Practice already exists. |
| 200 | OK | `Result` field | Practice was created. |
| 200 | Unexpected.Error | `Result` field | Contact us via [email](<mailto:[email protected]>). |
+ Request (application/json)
{
"PracticeAgb": "string",
"Name": "string",
"Address": "string",
"PostalCode": "string",
"City": "string",
"Email": "string",
"NumberOfPatients": 0,
"Token": "string"
}
+ Response 200 (application/json)
{
"Result": "string",
"Messages": [
"string"
]
}
## Get [/practice/get?practiceAgb={practiceAgb}&token={token}]
+ Parameters
+ practiceAgb: 12345678 (required, number) - practice AGB code as an 8-digit number
+ token: 1g4qq30l3hffqo9za8da1zf3402xaq2ry6w2k02lfjk9w3g284kkoiw5ycdgfup13yycdat9ta (required, string) - encrypted authentication token
### API Definition [GET]
***Description***
This method is used to get detailed information about the practice identified by
the AGB code given as parameter.
***Usage***
The request must contain the `token` and the practice `AGB code`.
***Response***
| HTTP Code | API Code | Found in | Description |
| :--------: | :-------------------- | :-------------- | :------------------------------- |
| 400 | Practice.Missing | `message` field | No practice AGB was given. |
| 400 | Token.Missing | `message` field | No Token was given. |
| 401 | ClientKey.NoAccess | `message` field | ClientKey is not valid. |
| 401 | Token.Expired | `message` field | Token is no longer valid. |
| 200 | Practice.NotFound | `Result` field | Practice was not found. |
| 200 | Practice.NoAccess | `Result` field | Client has no access to the specified practice.|
| 200 | Subscription.NotFound | `Result` field | Subscription was not found. |
| 200 | Subscription.Expired | `Result` field | Subscription has expired. |
| 200 | OK | `Result` field | Practice was found. |
| 200 | Unexpected.Error | `Result` field | Contact us via [email](<mailto:[email protected]>). |
In case of `OK`, the `Messages` field has the **AGB Code** and the following
information about the practice is returned in the proper fields.
- Name, Contact and KVK number
- Geographic location - Address, Postal code, City
- Date of creation and date when this request was issued ( *dd-mm-yyyy* )
+ Response 200 (application/json)
{
"InformationDate": "string",
"Name": "string",
"Address": "string",
"Phone": "string",
"Kvk": "string",
"DateCreated": "string",
"Result": "string",
"Messages": [
"string"
]
}
## Get Care Professionals [/practice/careprofessionals/get?practiceAgb={practiceAgb}&token={token}]
+ Parameters
+ practiceAgb: 12345678 (required, number) - practice AGB code as an 8-digit number
+ token: 1g4qq30l3hffqo9za8da1zf3402xaq2ry6w2k02lfjk9w3g284kkoiw5ycdgfup13yycdat9ta (required, string) - encrypted authentication token
### API Definition [GET]
***Description***
This method is used to get detailed information about the care professionals (dentists,
assistants or others) that work in the practice identified by the AGB code given as
parameter.
***Usage***
The request must contain the `token` and the practice `AGB code`.
***Response***
| HTTP Code | API Code | Found in | Description |
| :--------: | :-------------------- | :-------------- | :------------------------------- |
| 400 | Practice.Missing | `message` field | No practice AGB was given. |
| 400 | Token.Missing | `message` field | No Token was given. |
| 401 | ClientKey.NoAccess | `message` field | ClientKey is not valid. |
| 401 | Token.Expired | `message` field | Token is no longer valid. |
| 200 | Practice.NotFound | `Result` field | Practice was not found. |
| 200 | Practice.NoAccess | `Result` field | Client has no access to the specified practice.|
| 200 | Subscription.NotFound | `Result` field | Subscription was not found. |
| 200 | Subscription.Expired | `Result` field | Subscription has expired. |
| 200 | OK | `Result` field | Care professionals were found. |
| 200 | Unexpected.Error | `Result` field | Contact us via [email](<mailto:[email protected]>). |
In case of `OK`, the `Messages` field has the **AGB Code** and the following
information about the practice care professionals (dentists and/or assistants and/or
others) is returned in the proper fields.
- *Care Professionals*: identifier, initials, lastname and specialty
- *Care Professionals*: BIG number, KNMT number and email ( *if available* )
- Date when this request was issued ( *dd-mm-yyyy* )
+ Response 200 (application/json)
{
"InformationDate": "string",
"CareProfessionals": [
{
"CareProfessionalId": "string",
"Initials": "string",
"LastName": "string",
"Specialty": "string",
"BigNumber": "string",
"KnmtNumber": "string",
"Email": "string"
}
],
"Result": "string",
"Messages": [
"string"
],
}
# Group Care Professional API
## Create [/careprofessional/create]
### API Definition [POST]
***Description***
This method is meant to add one or more care professionals to an existing practice.
Each care professional must specifiy its specialty. Some of them are doctors but some
might not be. The practice AGB code is required as matching identifier.
***Usage***
The request must contain the `token` and some information about the care professional
to create. In one request, one or more care professionals can be created.
- *Required*: care professional identifier, initials, lastname and specialty
- *Optional*: BIG number, KNMT number and email address
**Accepted specialties are**: *Tandarts, MKA-chirurg, Parodontoloog, Endodontoloog,
Pedodontoloog, Implantoloog, Gnatholoog, Orthodontist, Revalidatie arts, Medisch
specialist, Psycholoog, Mondhygiënist, Tandprotheticus, Tandartsassistent,
Preventie-assistent, Stagiair, Student, Onbekend.*
***Response***
| HTTP Code | API Code | Found in | Description |
| :--------: | :-------------------- | :-------------- | :------------------------------- |
| 400 | Token.Missing | `message` field | No Token was given. |
| 401 | ClientKey.NoAccess | `message` field | ClientKey is not valid. |
| 401 | Token.Expired | `message` field | Token is no longer valid. |
| 400 | Missing.Parameters | `message` field | Required parameters are missing. |
| 200 | Practice.NotFound | `Result` field | Practice was not found. |
| 200 | Practice.NoAccess | `Result` field | Client has no access to the specified practice.|
| 200 | Subscription.NotFound | `Result` field | Subscription was not found. |
| 200 | Subscription.Expired | `Result` field | Subscription has expired. |
| 200 | Customer.NotAdded | `Result` field | Care Professional was not created. |
| 200 | CareProfessional.NotFound | `Result` field | Care Professional was not found. |
| 200 | CareProfessional.NotAdded | `Result` field | Care Professional was not created. |
| 200 | CareProfessional.Exists | `Result` field | Care Professional already exists. |
| 200 | CareProfessional.NoSpecialty | `Result` field | Specialty was not found. |
| 200 | OK | `Result` field | Care Professional was created. |
| 200 | Unexpected.Error | `Result` field | Contact us via [email](<mailto:[email protected]>). |
In case of `OK`, the `Messages` field has the **AGB Code**.
+ Request (application/json)
{
"PracticeAgb": "string",
"CareProfessionals": [
{
"CareProfessionalId": "string",
"Initials": "string",
"LastName": "string",
"Specialty": "string",
"BigNumber": "string",
"KnmtNumber": "string",
"Email": "string"
}
],
"Token": "string"
}
+ Response 200 (application/json)
{
"Result": "string",
"Messages": [
"string"
]
}
## Get [/careprofessional/get?practiceAgb={practiceAgb}&bigNumber={bigNumber}&careprofessionalId={careprofessionalId}&token={token}]
+ Parameters
+ practiceAgb: 12345678 (required, number) - practice AGB code as an 8-digit number
+ bigNumber: 12345678901 (optional, number) - unique care professional identifier
+ careprofessionalId: 12345678 (optional, number) - client-side identifier
+ token: 1g4qq30l3hffqo9za8da1zf3402xaq2ry6w2k02lfjk9w3g284kkoiw5ycdgfup13yycdat9ta (required, string) - encrypted authentication token
### API Definition [GET]
***Description***
This method is used to get detailed information about a care professional. A care
professional can be identified globally by its BIG number or locally to a practice by
its care professional identifier. If both values are given they must match the same
care professional to be successful. If none is given an error will occur.
***Usage***
The request must contain the `token`, the practice `AGB code` and the care professional
`BIG number` and/or care professional `identifier`.
***Response***
| HTTP Code | API Code | Found in | Description |
| :--------: | :-------------------- | :-------------- | :------------------------------- |
| 400 | Practice.Missing | `message` field | No practice AGB given. |
| 400 | CareProfessional.Missing | `message` field | No care professional identifier given. |
| 400 | Token.Missing | `message` field | No Token was given. |
| 401 | ClientKey.NoAccess | `message` field | ClientKey is not valid. |
| 401 | Token.Expired | `message` field | Token is no longer valid. |
| 200 | Practice.NotFound | `Result` field | Practice was not found. |
| 200 | Practice.NoAccess | `Result` field | Client has no access to the specified practice.|
| 200 | Subscription.NotFound | `Result` field | Subscription was not found. |
| 200 | Subscription.Expired | `Result` field | Subscription has expired. |
| 200 | Customer.NotFound | `Result` field | Care professional not found. |
| 200 | CareProfessional.NotFound | `Result` field | Care professional not found. |
| 200 | OK | `Result` field | Care professional was found. |
| 200 | Unexpected.Error | `Result` field | Contact us via [email](<mailto:[email protected]>). |
In case of `OK`, the `Messages` field has the **care professional identifier** used
and the following information about the care professional is returned in the proper
fields.
- Care professional identifier, initials, lastname and specialty
- Care professional BIG number, KNMT number and email ( *if available* )
- Date when this request was issued ( *dd-mm-yyyy* )
+ Response 200 (application/json)
{
"InformationDate": "string",
"CareProfessional": {
"CareProfessionalId": "string",
"Initials": "string",
"LastName": "string",
"Specialty": "string",
"BigNumber": "string",
"KnmtNumber": "string",
"Email": "string"
},
"Result": "string",
"Messages": [
"string"
]
}
# Group Patient API
## Create Local [/patient/local/create]
### API Definition [POST]
***Description***
This method can be used to create one patient for a given practice. It expects to
receive some generic data about the patient and about the practice were he is
registered.
***Usage***
The request must contain the `token`, the practice `AGB code` and some information
about the patient to create.
- Patient identifier, Gender ( *m/f* ) and Birthdate ( *dd-mm-yyyy* )
- Height ( *cm* ) and Weight ( *kg* ) ( *optional fields* )
***Response***
| HTTP Code | API Code | Found in | Description |
| :--------: | :-------------------- | :-------------- | :------------------------------- |
| 400 | Token.Missing | `message` field | No Token was given. |
| 401 | ClientKey.NoAccess | `message` field | ClientKey is not valid. |
| 401 | Token.Expired | `message` field | Token is no longer valid. |
| 400 | Missing.Parameters | `message` field | Required parameters are missing. |
| 200 | Practice.NotFound | `Result` field | Practice was not found. |
| 200 | Practice.NoAccess | `Result` field | Client has no access to the practice.|
| 200 | Subscription.NotFound | `Result` field | Subscription was not found. |
| 200 | Subscription.Expired | `Result` field | Subscription has expired. |
| 200 | Patient.Exists | `Result` field | Patient already exists. |
| 200 | Customer.NotAdded | `Result` field | Patient was not created. |
| 200 | Patient.NotAdded | `Result` field | Patient was not created. |
| 200 | OK | `Result` field | Patient was created. |
| 200 | Unexpected.Error | `Result` field | Contact us via [email](<mailto:[email protected]>). |
In case of `OK`, the `Messages` field has the **AGB Code** and the following
information about the patient is returned in the proper fields.
- Patient number (in the client system)
- Activation URL (only if patient is new)
+ Request (application/json)
{
"PracticeAgb": "string",
"PatientNr": "string",
"Initials": "string",
"FirstName": "string",
"Particle": "string",
"LastName": "string",
"PartnerName": "string",
"VektisCode": "string",
"Address": "string",
"PostalCode": "string",
"City": "string",
"Country": "string",
"Gender": "string",
"Birthdate": "string",
"Height": "string",
"Weight": "string",
"Token": "string"
}
+ Response 200 (application/json)
{
"PatientNr": "string",
"ActivationUrl": "string"
"Result": "string",
"Messages": [
"string"
]
}
## Get Overview Local [/patient/local/getOverview?practiceagb={practiceagb}&patientnr={patientnr}&token={token}]
+ Parameters
+ practiceagb: 12345678 (required, number) - practice AGB code as an 8-digit number
+ patientnr: 1 (required, number) - patient identifier in client system
+ token: 1g4qq30l3hffqo9za8da1zf3402xaq2ry6w2k02lfjk9w3g284kkoiw5ycdgfup13yycdat9ta (required, string) - encrypted authentication token
### API Definition [GET]
***Description***
This method is used to get an overview of some patient information. The information
will be given only if the patient belongs to the specified practice.
***Usage***
The request must contain the `token`, the practice `AGB code` and the patient
`identifier`.
***Response***
| HTTP Code | API Code | Found in | Description |
| :--------: | :-------------------- | :---------------| :------------------------------- |
| 400 | Practice.Missing | `message` field | No practice AGB given. |
| 400 | Patient.Missing | `message` field | No patient identifier given. |
| 400 | Token.Missing | `message` field | No Token was given. |
| 401 | ClientKey.NoAccess | `message` field | ClientKey is not valid. |
| 401 | Token.Expired | `message` field | Token is no longer valid. |
| 200 | Practice.NotFound | `Result` field | Practice was not found. |
| 200 | Practice.NoAccess | `Result` field | Client has no access to the specified practice.|
| 200 | Subscription.NotFound | `Result` field | Subscription was not found. |
| 200 | Subscription.Expired | `Result` field | Subscription has expired. |
| 200 | Patient.NotFound | `Result` field | Patient not found. |
| 200 | OK | `Result` field | Patient was found. |
| 200 | Unexpected.Error | `Result` field | Contact us via [email](<mailto:[email protected]>). |
In case of `OK`, the `Messages` field has the **AGB code** and the following
information about the patient is returned in the proper fields.
- Patient identifier
- BSN number ( *hashed if available* )
- Latest ASA score with related Questions and Answers
- Number of medicines in use and related medicine information (including the
`PrescriptionId` if the medicine was prescribed in **meamedica|dental**)
- Number of MTI messages
- Allergic to anesthesia and list of the patient's allergies (only medical related)
- Date when this request was issued ( *dd-mm-yyyy* )
+ Response 200 (application/json)
{
"PatientNr": "string",
"HashedBSN": "string",
"AsaScore": "string",
"AnamneseDate": "string",
"AnamneseInfo": [
{
"AsaScore": 0,
"Question": "string",
"Answer": "string",
"QuestionId": 0
}
],
"NrOfMedicines": "string",
"MedicineInfo": [
{
"Name": "string",
"GenericName": "string",
"Dosage": "string",
"UsageStartDate": "string",
"UsageEndDate": "string",
"UsageQuantity": "string",
"UsageUnit": "string",
"UsageFrequencyNrTimes": "string",
"UsageFrequencyPeriod": "string",
"PrescriptionId": "string"
}
],
"NrOfMtiMessages": "string",
"AnesthesiaAllergy": "string",
"AllergyInfo": [
{
"Name": "string"
}
],
"InformationDate": "string",
"PatientStatus": "string",
"ActivationUrl": "string",
"Result": "string",
"Messages": [
"string"
]
}
## Get Local [/patient/local/get?practiceagb={practiceagb}&patientnr={patientnr}&token={token}]
+ Parameters
+ practiceagb: 12345678 (required, number) - practice AGB code as an 8-digit number
+ patientnr: 1 (required, number) - patient identifier in client system
+ token: 1g4qq30l3hffqo9za8da1zf3402xaq2ry6w2k02lfjk9w3g284kkoiw5ycdgfup13yycdat9ta (required, string) - encrypted authentication token
### API Definition [GET]
***Description***
This method is used to get details about the given patient. The information
will be given only if the patient belongs to the specified practice.
***Usage***
The request must contain the `token`, the practice `AGB code` and the patient
`identifier`.
***Response***
| HTTP Code | API Code | Found in | Description |
| :--------: | :-------------------- | :---------------| :------------------------------- |
| 400 | Practice.Missing | `message` field | No practice AGB given. |
| 400 | Patient.Missing | `message` field | No patient identifier given. |
| 400 | Token.Missing | `message` field | No Token was given. |
| 401 | ClientKey.NoAccess | `message` field | ClientKey is not valid. |
| 401 | Token.Expired | `message` field | Token is no longer valid. |
| 200 | Practice.NotFound | `Result` field | Practice was not found. |
| 200 | Practice.NoAccess | `Result` field | Client has no access to the specified practice.|
| 200 | Subscription.NotFound | `Result` field | Subscription was not found. |
| 200 | Subscription.Expired | `Result` field | Subscription has expired. |
| 200 | Patient.NotFound | `Result` field | Patient not found. |
| 200 | OK | `Result` field | Patient was found. |
| 200 | Unexpected.Error | `Result` field | Contact us via [email](<mailto:[email protected]>). |
In case of `OK`, the `Messages` field has the **AGB code** and the following
information about the patient is returned in the proper fields.
- Patient identifier, Gender ( *m/f* ) and Birthdate ( *dd-mm-yyyy* )
- BSN number ( *hashed if available* )
- Height ( *cm* ) and Weight ( *kg* ) ( *if available* )
- Patient Status (`Patient.New`, `Patient.Inactive`, `Patient.Active`)
- First Name, Last Name, Blood Group, City and Country ( *if available* )
- Date when this request was issued ( *dd-mm-yyyy* )
+ Response 200 (application/json)
{
"InformationDate": "string",
"PatientNr": "string",
"HashedBSN": "string",
"FirstName": "string",
"LastName": "string",
"BirthDate": "string",
"Gender": "string",
"Bloodgroup": "string",
"Length": "string",
"Weight": "string",
"City": "string",
"Country": "string",
"PatientStatus": "string",
"ActivationUrl": "string",
"Result": "string",
"Messages": [
"string"
]
}
## Update Local [/patient/local/update]
### API Definition [POST]
***Description***
This method can be used to update the data of a given patient.
The patient should already have been created via the create API method.
It expects to receive the patient data that needs to be changed.
***Usage***
The request must contain the `token`, the practice `AGB code`, the patient `number`
and the information that needs to be updated, namely:
- Gender ( *m/f* ) and Birthdate ( *dd-mm-yyyy* )
- Height ( *cm* ) and Weight ( *kg* ) ( *optional fields* )
***Response***
| HTTP Code | API Code | Found in | Description |
| :--------: | :-------------------- | :-------------- | :------------------------------- |
| 400 | Token.Missing | `message` field | No Token was given. |
| 401 | ClientKey.NoAccess | `message` field | ClientKey is not valid. |
| 401 | Token.Expired | `message` field | Token is no longer valid. |
| 400 | Missing.Parameters | `message` field | Required parameters are missing. |
| 200 | Practice.NotFound | `Result` field | Practice was not found. |
| 200 | Practice.NoAccess | `Result` field | Client has no access to the specified practice|
| 200 | Subscription.NotFound | `Result` field | Subscription was not found. |
| 200 | Subscription.Expired | `Result` field | Subscription has expired. |
| 200 | Customer.NotFound | `Result` field | Patient was not found. |
| 200 | Patient.NotFound | `Result` field | Patient was not found. |
| 200 | Customer.NotUpdated | `Result` field | Patient was not updated. |
| 200 | OK | `Result` field | Patient was updated. |
| 200 | Unexpected.Error | `Result` field | Contact us via [email](<mailto:[email protected]>). |
In case of `OK`, the `Messages` field has the **AGB Code** and the following
information about the patient is returned in the proper fields.
- Patient number (in the client system)
+ Request (application/json)
{
"PracticeAgb": "string",
"PatientNr": "string",
"Initials": "string",
"FirstName": "string",
"Particle": "string",
"LastName": "string",
"PartnerName": "string",
"VektisCode": "string",
"Address": "string",
"PostalCode": "string",
"City": "string",
"Country": "string",
"Gender": "string",
"Birthdate": "string",
"Height": "string",
"Weight": "string",
"Token": "string"
}
+ Response 200 (application/json)
{
"PatientNr": "string",
"Result": "string",
"Messages": [
"string"
]
}
## Close Local [/patient/local/close]
### API Definition [POST]
***Description***
This method is used to close the activity of a patient inline with the client system.
The operation will be executed only if the patient belongs to the specified practice.
***Usage***
The request must contain the `token`, the practice `AGB code` and the patient
`identifier`.
***Response***
| HTTP Code | API Code | Found in | Description |
| :--------: | :-------------------- | :---------------| :------------------------------- |
| 400 | Practice.Missing | `message` field | No practice AGB given. |
| 400 | Patient.Missing | `message` field | No patient identifier given. |
| 400 | Token.Missing | `message` field | No Token was given. |
| 401 | ClientKey.NoAccess | `message` field | ClientKey is not valid. |
| 401 | Token.Expired | `message` field | Token is no longer valid. |
| 200 | Practice.NotFound | `Result` field | Practice was not found. |
| 200 | Practice.NoAccess | `Result` field | Client has no access to the specified practice.|
| 200 | Subscription.NotFound | `Result` field | Subscription was not found. |
| 200 | Subscription.Expired | `Result` field | Subscription has expired. |
| 200 | Patient.NotFound | `Result` field | Patient not found. |
| 200 | OK | `Result` field | Patient was closed. |
| 200 | Unexpected.Error | `Result` field | Contact us via [email](<mailto:[email protected]>). |
In case of `OK`, the `Messages` field has the **AGB code**.
+ Request (application/json)
{
"PracticeAgb": "string",
"PatientNr": "string",
"Token": "string"
}
+ Response 200 (application/json)
{
"Result": "string",
"Messages": [
"string"
]
}
## Create with BSN [/patient/create]
### API Definition [POST]
***Description***
This method can be used to create one patient identified by the hashed BSN.
When hashing the BSN use only numbers. It expects to receive some generic data about the patient and about the
practice were he is registered.
***Usage***
The request must contain the `token`, the practice `AGB code` and some information
about the patient to create.
- BSN number ( *hashed* ), Gender ( *m/f* ) and Birthdate ( *dd-mm-yyyy* )
- Height ( *cm* ) and Weight ( *kg* ) ( *optional fields* )
***NOTE*** the `BSN number` is received in a hashed format and stored that same way
in the database. This number does not exist in a readable format. For more information
about this *hashing* please check [SHA algorithm](https://en.wikipedia.org/wiki/Secure_Hash_Algorithm) and in more detail [SHA-256](https://en.wikipedia.org/wiki/SHA-2).
***Response***
| HTTP Code | API Code | Found in | Description |
| :--------: | :-------------------- | :-------------- | :------------------------------- |
| 400 | Token.Missing | `message` field | No Token was given. |
| 401 | ClientKey.NoAccess | `message` field | ClientKey is not valid. |
| 401 | Token.Expired | `message` field | Token is no longer valid. |
| 400 | Missing.Parameters | `message` field | Required parameters are missing. |
| 200 | Practice.NotFound | `Result` field | Practice was not found. |
| 200 | Practice.NoAccess | `Result` field | Client has no access to the practice.|
| 200 | Subscription.NotFound | `Result` field | Subscription was not found. |
| 200 | Subscription.Expired | `Result` field | Subscription has expired. |
| 200 | Customer.Duplicate | `Result` field | Patient already exists. |
| 200 | Customer.NotFound | `Result` field | Patient was not found. |
| 200 | Patient.NotFound | `Result` field | Patient was not found. |
| 200 | Customer.NotAdded | `Result` field | Patient was not created. |
| 200 | Patient.NotAdded | `Result` field | Patient was not created. |
| 200 | OK | `Result` field | Patient was created. |
| 200 | Unexpected.Error | `Result` field | Contact us via [email](<mailto:[email protected]>). |
In case of `OK`, the `Messages` field has the **AGB Code** and the following
information about the patient is returned in the proper fields.
- BSN number ( *hashed* )
- Activation URL (only if patient is new)
+ Request (application/json)
{
"PracticeAgb": "string",
"BsnHashed": "string",
"Initials": "string",
"FirstName": "string",
"Particle": "string",
"LastName": "string",
"PartnerName": "string",
"VektisCode": "string",
"Address": "string",
"PostalCode": "string",
"City": "string",
"Country": "string",
"Gender": "string",
"Birthdate": "string",
"Height": "string",
"Weight": "string",
"Token": "string"
}
+ Response 200 (application/json)
{
"HashedBSN": "string",
"ActivationUrl": "string",
"Result": "string",
"Messages": [
"string"
]
}
## Get Overview with BSN [/patient/getOverview?practiceAgb={practiceAgb}&hashedBsn={hashedBsn}&token={token}]
+ Parameters
+ practiceAgb: 12345678 (required, number) - practice AGB code as an 8-digit number
+ hashedBsn: 8da1zf3402xaq2ry6w2 (required, string) - patient unique identifier
+ token: 1g4qq30l3hffqo9za8da1zf3402xaq2ry6w2k02lfjk9w3g284kkoiw5ycdgfup13yycdat9ta (required, string) - encrypted authentication token
### API Definition [GET]
***Description***
This method is used to get an overview of some patient information. The information
will be given for the patient identified by the hashed BSN and the practice AGB.
When hashing the BSN use only numbers.
***Usage***
The request must contain the `token`, the practice `AGB code` and the patient unique
`BSN` ( *in hashed format* ).
***Response***
| HTTP Code | API Code | Found in | Description |
| :--------: | :-------------------- | :-------------- | :------------------------------- |
| 400 | Practice.Missing | `message` field | No practice AGB given. |
| 400 | Patient.Missing | `message` field | No patient identifier given. |
| 400 | Token.Missing | `message` field | No Token was given. |
| 401 | ClientKey.NoAccess | `message` field | ClientKey is not valid. |
| 401 | Token.Expired | `message` field | Token is no longer valid. |
| 200 | Practice.NotFound | `Result` field | Practice was not found. |
| 200 | Practice.NoAccess | `Result` field | Client has no access to the specified practice.|
| 200 | Subscription.NotFound | `Result` field | Subscription was not found. |
| 200 | Subscription.Expired | `Result` field | Subscription has expired. |
| 200 | Customer.NotFound | `Result` field | Patient not found. |
| 200 | Patient.NotFound | `Result` field | Patient not found. |
| 200 | OK | `Result` field | Patient was found. |
| 200 | Unexpected.Error | `Result` field | Contact us via [email](<mailto:[email protected]>). |
In case of `OK`, the `Messages` field has the **AGB code** and the following
information about the patient is returned in the proper fields.
- BSN number ( *hashed* )
- Latest ASA score with related Questions and Answers
- Number of medicines in use and related medicine information (including the
`PrescriptionId` if the medicine was prescribed in **meamedica|dental**)
- Number of MTI messages
- Allergic to anesthesia and list of patient's allergies (only medical related)
- Patient status and activation link (if `Patient.New` or `Patient.Inactive`)
- Date when this request was issued ( *dd-mm-yyyy* )
+ Response 200 (application/json)
{
"PatientNr": "string",
"HashedBSN": "string",
"AsaScore": "string",
"AnamneseDate": "string",
"AnamneseInfo": [
{
"AsaScore": 0,
"Question": "string",
"Answer": "string",
"QuestionId": 0
}
],
"NrOfMedicines": "string",
"MedicineInfo": [
{
"Name": "string",
"GenericName": "string",
"Dosage": "string",
"UsageStartDate": "string",
"UsageEndDate": "string",
"UsageQuantity": "string",
"UsageUnit": "string",
"UsageFrequencyNrTimes": "string",
"UsageFrequencyPeriod": "string",
"PrescriptionId": "string"
}
],
"NrOfMtiMessages": "string",
"AnesthesiaAllergy": "string",
"AllergyInfo": [
{
"Name": "string"
}
],
"InformationDate": "string",
"PatientStatus": "string",
"ActivationUrl": "string",
"Result": "string",
"Messages": [
"string"
]
}
## Get with BSN [/patient/get?practiceAgb={practiceAgb}&hashedBsn={hashedBsn}&token={token}]
+ Parameters
+ practiceAgb: 12345678 (required, number) - practice AGB code as an 8-digit number
+ hashedBsn: 8da1zf3402xaq2ry6w2 (required, string) - patient unique identifier
+ token: 1g4qq30l3hffqo9za8da1zf3402xaq2ry6w2k02lfjk9w3g284kkoiw5ycdgfup13yycdat9ta (required, string) - encrypted authentication token
### API Definition [GET]
***Description***
This method is used to get details about the given patient. The information
will be given for the patient identified by the hashed BSN and the practice AGB.
When hashing the BSN use only numbers.
***Usage***
The request must contain the `token`, the practice `AGB code` and the patient unique
`BSN` ( *in hashed format* ).
***Response***
| HTTP Code | API Code | Found in | Description |
| :--------: | :-------------------- | :-------------- | :------------------------------- |
| 400 | Practice.Missing | `message` field | No practice AGB given. |
| 400 | Patient.Missing | `message` field | No patient identifier given. |
| 400 | Token.Missing | `message` field | No Token was given. |
| 401 | ClientKey.NoAccess | `message` field | ClientKey is not valid. |
| 401 | Token.Expired | `message` field | Token is no longer valid. |
| 200 | Practice.NotFound | `Result` field | Practice was not found. |
| 200 | Practice.NoAccess | `Result` field | Client has no access to the specified practice.|
| 200 | Subscription.NotFound | `Result` field | Subscription was not found. |
| 200 | Subscription.Expired | `Result` field | Subscription has expired. |
| 200 | Customer.NotFound | `Result` field | Patient not found. |
| 200 | Patient.NotFound | `Result` field | Patient not found. |
| 200 | OK | `Result` field | Patient was found. |
| 200 | Unexpected.Error | `Result` field | Contact us via [email](<mailto:[email protected]>). |
In case of `OK`, the `Messages` field has the **AGB code** and the following
information about the patient is returned in the proper fields.
- BSN number ( *hashed* )
- Gender ( *m/f* ) and Birthdate ( *dd-mm-yyyy* )
- Height ( *cm* ) and Weight ( *kg* ) ( *if available* )
- Patient status and activation link (if `Patient.New` or `Patient.Inactive`)
- First Name, Last Name, Blood Group, City and Country ( *if available* )
- Date when this request was issued ( *dd-mm-yyyy* )
+ Response 200 (application/json)