โครงสร้างข้อมูลและสิทธิ์การเข้าถึง

 ตารางต่อไปนี้จะเป็นโครงสร้างข้อมูลของแต่ละ Object ที่ตอบสนองในแต่ละ endpoint โดยแต่ละ endpoint จะมีระดับการเข้าถึงจำนวนข้อมูลไม่เท่ากันขึ้นอยู่กับประเภทบัญชีผู้ใช้ ทุกบัญชีจะมีระดับการเข้าถึง ทั่วไป กรณีที่ท่านเป็น หน่วยงานราชการ ท่านสามารถส่งหนังสือถึง ผู้อำนวยการกองยุทธศาสตร์และแผนงาน ตามที่อยู่ใน ติดต่อ พร้อมระบุข้อมูลต่อไปนี้ เพื่อเปลี่ยนประเภทบัญชีผู้ใช้ให้เป็น บัญชีเจ้าหน้าที่รัฐ และได้สิทธิ์การเข้าถึงข้อมูลตาม ตารางประเภทบัญชีผู้ใช้

  1. สำเนาบัตรประชาชนพร้อมเซ็นสำเนาถูกต้อง (ชื่อ-สกุล ต้องตรงกับชื่อในบัญชีผู้ใช้)
  2. ตำแหน่งงาน
  3. ชื่อกระทรวง กรม กอง และกลุ่มงาน
  4. ชื่อบัญชีผู้ใช้
  5. จุดประสงค์การขอสิทธิ์เข้าถึงข้อมูลเพิ่มเติม ซึ่งรวมข้อมูลส่วนบุุคล
คำเตือน กรณีที่ท่านเปลี่ยน ชื่อจริง-นามสกุล ใน บัญชีผู้ใช้งาน โดยไม่ทำหนังสือแจ้งไปยัง ผู้อำนวยการกองยุทธศาสตร์และแผนงาน และส่งสำเนาบัตรประชาชนของผู้ใช้บัญชีใหม่ ประเภทบัญชีผู้ใช้จะถูกเปลี่ยนเป็นแบบ ทั่วไป ทันที

ข้อจำกัดการใช้งาน API

ทุกบัญชีจะมี Rate Limit หรือจำนวนการส่ง Request ที่จำกัดในการใช้ API เพื่อ reduce server load และป้องกัน Spam ดังตารางต่อไปนี้

ข้อจำกัด จำนวน
request / นาที 60
request / วัน 1000
ตารางประเภทบัญชีผู้ใช้
ที่ ประเภทบัญชีผู้ใช้งาน ตัวย่อ
1 กระทรวงสาธารณสุข M
2 หน่วยงานรัฐ นอกกระทรวงสาธารณสุข G
3 ทั่วไป N
หน่วยงานบริการสุขภาพ

endpoint -> https://hcode.moph.go.th/api/health_office/
หมายเหตุ ฟิลด์ "display_address" ถูกนำออกเพื่อลด loop ฟังก์ชัน และทำให้เกิดความเข้าใจผิดกับฟิลด์ "address" สำหรับที่อยู่ที่ import จากฐานข้อมูลเดิม ข้อมูลเพิ่มเติมจะอยู่ใน "address" -> "details" และ "soi" จะแสดงเป็นชื่อ "alley"

