-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathblueprint.apib
347 lines (296 loc) · 17.8 KB
/
blueprint.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
FORMAT: 1A
HOST: https://api.ffc.in.th/v1
# FFC API
เอกสารการใช้งาน **[FFC's RESTful API](https://github.com/ffc-nectec/api).**
## ภาพรวม การใช้งาน API
<img src="data\image\intro.svg" width="100%">
## FAQ
1. จะเข้าถึงข้อมูล ในส่วน Authorize เช่น person, house, user, ... ได้อย่างไร ถ้าหากยังไม่มี Organization<br/>
**ตอบ ไม่สามารถทำได้ จำเป็นต้องสร้าง Organization หรือ ไม่ก็ต้องมี Organization ในระบบอยู่แล้ว การมี Organization อยู่แล้วสามารถหมายถึงมีการใช้ FFC Airsync ที่เครื่อง JHCIS**
2. API สามารถใช้งานได้สมบูรณ์หรือยัง<br/>
**ตอบ ทางทีมผู้พัฒนาพยายามทำให้ API ทำงานได้สมบูรณ์ที่สุด หากท่านพบความผิดปกติ สามารถเข้าไปแจ้งได้ที่ [https://github.com/ffc-nectec/api/issues](https://github.com/ffc-nectec/api/issues)**
<!-- include(organization.md) -->
<!-- include(user.md) -->
<!-- include(village.md) -->
<!-- include(house.md) -->
<!-- include(person.md) -->
<!-- include(healthcare.md) -->
<!-- include(lookup.md) -->
<!-- include(design.md) -->
## Data Structures
# Organization (object)
+ Include Entity
+ type : `Organization` (string,fixed) - คงที่
+ name: `รพสต-พรทิพา1` (string)
+ displayName: `รพ.สต. พรทิพา 1` (string, optional)
+ avatarUrl: `https://ttm.sds.com/dsaefd.png` (string,optional)
+ tel: `037-323-043` (string,optional)
+ address: `amed คลองหลือง 111` (string,optional)
+ location (Point,optional)
+ users (array[User])
+ link (Link,optional)
# Token (object)
+ user (User) - ข้อมูลของ user
+ token: `b1CfPvPRODzxOtvbXNNUUf6jMZiPLuZBvUQ6968slHsTtNvOHhxkmT66fOo5n3Ld` (string) - token สำหรับใช้งาน API
+ createDate: `2019-11-01T12:59:14.669+07:00` (string) - วันเวลาที่สร้าง token
+ expireDate: `2019-11-02T12:59:14.669+07:00` (string) - วันเวลาที่ token หมดอายุ
# Agreement (object)
+ version: `de664cdd3df4bda583db27a51c1e95cc` (string) - เลข version เอกสาร
+ agreeTime: `2019-10-24T01:18:18.850+07:00` (string) - เวลาที่ยอมรับ
# User (object)
+ Include Entity
+ type: `User` (string, fixed) - ค่าคงที่
+ name: `สุวรรณ` (string)
+ password: `dlcfesdoiqplq` (string)
+ orgId: `5db0973f698922acf8b802fa` (string) - รหัส id ของหน่วยงาน
+ displayName: `นางสาว สุวรรณ คงดี` (string, optional)
+ avatarUrl: `https://ttm.sds.com/dsaefd.png` (string, optional)
+ tel: `064-87-323-43` (string, optional)
+ isActivated: true (boolean)
+ activateTime: `2008-06-27` (string)
+ roles (array[Role])
+ link (Link,optional)
# Role (enum)
+ ADMIN - ผู้ดูแล
+ PROVIDER - ผู้ให้บริการ เช่น หมอ, แพทย์
+ SURVEYOR - นักสำรวจ
+ PATIENT - user ทั่วไป เช่น ตัวผู้ป่วยเอง
+ SYNC_AGENT - ใช้สำหรับระบบ sync หากใส่ token จะไม่มีวันหมดอายุ
# Village (object)
+ name (string,required) - ชื่อหมู่บ้าน
+ orgId: `5db0973f698922acf8b802fa` (string) - รหัส id ของหน่วยงาน
+ location (Point) - ข้อมูลตำแหน่งหมู่บ้าน
+ places (array[Places])
+ link (Link)
# House (object)
+ Include Entity
+ Include Places
+ type: House - ค่าคงที่
+ identity (IdentityHouse) - ข้อมูลอัตลักษณ์บ้าน
+ people (array[Person])
+ haveChronic: true (boolean) - มีคนเป็นโรคเรื้อรังภายในบ้านหลังนี้หรือไม่
# Places (object)
+ villageId: 5db09741698922acf8b80436 (string) - รหัสหมู่บ้านที่ระบบสร้างให้
+ villageName: เขาดินดำ (string) - ชื่อหมู่บ้าน
+ orgId: 5db2a2a3698922acf8b99b46 (string) - รหัส id ของหน่วยงาน
+ no: 133 (string) - เลขที่บ้าน
+ road (string) - ถนน
+ location (Point,optional) - ข้อมูลเกี่ยวกับตำแหน่งบ้าน
+ link (Link)
+ imagesUrl (URLs) - ภาพบ้าน
# Point (object)
+ type: `Point` (string, fixed) - ค่าคงที่
+ coordinates: 99.99909549951553, 13.520111756593 (array[number]) - พิกัด GPS
# Person (object)
+ Include Entity
+ orgId: `5db0973f698922acf8b802fa` (string,required) - รหัส id ของหน่วยงาน
+ type: `Person` (string, fixed) - ค่าคงที่
+ identities (array[IdentityPerson]) - ข้อมูลอัตลักษณ์คน
+ chronics (array[Chronics]) - ข้อมูลโรคเรื้อรัง
+ disabilities (array[Disabilities]) - ข้อมูลความพิการ
+ behavior (Behavior, optional) - ข้อมูลพฤติกรรม
+ link (Link,optional)
+ relationships (array[Relationship]) - ความสัมพันธ์ทางสายเลือด
+ prename: `ด.ช.` (string,required) - คำนำหน้าชื่อ
+ firstname: `ปริศนา` (string,required) - ชื่อ
+ midname: `กัน` (string, optional)
+ lastname: `ยากยิ่ง` (string,required) - นามสกุล
+ sex (Sex) - เพศ
+ birthDate: `2008-06-27` (string, optional) - วันเกิด
+ houseId: `5db0973f698922acf8b8065b` (string) - รหัสบ้านที่ระบบสร้างให้
+ avatarUrl: `https://i.m.com/323223.png` (string,optional) - ภาพคน
+ death (Death,optional)
+ healthAnalyze (HealthAnalyzer,optional)
# HealthAnalyzer (object)
+ result (array[HealthIssue])
# HealthIssue (enum)
+ DM
+ HT
+ CVD
+ DEMENTIA
+ DEPRESSIVE
+ OA_KNEE
+ FARSIGHTED
+ NEARSIGHTED
+ CATARACT
+ GLAUCOMA
+ AMD
+ FALL_RISK
+ ACTIVITIES
# Death (object)
+ date: `2008-06-27` (string) - วันที่เสียชีวิต
+ causes (array[Disease]) - สาเหตุการเสียชีวิต ด้วยโรคอะไร
# Disabilities (object)
+ group (DisabilitiesGroup)
+ detectDate: `2008-06-27` (string) - วันที่ตรวจพบความพิการ
+ startDate: `2008-06-27` (string)
+ cause (DisabilitiesCause) - มีความพิการ
+ disease (Disease) - มีโรค
+ severity (Severity) - ระดับความรุนแรง
# DisabilitiesGroup (enum)
+ BLINDNESS - ตาบอด
+ DEAFNESS - การได้ยิน หูนวก
+ MOBILITY - การเคลื่อนไหว
+ MENTAL - ทางจิต
+ INTELLECTUAL - ทางปัญญา
+ LEARNING - ทางการเรียนรู้
+ AUTISM - ออทิสติก
# DisabilitiesCause (enum)
+ UNKNOWN - ไม่ทราบสาเหตุ
+ INBORN - ตั้งแต่เกิด
+ INJURED - ได้รับบาดเจ็บ
+ DISEASED - โรค
# Severity (enum)
+ UNDEFINED - ไม่ระบุ
+ OK - ปกติ
+ LOW - ต่ำ
+ MID - ปานกลาง
+ HI - สูง
+ VERY_HI - สูงมาก
# Chronics (object)
+ diagDate: `2019-10-25` (string) - วันที่ได้รับการวินิจฉัย
+ link (Link)
+ disease (Disease)
# Disease (object)
+ icd10: `J45.9` (string) - รหัส ICD10
+ isEpimedic: false (boolean) - อยู่ในกลุ่มโรคระบาดหรือไม่
+ isChronic: true (boolean) - อยู่ในกลุ่มโรคเรื้อรังหรือไม่
+ isNCD: false (boolean) - อยู่ในกลุ่มโรค NCDs หรือไม่
+ type: Icd10 (string, fixed) - ค่าคงที่
+ translation (Lang) - แปลในภาษาอื่น
+ th: `โรคหืด ไม่ระบุรายละเอียด`
+ id: `9c9067926ec740e28a3860c8d61690dc` (string) - id ที่ระบบสร้างให้
+ name: `Asthma, unspecified` (string) - ชื่อโรค
# Sex (enum)
+ MALE - ชาย
+ FEMALE - หญิง
+ UNKNOWN - ไม่ทราบเพศ
# IdentityPerson (object)
+ type: `thailand-citizen-id` (string, fixed) - ค่าคงที่สำหรับบอกว่าเป็นข้อมูลเลขบัตรประชาชน
+ id: `5437288765329` (string) - หมายเลขบัตรประชาชน
# IdentityHouse (object)
+ type: `thailand-household-id` (string, fixed) - ค่าคงที่สำหรับบอกว่าเป็นข้อมูลเลขบ้าน
+ id: `70040239874` (string) - หมายเลขประจำบ้าน เลขบ้าน
# Relationship (object)
+ relate: Father, Mother, Sibling, Twin, Married, Seperated, LegallySeperated, Divorced, Engaged, LoveAffair, Child (enum) - ความสัมพันธ์ทางสายเลือด
+ id: 5db31646698922acf8b9f807 (string) - รหัส id คนในระบบ
+ name: `น.ส.สุขสม เปลื้องทุกข์` (string) - ชื่อ นามสกุล
+ age: 23 (number)
# Link (object)
+ isSynced: true (boolean) - ข้อมูลนี้ได้รับการ sync ข้อมูลกลับไปยังฐานเดิมหรือยังเช่น sync ไป JHCISDB ที่เครื่อง J Server หรือยัง
+ lastSync: `2019-10-25T14:20:51.213+07:00` (string) - เวลาที่ sync ล่าสุด
+ system: `JHICS` (string, fixed) - ระบบที่ทำการ sync ด้วย
+ keys (object) - `เก็บคีย์ที่ใช้สำหรับการเชื่อม ระหว่าง HIS กับ FFC หรือข้อมูลจำเป็นอื่นๆ`
# URLs (array[string])
+ `https://i.simple/33232.png`,`https://i.simple/32.png`
# HealthCareService (object)
+ Include Service
+ type:`HealthCareService` (string,fixed) - ค่าคงที่
+ id: `73008541152448718e204a104a8d1a34` (string)
+ nextAppoint: `2019-01-09` (string, optional) - วันที่นัดครั้งต่อไป
+ syntom: `ติดตามเยี่ยมมารดาหลังคลอดครั้งที่3` (string, optional) - อาการ
+ suggestion: `แนะนำการดูแลมารดาหลังคลอด การเลียงดูบุตร ด้วยนมแม่ ให้คำแนะนำเรื่องวัคซีน และแรื่องสมุนไพรไพรการทับหม้อเกลือ` (string, optional) - คำแนะนำ
+ weight: 64.5 (number,optional) - น้ำหนัก
+ height: 158 (number,optional) - ส่วนสูง
+ waist: 78 (number,optional) - รอบเอว
+ ass: 34.4 (number,optional) - รอบสะโพก
+ bloodPressure (BloodPressure,optional) - ความดันเลือดวัดครั้งที่ 1
+ bloodPressure2nd (BloodPressure,optional) - ความดันเลือดวัดครั้งที่ 2
+ pulseRate: 96 (number,optional) - อัตราเต้นหัวใจ
+ respiratoryRate: 22 (number,optional) - อัตราการหายใจ
+ bodyTemperature: 36.5 (number,optional) - อุณหภูมิร่างกาย
+ sugarLab: 120 (number,optional) - ค่าระดับน้ำตาลจากผลแลป รพ.
+ diagnosises (array[Diagnosis]) - การวินิฉัยโรค
+ note: `เยี่ยมมารดาครั้งที่3` (string, optional) - จดบันทึกโน๊ต
+ photosUrl (URLs) - url รูปภาพการให้บริการ
+ communityServices (array[CommunityService] , fixed-type) - ให้บริการอะไร
+ ncdScreen (NCDScreen,optional) - ข้อมูลเกี่ยวกับ NCDs
+ specialPPs (array[SpecialPP])
# SpecialPP (object)
+ Include Service
+ type: `SpecialPP` (string,fixed) - ค่าคงที่
+ ppType (PPType)
# PPType (object)
+ Include Lookup
+ id: `1B52` (string)
+ name: `ผู้มารับบริการมีพฤติกรรมไม่เคยสูบบุหรี่` (string)
# NCDScreen (object)
+ Include Service
+ type: `NCDScreen` (string, fixed) - ค่าคงที่
+ hasDmInFamily: true (boolean) - มีคนเป็นเบาหวานในครอบครัวหรือไม่
+ hasHtInFamily: false (boolean) - มีคนเป็นความดันสูงในครอบครัวหรือไม่
+ smoke (Frequency) - ความถี่ในการสูบบุหรี่
+ alcohol (Frequency) - ความถี่ในการดื่ม alcohol
+ bloodSugar: 80 (number,optional) - ระดับน้ำตาลในเลือด
+ weight: 64.5 (number,optional) - น้ำหนัก
+ height: 158 (number,optional) - ส่วนสูง
+ waist: 78 (number,optional) - รอบเอว
+ bloodPressure (BloodPressure,optional) - ความดันเลือดวัดครั้งที่ 1
# Behavior(object)
+ ciga (Frequency) - ความถี่ในการสูบบุหรี่
+ alcohol (Frequency) - ความถี่ในการดื่ม alcohol
+ exercise (Frequency) - ความถี่ในการออกกำลังกาย
+ bigaccidentever: false (boolean) - เคยเกิดอุบัติเหตุใหญ่หรือไม่
+ tonic: false (boolean) - ดื่มเครื่องดื่มชูกำลังไหม
+ habitfoming: false (boolean) - ลักษ
+ drugbyyourseft: false (boolean) - ซื้อยากินเองไหม
+ sugar: false (boolean) - ทานหวานไหม
+ salt: false (boolean) - ทานเค็มไหม
+ timestamp: `2014-09-04T16:19:17.000+07:00` (string) - วันที่เกิดการเปลี่ยนแปลงล่าสุดกับข้อมูล
# Frequency (enum)
+ NEVER - ไม่เคย
+ RARELY - นานๆ ครั้ง
+ OCCASIONALLY - เป็นบางโอกาส
+ USUALLY - มักจะเกิดขึ้นบ่อยๆ
+ UNKNOWN - ไม่ทราบ
# CommunityService (object)
+ Include Entity
+ serviceType (ServiceType)
# HomeVisit (object)
+ Include ServiceType
+ detail: `แนะนำกระตุ้นพัฒนาการเด็กให้เหมาะสมกับวัย` (string)
+ result: `มารดามีความรู้และจะพาบุตรไปฉีดวัคซีน DTP+HB 1 อายุ 2 เดือน และตรวจพัฒนาการ` (string)
+ plan (string)
# ServiceType (object)
+ Include Lookup
+ id: `1A213` (string) - รหัสกิจกรรมการให้บริการปฐมภูมิในชุมชน
+ name: `เยี่ยมหญิงหลังคลอด ครั้งที่ 2 (4-6 สัปดาห์) ที่ไม่มีภาวะผิดปกติ` (string)
# Lookup (object)
+ type: `Lookup` (fixed)
+ translation (Lang)
+ link (Link)
# Lang (object)
+ en: `Cholera` (string)
+ th: `อหิวาตกโรค` (string)
# Template (object)
+ value: `สุขภาพแข็งแรง` (string) - เนื้อหา
+ field: `HealthCareService.syntom` (string) - เป็นเนื้อหาสำหรับ filed อะไร
+ orgId: `5dbbc89c698922acf8bc5789` (string, optional) - รหัส id ของหน่วยงาน
+ translation (Lang)
+ en: `healthy`
+ th: `สุขภาพแข็งแรง`
# Diagnosis (object)
+ disease (Disease)
+ dxType: PRINCIPLE_DX, CO_MORBIDITY, COMPLICATION, OTHER, EXTERNAL_CAUSE (enum)
+ isContinued: false (boolean)
# BloodPressure (object)
+ systolic: 110 (number)
+ diastolic: 62 (number)
# Service (object)
+ Include Entity
+ providerId: `5c07f94a6eabfa0004258b77` (string,required) - รหัส id ของ User(เจ้าหน้าที่)
+ patientId: `5dbd37ed698922acf8bc60e6` string,(required) - รหัส id ของผู้รับบริการ
+ time: `2018-11-12T12:49:11.000+07:00` (string) - เวลาเริ่มให้บริการ
+ endTime: `2018-11-12T12:55:33.000+07:00` (string) - เวลาที่ให้บริการเสร็จสิ้น
+ location (Point,optional)
+ link (Link,optional)
# Entity (object)
+ id: `5db31646698922acf8b9f807` (string) - รหัสคนที่ระบบสร้างให้
+ type (string, fixed) - ค่าคงที่
+ tags (array[string], fixed) - ใช้สำหรับติด tag ข้อมูล เพื่อให้สะดวกเวลาค้นหา
+ timestamp: `2014-09-04T16:19:17.000+07:00` (string) - วันที่เกิดการเปลี่ยนแปลงล่าสุดกับข้อมูล
# OTP (object)
+ otp: `366868` (string) - เลข otp
# Error (object)
+ code: 401 (number) - http return code
+ message: `โปรดทำการยืนยันตัวตน` (string) - ข้อความบอก error