สิทธิ์การเข้าถึง endpoint
ที่ ประเภทบัญชี สิทธิ์การเข้าถึง
1 M
2 G
3 N
สิทธิ์การเข้าถึงฟิลด์
ที่ ชื่อฟิลด์ ประเภท รายละเอียด M G N
1 id integer เลขไอดี
2 name string ชื่อหน่วยงานบริการสุขภาพ
3 hcode9 string รหัสหน่วยงานบริการสุขภาพรูปแบบผสม 9 หลัก
4 code9 string รหัสหน่วยงานบริการสุขภาพ 9 หลัก
5 code5 string รหัสหน่วยงานบริการสุขภาพ 5 หลัก
6 private_code string เลขใบอนุญาตเป็นผู้ดำเนินการในสถานประกอบการเพื่อสุขภาพ 11 หลัก (ส.พ.7)
7 organization_type string ประเภทองค์กร
8 health_office_type string ประเภทหน่วยงานบริการสุขภาพ
9 hospital_level string ระดับโรงพยาบาล (เฉพาะโรงพยาบาลรัฐ)
10 organization string สังกัด
11 department string แผนกหรือหน่วยงาน
12 active boolean สถานะการเปิดให้งาน
13 address array ที่อยู่
14 established_date date วันที่ก่อตั้ง
15 closed_date date วันที่ปิดกิจการ
16 bed integer เตียงผู้ป่วยที่ใช้จริง (เฉพาะโรงพยาบาลรัฐ และโรงพยาบาลเอกชน)
17 bed_specified integer เตียงผู้ป่วยตามกรอบ (เฉพาะโรงพยาบาลรัฐ)
18 service_type string ประเภทการบริการ
19 service_level string ระดับการบริการ
20 hdc boolean หน่วยบริการส่งข้อมูลให้ HDC (Health Data Center) หรือไม่
21 is_client_hospital boolean เป็นโรงพยาบาลลูกข่ายหรือไม่ (เฉพาะโรงพยาบาลรัฐ)
22 host_agency string หน่วยงานแม่ข่าย สามารถกรองด้วย ชื่อ, รหัส 9 หลัก หรือรหัส 5 หลัก ในการกรองให้เลือกอย่างใดอย่างหนึ่ง (แนะนำใช้รหัส 9 หลัก)
23 send_hdc_with_agency boolean ส่งข้อมูล HDC ร่วมกับโรงพยาบาลแม่ข่ายหรือไม่ (เฉพาะโรงพยาบาลรัฐ)
24 client_health_office_type string ประเภทโรงพยาบาลลูกข่าย (เฉพาะโรงพยาบาลรัฐ)
25 contact array ช่องทางการติดต่อ
26 notes array หมายเหตุ หรือโน้ต
27 modified_date datetime วันเวลาล่าสุดที่มีการเปลี่ยนแปลงข้อมูล
ประเภทองค์กร

endpoint -> https://hcode.moph.go.th/api/organization_type/

สิทธิ์การเข้าถึง endpoint
ที่ ประเภทบัญชี สิทธิ์การเข้าถึง
1 M
2 G
3 N
สิทธิ์การเข้าถึง endpoint
ที่ ประเภทบัญชี สิทธิ์การเข้าถึง
1 M
2 G
3 N
สิทธิ์การเข้าถึงฟิลด์
ที่ ชื่อฟิลด์ ประเภท รายละเอียด M G N
1 id integer เลขไอดี
2 name string ชื่อประเภทองค์กร (รัฐบาล หรือ เอกชน)
3 en_name string ชื่อภาษาอังกฤษ
สังกัด

endpoint -> https://hcode.moph.go.th/api/organization/

สิทธิ์การเข้าถึง endpoint
ที่ ประเภทบัญชี สิทธิ์การเข้าถึง
1 M
2 G
3 N
สิทธิ์การเข้าถึงฟิลด์
ที่ ชื่อฟิลด์ ประเภท รายละเอียด M G N
1 id integer เลขไอดี
2 code string รหัส
3 name string ชื่อสังกัด
4 en_name string ชื่อภาษาอังกฤษ
5 organization_type string ประเภทองค์กร
6 active boolean สถานะการใช้งาน
หน่วยงาน หรือแผนก

endpoint -> https://hcode.moph.go.th/api/department/

สิทธิ์การเข้าถึง endpoint
ที่ ประเภทบัญชี สิทธิ์การเข้าถึง
1 M
2 G
3 N
สิทธิ์การเข้าถึงฟิลด์
ที่ ชื่อฟิลด์ ประเภท รายละเอียด M G N
1 id integer เลขไอดี
2 organization string สังกัด
3 code string รหัส
4 name string ชื่อหน่วยงาน หรือแผนก
5 en_name string ชื่อภาษาอังกฤษ
6 active boolean สถานะการใช้งาน
ประเภทหน่วยงานบริการสุขภาพ

endpoint -> https://hcode.moph.go.th/api/health_office_type/

สิทธิ์การเข้าถึง endpoint
ที่ ประเภทบัญชี สิทธิ์การเข้าถึง
1 M
2 G
3 N
สิทธิ์การเข้าถึงฟิลด์
ที่ ชื่อฟิลด์ ประเภท รายละเอียด M G N
1 id integer เลขไอดี
2 organization_type string ประเภทองค์กร
3 code string รหัส
4 name string ชื่อประเภทหน่วยงานบริการสุขภาพ
5 en_name string ชื่อภาษาอังกฤษ
6 client boolean สามารถเป็นหน่วยงานลูกข่ายได้
7 active boolean สถานะการใช้งาน
ระดับโรงพยาบาล (เฉพาะโรงพยาบาลรัฐ)

endpoint -> https://hcode.moph.go.th/api/hospital_level/

สิทธิ์การเข้าถึง endpoint
ที่ ประเภทบัญชี สิทธิ์การเข้าถึง
1 M
2 G
3 N
สิทธิ์การเข้าถึงฟิลด์
ที่ ชื่อฟิลด์ ประเภท รายละเอียด M G N
1 id integer เลขไอดี
2 code string รหัส
3 level string ระดับ
4 name string ชื่อระดับโรงพยาบาล
5 en_name string ชื่อภาษาอังกฤษ
6 description string คำอธิบาย
7 health_office_type string ประเภทหน่วยงานบริการสุขภาพ
ประเภทลูกข่าย

endpoint -> https://hcode.moph.go.th/api/client_health_office_type/

สิทธิ์การเข้าถึง endpoint
ที่ ประเภทบัญชี สิทธิ์การเข้าถึง
1 M
2 G
3 N
สิทธิ์การเข้าถึงฟิลด์
ที่ ชื่อฟิลด์ ประเภท รายละเอียด M G N
1 id integer เลขไอดี
2 name string ชื่อประเภทลูกข่าย
3 en_name string ชื่อภาษาอังกฤษ
ประเภทการบริการ

endpoint -> https://hcode.moph.go.th/api/service_type/

สิทธิ์การเข้าถึง endpoint
ที่ ประเภทบัญชี สิทธิ์การเข้าถึง
1 M
2 G
3 N
สิทธิ์การเข้าถึงฟิลด์
ที่ ชื่อฟิลด์ ประเภท รายละเอียด M G N
1 id integer เลขไอดี
2 code string รหัส
3 name string ชื่อประเภทการบริการ
4 en_name string ชื่อภาษาอังกฤษ
ระดับการบริการ

endpoint -> https://hcode.moph.go.th/api/service_level/

สิทธิ์การเข้าถึง endpoint
ที่ ประเภทบัญชี สิทธิ์การเข้าถึง
1 M
2 G
3 N
สิทธิ์การเข้าถึงฟิลด์
ที่ ชื่อฟิลด์ ประเภท รายละเอียด M G N
1 id integer เลขไอดี
2 code string รหัส
3 name string ชื่อประเภทการบริการ
4 en_name string ชื่อภาษาอังกฤษ
ประเทศ

endpoint -> https://hcode.moph.go.th/api/country/

สิทธิ์การเข้าถึง endpoint
ที่ ประเภทบัญชี สิทธิ์การเข้าถึง
1 M
2 G
3 N
สิทธิ์การเข้าถึงฟิลด์
ที่ ชื่อฟิลด์ ประเภท รายละเอียด M G N
1 id integer เลขไอดี
2 name string ชื่อประเทศ
3 code string รหัส
4 en_name string ชื่อภาษาอังกฤษ
โซนพิกัดฉาก หรือโซนพิกัดกริด

endpoint -> https://hcode.moph.go.th/api/utm_zone/

สิทธิ์การเข้าถึง endpoint
ที่ ประเภทบัญชี สิทธิ์การเข้าถึง
1 M
2 G
3 N
สิทธิ์การเข้าถึงฟิลด์
ที่ ชื่อฟิลด์ ประเภท รายละเอียด M G N
1 id integer เลขไอดี
2 name string ชื่อ
3 latitude float ละติจูด
4 longitude float ลองจิจูด
5 central_meridian float เมอริเดียนย่านกลาง
ภูมิภาค

endpoint -> https://hcode.moph.go.th/api/region/

สิทธิ์การเข้าถึง endpoint
ที่ ประเภทบัญชี สิทธิ์การเข้าถึง
1 M
2 G
3 N
สิทธิ์การเข้าถึงฟิลด์
ที่ ชื่อฟิลด์ ประเภท รายละเอียด M G N
1 id integer เลขไอดี
2 code string รหัส
3 name string ชื่อภูมิภาค
4 en_name string ชื่อภาษาอังกฤษ
เขตบริการสุขภาพ

endpoint -> https://hcode.moph.go.th/api/health_zone/

สิทธิ์การเข้าถึง endpoint
ที่ ประเภทบัญชี สิทธิ์การเข้าถึง
1 M
2 G
3 N
สิทธิ์การเข้าถึงฟิลด์
ที่ ชื่อฟิลด์ ประเภท รายละเอียด M G N
1 id integer เลขไอดี
2 name string ชื่อเขตบริการสุขภาพ
3 code string เลขเขตบริการสุขภาพ
ประเภทจังหวัด

endpoint -> https://hcode.moph.go.th/api/province_type/

สิทธิ์การเข้าถึง endpoint
ที่ ประเภทบัญชี สิทธิ์การเข้าถึง
1 M
2 G
3 N
สิทธิ์การเข้าถึงฟิลด์
ที่ ชื่อฟิลด์ ประเภท รายละเอียด M G N
1 id integer เลขไอดี
2 name string ชื่อประเภทจังหวัด
จังหวัด

endpoint -> https://hcode.moph.go.th/api/province/

สิทธิ์การเข้าถึง endpoint
ที่ ประเภทบัญชี สิทธิ์การเข้าถึง
1 M
2 G
3 N
สิทธิ์การเข้าถึงฟิลด์
ที่ ชื่อฟิลด์ ประเภท รายละเอียด M G N
1 id integer เลขไอดี
2 code string รหัส
3 name string ชื่อจังหวัด
4 code string รหัส
5 province_type string ประเภทจังหวัด
6 country string ประเทศ
7 region string ภูมิภาค
8 health_zone string เขตบริการสุขภาพ
9 utm_zone string โซนพิกัดฉาก
อำเภอ

endpoint -> https://hcode.moph.go.th/api/district/

สิทธิ์การเข้าถึง endpoint
ที่ ประเภทบัญชี สิทธิ์การเข้าถึง
1 M
2 G
3 N
สิทธิ์การเข้าถึงฟิลด์
ที่ ชื่อฟิลด์ ประเภท รายละเอียด M G N
1 id integer เลขไอดี
2 code string รหัส
3 name string ชื่ออำเภอ
4 en_name string ชื่อภาษาอังกฤษ
5 province string จังหวัด
ตำบล

endpoint -> https://hcode.moph.go.th/api/subdistrict/

สิทธิ์การเข้าถึง endpoint
ที่ ประเภทบัญชี สิทธิ์การเข้าถึง
1 M
2 G
3 N
สิทธิ์การเข้าถึงฟิลด์
ที่ ชื่อฟิลด์ ประเภท รายละเอียด M G N
1 id integer เลขไอดี
2 code string รหัส
3 name string ชื่อตำบล
4 en_name string ชื่อภาษาอังกฤษ
5 district string อำเภอ
6 subdistrict string ตำบล
ที่อยู่

endpoint -> https://hcode.moph.go.th/api/address/
หมายเหตุ ใช้สำหรับอ้างอิงฟิลด์ "address" ใน endpoint https://hcode.moph.go.th/api/health_office/ เท่านั้น ไม่สามารถ GET โดยตรงได้

สิทธิ์การเข้าถึง endpoint
ที่ ประเภทบัญชี สิทธิ์การเข้าถึง
1 M
2 G
3 N
สิทธิ์การเข้าถึงฟิลด์
ที่ ชื่อฟิลด์ ประเภท รายละเอียด M G N
1 id integer เลขไอดี
2 number string เลขที่อยู่
3 moo string หมู่
4 village string หมู่บ้าน
5 street string ถนน
6 alley string ซอย
7 building string ชื่ออาคาร
8 room string ห้อง
9 floor string ชั้น
10 is_double_space boolean รวมชั้นลอยหรือไม่ (ไม่เจาะจงว่าอยู่ชั้นไหน)
11 subdistrict string ตำบล
12 suddistrict_code string รหัสตำบล
13 district string อำเภอ
14 district_code string รหัสอำเภอ
15 province string จังหวัด
16 province_code string รหัสจังหวัด
17 province_type string ประเภทจังหวัด
18 region string ภูมิภาค
19 utm_zone string โซนพิกัดฉาก
20 zipcode string รหัสไปรษณีย์
21 details string รายละเอียด (ฟิลด์นี้สร้างเพื่อซัพพอร์ตการย้ายข้อมูลจากฐานข้อมูลเดิม
เนื่องจากฐานเดิมบันทึกที่อยู่เป็น string ชุดเดียว
ที่อยู่จากฐานข้อมูลก่อนวันที่ 1 กันยายน 2566 จะบันทึกในฟิลด์นี้)
22 latitude float ละติจูด
23 longitude float ลองจิจูด
ผู้ประสานงาน หรือเจ้าหน้าที่

endpoint -> https://hcode.moph.go.th/api/employee_contact/

สิทธิ์การเข้าถึง endpoint
ที่ ประเภทบัญชี สิทธิ์การเข้าถึง
1 M
2 G
3 N
สิทธิ์การเข้าถึงฟิลด์
ที่ ชื่อฟิลด์ ประเภท รายละเอียด M G N
1 id integer เลขไอดี
2 name ชื่อ-นามสกุล ผู้ประสานงาน หรือเจ้าหน้าที่ string
3 nickname string ชื่อเล่น
4 jobtitle string ชื่อตำแหน่ง
5 office string ชื่อหน่วยงาน
6 active boolean สถานะการใช้งาน
ช่องทางการติดต่อ

endpoint -> https://hcode.moph.go.th/api/contact_type/

สิทธิ์การเข้าถึง endpoint
ที่ ประเภทบัญชี สิทธิ์การเข้าถึง
1 M
2 G
3 N
สิทธิ์การเข้าถึงฟิลด์
ที่ ชื่อฟิลด์ ประเภท รายละเอียด M G N
1 id integer เลขไอดี
2 name string ชื่อ
3 en_name string ชื่อภาษาอังกฤษ
รายการติดต่อ

endpoint -> https://hcode.moph.go.th/api/contact/

สิทธิ์การเข้าถึง endpoint
ที่ ประเภทบัญชี สิทธิ์การเข้าถึง
1 M
2 G
3 N
สิทธิ์การเข้าถึงฟิลด์
ที่ ชื่อฟิลด์ ประเภท รายละเอียด M G N
1 id integer เลขไอดี
2 name string รายละเอียดของช่องทางการติดต่อ เช่น ชื่ออีเมล หรือ หมายเลขโทรศัพท์
3 contact_type string ชื่อช่องทางการติดต่อ
4 employee_contact string ชื่อผู้ประสานงาน หรือเจ้าหน้าที่
5 health_office string (hyperlink) หน่วยงานบริการสุขภาพ
6 active boolean สถานะการใช้งาน
หมวดหมู่หมายเหตุ หรือหมวดหมู่โน้ต

endpoint -> https://hcode.moph.go.th/api/note_category/

สิทธิ์การเข้าถึง endpoint
ที่ ประเภทบัญชี สิทธิ์การเข้าถึง
1 M
2 G
3 N
สิทธิ์การเข้าถึงฟิลด์
ที่ ชื่อฟิลด์ ประเภท รายละเอียด M G N
1 id integer เลขไอดี
2 name string ชื่อหมวดหมู่หมายเหตุ
3 en_name string ชื่อภาษาอังกฤษ
หมายเหตุ หรือโน้ต

endpoint -> https://hcode.moph.go.th/api/notes/

สิทธิ์การเข้าถึง endpoint
ที่ ประเภทบัญชี สิทธิ์การเข้าถึง
1 M
2 G
3 N
สิทธิ์การเข้าถึงฟิลด์
ที่ ชื่อฟิลด์ ประเภท รายละเอียด M G N
1 id integer เลขไอดี
2 note_category string ชื่อหมวดหมู่หมายเหตุ
3 name string ชื่อหัวเรื่อง
4 details string เนื้อหา
5 health_office string (hyperlink) หน่วยงานบริการสุขภาพ