{ "openapi": "3.1.0", "info": { "title": "Zapi — Health", "description": "Every Health endpoint on Zapi. Rendered catalog: https://zapi.ink/category/health", "version": "1.0.0", "license": { "name": "Zapi Terms of Service", "url": "https://zapi.ink/terms" } }, "servers": [ { "url": "https://api.zapi.ink" } ], "security": [ { "ApiKeyAuth": [] } ], "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "x-api-key" } }, "schemas": { "Envelope": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "success", "error" ] }, "message": { "type": "string" }, "content": {} } } }, "responses": { "Error": { "description": "Invalid key, rate limit, or upstream failure", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } } } }, "externalDocs": { "url": "https://zapi.ink/category/health/llms.txt" }, "paths": { "/v1/health:alodokter/list": { "get": { "operationId": "health_alodokter_list", "summary": "Daftar Artikel", "description": "Daftar artikel Alodokter (via sitemap, filter tahun/bulan + pagination).", "tags": [ "Alodokter" ], "externalDocs": { "url": "https://zapi.ink/api/health/alodokter#reference-list" }, "parameters": [ { "name": "year", "in": "query", "required": false, "description": "Tahun publikasi, default tahun berjalan (2014-2030)", "schema": { "type": "number" } }, { "name": "month", "in": "query", "required": false, "description": "Bulan publikasi (1-12), default bulan berjalan", "schema": { "type": "number" } }, { "name": "page", "in": "query", "required": false, "description": "Nomor halaman, default 1 (max 50)", "schema": { "type": "number" } }, { "name": "limit", "in": "query", "required": false, "description": "Item per halaman, default 20 (max 50)", "schema": { "type": "number" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "page": 1, "year": 2026, "count": 20, "items": [ { "url": "https://www.alodokter.com/ciri-ciri-kanker-payudara-akan-sembuh-yang-perlu-diketahui-pasien", "title": "Ciri Ciri Kanker Payudara Akan Sembuh Yang Perlu Diketahui Pasien", "source": "alodokter.com", "publishedAt": "2026-06-12 01:35:59 UTC" }, { "url": "https://www.alodokter.com/pewangi-pakaian-terbaik-untuk-cucian-lebih-harum-dan-lembut", "title": "Pewangi Pakaian Terbaik Untuk Cucian Lebih Harum Dan Lembut", "source": "alodokter.com", "publishedAt": "2026-06-12 00:31:37 UTC" }, { "url": "https://www.alodokter.com/sunscreen-anak-terbaik-untuk-melindungi-kulit-dari-paparan-sinar-matahari", "title": "Sunscreen Anak Terbaik Untuk Melindungi Kulit Dari Paparan Sinar Matahari", "source": "alodokter.com", "publishedAt": "2026-06-11 07:55:41 UTC" }, { "url": "https://www.alodokter.com/coklat-terbaik-dan-enak-di-pasaran", "title": "Coklat Terbaik Dan Enak Di Pasaran", "source": "alodokter.com", "publishedAt": "2026-06-11 07:54:50 UTC" }, { "url": "https://www.alodokter.com/gula-pasir-terbaik-yang-aman-untuk-keluarga", "title": "Gula Pasir Terbaik Yang Aman Untuk Keluarga", "source": "alodokter.com", "publishedAt": "2026-06-11 06:13:10 UTC" }, { "url": "https://www.alodokter.com/kopi-terbaik-dari-robusta-arabika-hingga-kopi-susu-kekinian", "title": "Kopi Terbaik Dari Robusta Arabika Hingga Kopi Susu Kekinian", "source": "alodokter.com", "publishedAt": "2026-06-11 05:58:42 UTC" }, { "url": "https://www.alodokter.com/es-krim-terbaik-yang-lezat-dan-menyegarkan", "title": "Es Krim Terbaik Yang Lezat Dan Menyegarkan", "source": "alodokter.com", "publishedAt": "2026-06-11 05:35:30 UTC" }, { "url": "https://www.alodokter.com/tumbler-terbaik-untuk-dukung-hidrasi-tubuh-sepanjang-hari", "title": "Tumbler Terbaik Untuk Dukung Hidrasi Tubuh Sepanjang Hari", "source": "alodokter.com", "publishedAt": "2026-06-11 02:06:47 UTC" } ], "limit": 20, "month": 6, "total": 86, "hasMore": true, "nextPage": 2 } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:alodokter/detail": { "get": { "operationId": "health_alodokter_detail", "summary": "Detail Artikel", "description": "Detail artikel Alodokter (penyakit/obat/editorial) dari URL, dengan reviewer & referensi.", "tags": [ "Alodokter" ], "externalDocs": { "url": "https://zapi.ink/api/health/alodokter#reference-detail" }, "parameters": [ { "name": "url", "in": "query", "required": true, "description": "URL halaman lengkap (penyakit, obat, atau artikel kesehatan)", "schema": { "type": "string", "example": "https://www.alodokter.com/demam-berdarah" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "url": "https://www.alodokter.com/demam-berdarah", "tags": [ "penyakit", "dbd", "demam-berdarah", "buavita-app", "buavita-dbd" ], "type": "disease", "image": "https://images.alodokter.com/dk0z4ums3/image/upload/v1685412960/attached_image/demam-berdarah.jpg", "title": "Demam Berdarah", "source": "alodokter.com", "content": "Demam berdarah adalah penyakit infeksi akibat virus yang menular melalui gigitan nyamuk. Penyakit ini menimbulkan gejala demam tinggi, sakit kepala, serta nyeri tulang dan otot. Jika tidak ditangani dengan tepat, demam berdarah berisiko mengancam nyawa. Demam berdarah atau DBD dapat menyerang anak-anak dan orang dewasa. Penyakit ini menular melalui gigitan nyamuk Aedes aegypti . Nyamuk tersebut dapat membawa virus Dengue setelah menggigit orang yang sedang terinfeksi, lalu menularkannya kepada orang lain melalui gigitan berikutnya. Penyakit ini banyak ditemukan di daerah beriklim tropis, termasuk Indonesia, dan angka kejadian penyakit ini biasanya meningkat ketika musim hujan .Virus Dengue dapat mengakibatkan dua kondisi, yaitu demam dengue dan demam berdarah dengue (DBD). Bedanya, demam berdarah dengue dapat menyebabkan gejala yang berat, sedangkan demam dengue biasanya hanya menimbulkan gejala ringan. Namun, tahap awal kedua kondisi ini memiliki gejala yang mirip. Penyebab Demam Berdarah Demam berdarah atau DBD disebabkan oleh virus Dengue . Seseorang bisa terjangkit demam berdarah jika digigit oleh nyamuk Aedes aegypti atau Aedes albopictus yang telah terinfeksi virus Dengue terlebih dahulu. Nyamuk penyebab demam berdarah biasanya aktif dan menggigit pada pagi dan sore hari. Nyamuk ini biasanya hidup di genangan air yang tenang dan dasarnya bersih, seperti genangan air di ban mobil, sampah plastik, atau tempat minum hewan. Demam berdarah tidak menular antarmanusia secara langsung. Namun, ibu hamil dapat menularkan demam berdarah kepada janin yang dikandungnya selama masa kehamilan atau ketika proses persalinan. Faktor risiko demam berdarah Demam berdarah lebih banyak terjadi saat musim hujan. Hal ini karena pada musim tersebut, nyamuk Aedes aegypti lebih banyak berkembang biak. Selain itu, seseorang lebih berisiko terkena DBD jika ia berada di daerah dengan kasus demam berdarah yang tinggi, terutama jika area tersebut padat penduduk. Selain itu, ada beberapa faktor yang dapat meningkatkan risiko pasien mengalami demam berdarah dengan gejala lebih berat, antara lain: Berusia anak-anak atau lansia Sedang hamil Memiliki daya tahan tubuh yang lemah Pernah menderita demam berdarah sebelumnya Gejala Demam Berdarah Gejala utama demam berdarah adalah naiknya suhu tubuh secara mendadak. Pada anak-anak, fase demam pada DBD berbentuk seperti pelana kuda , yaitu turun selama beberapa hari, kemudian naik lagi. Demam pada DBD umumnya berlangsung selama 2--7 hari. Demam bisa mencapai suhu 39−40°C dan sulit turun walaupun pasien telah mengonsumsi obat penurun panas. Selain demam, ada beberapa gejala lain yang dapat menyertainya, yaitu: Lemas Sakit kepala hebat Nyeri di bagian belakang mata Sakit otot dan sendi Hilang nafsu makan Mual dan muntah Ruam kemerahan yang timbul atau tidak timbul Selanjutnya, demam akan turun dan pasien merasa lebih baik. Namun, pada fase ini, kadar trombosit biasanya mulai menurun dan terjadi kebocoran plasma dari pembuluh darah. Akibatnya, pasien berisiko mengalami perdarahan dan syok karena pembuluh darah kehilangan banyak cairan. Fase setelah demam turun merupakan fase kritis sehingga pasien harus diawasi secara ketat. Tanda bahaya yang perlu diawasi pada fase ini antara lain: Nyeri perut yang berat Muntah-muntah tidak kunjung berhenti Lemas setelah sudah merasa membaik Gelisah Gusi berdarah atau mimisan Muntah berdarah Buang air besar berdarah Jantung berdebar Napas cepat Kulit dingin, pucat, dan basah Kapan Harus ke Dokter Periksakan diri ke dokter jika Anda atau anak Anda mendadak demam tinggi disertai gejala awal demam berdarah lainnya. Segera ke dokter jika mengalami tanda-tanda bahaya seperti yang telah disebutkan di atas setelah demam turun. Untuk memudahkan pemeriksaan, Anda juga bisa membuat janji dengan dokter melalui fitur booking dokter di aplikasi ALODOKTER, sehingga konsultasi dan penanganan dapat dilakukan lebih cepat. Diagnosis Demam Berdarah Diagnosis demam berdarah dilakukan dengan menanyakan gejala yang dialami pasien, riwayat perjalanannya, dan kejadian DBD di wilayah tempat tinggal pasien. Setelah itu, dokter akan melakukan pemeriksaan fisik secara menyeluruh. Pada pemeriksaan awal, dokter akan melakukan tourniquet test dengan alat pengukur tekanan darah. Tujuannya adalah untuk memeriksa risiko terjadinya kebocoran pembuluh darah. Guna memastikan diagnosis, dokter juga dapat melakukan rangkaian tes darah berikut ini: Pemeriksaan antigen NS1, untuk mendeteksi virus Dengue Pemeriksaan serologi IgG dan IgM dengue, untuk mendeteksi antibodi yang melawan virus Dengue Hitung darah lengkap, untuk melihat kadar trombosit dan sel darah putih Hematokrit, untuk melihat kebocoran pembuluh darah Tes fungsi hati, untuk melihat kadar enzim hati Pengobatan Demam Berdarah Tidak ada obat khusus yang dapat membunuh virus Dengue. Perawatan pasien demam berdarah berfokus untuk mengatasi gejala, menjaga energi pasien, serta mengoptimalkan kondisi tubuh dan mencegah komplikasi hingga infeksi membaik dengan sendirinya. Penanganan demam berdarah tahap awal bisa dilakukan di rumah selama tidak terdapat tanda bahaya. Namun, selama perawatan mandiri, pasien harus diawasi secara ketat. Selain itu, untuk mempercepat pemulihan, pasien perlu: Mencukupi kebutuhan cairan dengan minuman selain air putih, seperti susu, jus buah, cairan isotonik, atau oralit Mengonsumsi makanan dengan gizi lengkap dan seimbang Beristirahat yang cukup Menjaga suhu tubuh di bawah 39°C dengan menggunakan kompres hangat, mandi atau berendam air hangat (tidak panas), mengatur suhu ruangan yang sejuk, dan tidak memakai baju yang tidak terlalu tebal Minum paracetamol jika demam naik melebihi 39 0 C atau jika sakit kepala dan nyeri otot terasa mengganggu Jika terjadi tanda bahaya DBD, pasien harus segera dibawa ke IGD rumah sakit. Pengobatan yang diberikan di rumah sakit berupa: Infus cairan Pemantauan tekanan darah, kadar trombosit, kadar gula, kadar elektrolit darah, dan fungsi hati Transfusi darah jika terjadi komplikasi perdarahan yang parah Komplikasi Demam Berdarah Jika tidak tertangani dengan cepat, kebocoran pembuluh darah pada DBD dapat menyebabkan komplikasi yang berbahaya, antara lain: Penumpukan cairan pada rongga dada atau perut Perdarahan hebat Organ vital tubuh tidak mendapatkan aliran darah ( syok ) atau dengue shock syndrome Sementara jika terjadi pada ibu hamil, demam berdarah dapat menyebabkan komplikasi berupa: Keguguran Berat badan lahir rendah Bayi lahir prematur Bayi meninggal di dalam kandungan Perdarahan pascapersalinan Pencegahan Demam Berdarah Pencegahan demam berdarah bisa dilakukan dengan menjalankan program pemberantasan sarang nyamuk (PSN) dengan 3M Plus, yaitu: M enguras atau membersihkan penampungan air M enutup rapat penampungan air M endaur ulang atau membuang barang bekas P lus pencegahan tambahan, seperti fogging atau memperbaiki parit yang tidak lancar PSN 3M Plus ini harus dilakukan secara berkala untuk menciptakan lingkungan yang bersih dan terbebas dari nyamuk penyebab demam berdarah. DBD juga bisa dicegah dengan menjalani vaksin dengue . Vaksin ini bisa diberikan sejak usia 6 tahun, terutama pada orang yang tinggal di daerah dengan kasus dengue yang tinggi atau memiliki risiko terpapar virus Dengue. Namun, pemberian vaksin perlu disesuaikan dengan kondisi kesehatan dan riwayat infeksi dengue sebelumnya sehingga sebaiknya dikonsultasikan terlebih dahulu dengan dokter. Jika masih memiliki pertanyaan tentang demam berdarah atau vaksinasi dengue, Anda bisa berkonsultasi dengan dokter lewat Chat Bersama Dokter di aplikasi ALODOKTER, untuk mendapatkan informasi dan saran medis yang sesuai dengan kondisi Anda. Terakhir diperbarui: 29 Mei 2026", "summary": "Demam berdarah adalah penyakit infeksi akibat virus  yang menular melalui gigitan nyamuk. Penyakit ini menimbulkan gejala demam tinggi, sakit kepala, serta nyeri tulang dan otot. Jika", "reviewer": "dr. Marianti", "sections": [ "Penyebab Demam Berdarah", "Faktor risiko demam berdarah", "Gejala Demam Berdarah", "Kapan Harus ke Dokter", "Diagnosis Demam Berdarah", "Pengobatan Demam Berdarah", "Komplikasi Demam Berdarah", "Pencegahan Demam Berdarah" ], "updatedAt": "2026-06-01T16:22:01+07:00", "wordCount": 1088, "contentHtml": "\n\n

Demam berdarah adalah penyakit infeksi akibat virus  yang menular melalui gigitan nyamuk. Penyakit ini menimbulkan gejala demam tinggi, sakit kepala, serta nyeri tulang dan otot. Jika tidak ditangani dengan tepat, demam berdarah berisiko mengancam nyawa.

\n

Demam berdarah atau DBD dapat menyerang anak-anak dan orang dewasa. Penyakit ini menular melalui gigitan nyamuk Aedes aegypti. Nyamuk tersebut dapat membawa virus Dengue setelah menggigit orang yang sedang terinfeksi, lalu menularkannya kepada orang lain melalui gigitan berikutnya.

\n

\"Demam

\n

Penyakit ini banyak ditemukan di daerah beriklim tropis, termasuk Indonesia, dan angka kejadian penyakit ini biasanya meningkat ketika musim hujan.Virus Dengue dapat mengakibatkan dua kondisi, yaitu demam dengue dan demam berdarah dengue (DBD). 

\n

Bedanya, demam berdarah dengue dapat menyebabkan gejala yang berat, sedangkan demam dengue biasanya hanya menimbulkan gejala ringan. Namun, tahap awal kedua kondisi ini memiliki gejala yang mirip. 

\n

Penyebab Demam Berdarah

\n

Demam berdarah atau DBD disebabkan oleh virus Dengue. Seseorang bisa terjangkit demam berdarah jika digigit oleh nyamuk Aedes aegypti atau Aedes albopictus yang telah terinfeksi virus Dengue terlebih dahulu.

\n

Nyamuk penyebab demam berdarah biasanya aktif dan menggigit pada pagi dan sore hari. Nyamuk ini biasanya hidup di genangan air yang tenang dan dasarnya bersih, seperti genangan air di ban mobil, sampah plastik, atau tempat minum hewan.

\n

Demam berdarah tidak menular antarmanusia secara langsung. Namun, ibu hamil dapat menularkan demam berdarah kepada janin yang dikandungnya selama masa kehamilan atau ketika proses persalinan.

\n

Faktor risiko demam berdarah

\n

Demam berdarah lebih banyak terjadi saat musim hujan. Hal ini karena pada musim tersebut, nyamuk Aedes aegypti lebih banyak berkembang biak. Selain itu, seseorang lebih berisiko terkena DBD jika ia berada di daerah dengan kasus demam berdarah yang tinggi, terutama jika area tersebut padat penduduk.

\n

Selain itu, ada beberapa faktor yang dapat meningkatkan risiko pasien mengalami demam berdarah dengan gejala lebih berat, antara lain:

\n\n

Gejala Demam Berdarah

\n

Gejala utama demam berdarah adalah naiknya suhu tubuh secara mendadak. Pada anak-anak, fase demam pada DBD berbentuk seperti pelana kuda, yaitu turun selama beberapa hari, kemudian naik lagi.

\n

Demam pada DBD umumnya berlangsung selama 2--7 hari. Demam bisa mencapai suhu 39−40°C dan sulit turun walaupun pasien telah mengonsumsi obat penurun panas.

\n

Selain demam, ada beberapa gejala lain yang dapat menyertainya, yaitu:

\n\n

Selanjutnya, demam akan turun dan pasien merasa lebih baik. Namun, pada fase ini, kadar trombosit biasanya mulai menurun dan terjadi kebocoran plasma dari pembuluh darah. Akibatnya, pasien berisiko mengalami perdarahan dan syok karena pembuluh darah kehilangan banyak cairan.

\n

Fase setelah demam turun merupakan fase kritis sehingga pasien harus diawasi secara ketat. Tanda bahaya yang perlu diawasi pada fase ini antara lain:

\n\n

Kapan Harus ke Dokter

\n

Periksakan diri ke dokter jika Anda atau anak Anda mendadak demam tinggi disertai gejala awal demam berdarah lainnya. Segera ke dokter jika mengalami tanda-tanda bahaya seperti yang telah disebutkan di atas setelah demam turun.

\n

Untuk memudahkan pemeriksaan, Anda juga bisa membuat janji dengan dokter melalui fitur booking dokter di aplikasi ALODOKTER, sehingga konsultasi dan penanganan dapat dilakukan lebih cepat.

\n

Diagnosis Demam Berdarah

\n

Diagnosis demam berdarah dilakukan dengan menanyakan gejala yang dialami pasien, riwayat perjalanannya, dan kejadian DBD di wilayah tempat tinggal pasien.

\n

Setelah itu, dokter akan melakukan pemeriksaan fisik secara menyeluruh. Pada pemeriksaan awal, dokter akan melakukan tourniquet test dengan alat pengukur tekanan darah. Tujuannya adalah untuk memeriksa risiko terjadinya kebocoran pembuluh darah.

\n

Guna memastikan diagnosis, dokter juga dapat melakukan rangkaian tes darah berikut ini:

\n\n

Pengobatan Demam Berdarah

\n

Tidak ada obat khusus yang dapat membunuh virus Dengue. Perawatan pasien demam berdarah berfokus untuk mengatasi gejala, menjaga energi pasien, serta mengoptimalkan kondisi tubuh dan mencegah komplikasi hingga infeksi membaik dengan sendirinya.

\n

Penanganan demam berdarah tahap awal bisa dilakukan di rumah selama tidak terdapat tanda bahaya. Namun, selama perawatan mandiri, pasien harus diawasi secara ketat. Selain itu, untuk mempercepat pemulihan, pasien perlu:

\n\n

Jika terjadi tanda bahaya DBD, pasien harus segera dibawa ke IGD rumah sakit. Pengobatan yang diberikan di rumah sakit berupa:

\n\n

Komplikasi Demam Berdarah

\n

Jika tidak tertangani dengan cepat, kebocoran pembuluh darah pada DBD dapat menyebabkan komplikasi yang berbahaya, antara lain:

\n\n

Sementara jika terjadi pada ibu hamil, demam berdarah dapat menyebabkan komplikasi berupa:

\n\n

Pencegahan Demam Berdarah

\n

Pencegahan demam berdarah bisa dilakukan dengan menjalankan program pemberantasan sarang nyamuk (PSN) dengan 3M Plus, yaitu:

\n\n

PSN 3M Plus ini harus dilakukan secara berkala untuk menciptakan lingkungan yang bersih dan terbebas dari nyamuk penyebab demam berdarah.

\n

DBD juga bisa dicegah dengan menjalani vaksin dengue. Vaksin ini bisa diberikan sejak usia 6 tahun, terutama pada orang yang tinggal di daerah dengan kasus dengue yang tinggi atau memiliki risiko terpapar virus Dengue. Namun, pemberian vaksin perlu disesuaikan dengan kondisi kesehatan dan riwayat infeksi dengue sebelumnya sehingga sebaiknya dikonsultasikan terlebih dahulu dengan dokter.

\n

Jika masih memiliki pertanyaan tentang demam berdarah atau vaksinasi dengue, Anda bisa berkonsultasi dengan dokter lewat Chat Bersama Dokter di aplikasi ALODOKTER, untuk mendapatkan informasi dan saran medis yang sesuai dengan kondisi Anda.

\n\n\n \n\n\n \n
\n \n
\n\n \n \n\n
\n\n Terakhir diperbarui: 29 Mei 2026\n
", "lastUpdated": "1 Juni 2026", "publishedAt": "2014-06-27T16:25:05+07:00" } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:cdc/content-media-types": { "get": { "operationId": "health_cdc_content_media_types", "summary": "Content Media Types", "description": "CDC syndication media-type vocabulary — the names content-search's mediaType accepts. One-shot: the upstream returns the whole list in one response, so no page envelope.", "tags": [ "CDC" ], "externalDocs": { "url": "https://zapi.ink/api/health/cdc#reference-content-media-types" }, "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "count": 14, "items": [ { "name": "Badge", "mediaCount": 20, "description": "Badges", "displayOrder": 10 }, { "name": "Button", "mediaCount": 441, "description": "Buttons", "displayOrder": 20 }, { "name": "Feed", "mediaCount": 42, "description": "Managed Feed", "displayOrder": 50 }, { "name": "Feed - Import", "mediaCount": 10, "description": "Import Feed", "displayOrder": 60 }, { "name": "Feed - Aggregate", "mediaCount": 4, "description": "Aggregate Feed", "displayOrder": 75 }, { "name": "HTML", "mediaCount": 3884, "description": "HTML Content", "displayOrder": 80 }, { "name": "Image", "mediaCount": 32, "description": "Images", "displayOrder": 90 }, { "name": "Infographic", "mediaCount": 170, "description": "Infographics", "displayOrder": 100 } ], "provider": "cdc" } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:cdc/content-search": { "get": { "operationId": "health_cdc_content_search", "summary": "Content Search", "description": "CDC syndicated content (Public Health Media Library). `attribution` and `syndicateUrl` are what make an item legally reusable, so the mapper keeps every one of the 60 upstream fields rather than a summary subset.", "tags": [ "CDC" ], "externalDocs": { "url": "https://zapi.ink/api/health/cdc#reference-content-search" }, "parameters": [ { "name": "name", "in": "query", "required": false, "description": "Exact item title. The upstream matches the whole title, not a substring", "schema": { "type": "string", "example": "Asthma" } }, { "name": "mediaType", "in": "query", "required": false, "description": "Comma-separated media type names from the content-media-types endpoint", "schema": { "type": "string", "example": "HTML,Video" } }, { "name": "topicId", "in": "query", "required": false, "description": "Comma-separated topic ids from the content-topics endpoint", "schema": { "type": "string", "example": "5288" } }, { "name": "language", "in": "query", "required": false, "description": "Language display name such as English or Spanish", "schema": { "type": "string", "example": "Spanish" } }, { "name": "sort", "in": "query", "required": false, "description": "Sort order. Default newest by publication date", "schema": { "type": "string", "enum": [ "newest", "oldest", "recentlyUpdated", "leastRecentlyUpdated" ], "example": "newest" } }, { "name": "page", "in": "query", "required": false, "description": "Page number. Default 1", "schema": { "type": "number", "example": "1" } }, { "name": "limit", "in": "query", "required": false, "description": "Items per page. Default 20, max 100", "schema": { "type": "number", "example": "20" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "page": 1, "count": 0, "items": [], "limit": 3, "total": 0, "hasMore": false, "nextPage": null, "provider": "cdc", "totalPages": 0 } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:cdc/content-topics": { "get": { "operationId": "health_cdc_content_topics", "summary": "Content Topics", "description": "CDC syndication topic vocabulary — the ids that content-search's topicId accepts. Topics nest one level deep, so each row carries its sub-topics as `children`.", "tags": [ "CDC" ], "externalDocs": { "url": "https://zapi.ink/api/health/cdc#reference-content-topics" }, "parameters": [ { "name": "page", "in": "query", "required": false, "description": "Page number. Default 1", "schema": { "type": "number", "example": "1" } }, { "name": "limit", "in": "query", "required": false, "description": "Topics per page. Default 20, max 100", "schema": { "type": "number", "example": "20" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "page": 1, "count": 3, "items": [ { "name": "Data & Statistics", "topicId": 5495, "children": [ { "name": "Abortion Surveillance", "topicId": 5224, "language": "English", "childCount": 0, "mediaCount": 3, "description": "Sourced data from 2.6", "displayOrder": 0 }, { "name": "Active Bacterial Core surveillance (ABCs)", "topicId": 5229, "language": "English", "childCount": 0, "mediaCount": 2, "description": "Sourced data from 2.6", "displayOrder": 0 }, { "name": "Alcohol", "topicId": 5250, "language": "English", "childCount": 0, "mediaCount": 32, "description": "Sourced data from 2.6", "displayOrder": 0 }, { "name": "Alcohol Outlet Density", "topicId": 5251, "language": "English", "childCount": 0, "mediaCount": 0, "description": "Sourced data from 2.6", "displayOrder": 0 }, { "name": "Behavioral Risk Factor Surveillance System (BRFSS)", "topicId": 5304, "language": "English", "childCount": 0, "mediaCount": 0, "description": "Sourced data from 2.6", "displayOrder": 0 }, { "name": "Birth Defects", "topicId": 5314, "children": [ { "name": "Microcephaly", "topicId": 10784, "language": "English", "childCount": 0, "mediaCount": 2, "description": "Microcephaly", "displayOrder": 0 } ], "language": "English", "childCount": 1, "mediaCount": 47, "description": "Sourced data from 2.6", "displayOrder": 0 }, { "name": "BRFSS (Behavioral Risk Factor Surveillance System)", "topicId": 5343, "language": "English", "childCount": 0, "mediaCount": 1, "description": "Sourced data from 2.6", "displayOrder": 0 }, { "name": "Cancer Clusters", "topicId": 5359, "language": "English", "childCount": 0, "mediaCount": 1, "description": "Sourced data from 2.6", "displayOrder": 0 } ], "language": "English", "childCount": 73, "mediaCount": 707, "description": "Sourced data from 2.6", "displayOrder": 0 }, { "name": "Diseases & Conditions", "topicId": 5528, "children": [ { "name": "Acanthamoeba Infection", "topicId": 5225, "language": "English", "childCount": 0, "mediaCount": 0, "description": "Sourced data from 2.6", "displayOrder": 0 }, { "name": "Acinetobacter Infection", "topicId": 5228, "language": "English", "childCount": 0, "mediaCount": 1, "description": "Sourced data from 2.6", "displayOrder": 0 }, { "name": "Adenovirus Infection", "topicId": 5233, "language": "English", "childCount": 0, "mediaCount": 3, "description": "Sourced data from 2.6", "displayOrder": 0 }, { "name": "ADHD (Attention Deficit/Hyperactivity Disorder)", "topicId": 5234, "language": "English", "childCount": 0, "mediaCount": 4, "description": "Sourced data from 2.6", "displayOrder": 0 }, { "name": "Allergies", "topicId": 5253, "language": "English", "childCount": 0, "mediaCount": 2, "description": "Sourced data from 2.6", "displayOrder": 0 }, { "name": "ALS (Amyotrophic Lateral Sclerosis)", "topicId": 5254, "language": "English", "childCount": 0, "mediaCount": 9, "description": "Sourced data from 2.6", "displayOrder": 0 }, { "name": "Alzheimer's Disease", "topicId": 5255, "language": "English", "childCount": 0, "mediaCount": 12, "description": "Sourced data from 2.6", "displayOrder": 0 }, { "name": "Amebiasis, Intestinal (Entamoeba histolytica infection)", "topicId": 5256, "language": "English", "childCount": 0, "mediaCount": 1, "description": "Sourced data from 2.6", "displayOrder": 0 } ], "language": "English", "childCount": 510, "mediaCount": 6922, "description": "Sourced data from 2.6", "displayOrder": 0 }, { "name": "Emergency Preparedness", "topicId": 5565, "children": [ { "name": "Acute-Care Hospitals", "topicId": 5232, "language": "English", "childCount": 0, "mediaCount": 1, "description": "Sourced data from 2.6", "displayOrder": 0 }, { "name": "Advanced Molecular Detection", "topicId": 5238, "language": "English", "childCount": 0, "mediaCount": 4, "description": "Sourced data from 2.6", "displayOrder": 0 }, { "name": "Anthrax", "topicId": 5270, "language": "English", "childCount": 0, "mediaCount": 15, "description": "Sourced data from 2.6", "displayOrder": 0 }, { "name": "Bacterial Special Pathogens Branch (BSPB)", "topicId": 5296, "language": "English", "childCount": 0, "mediaCount": 1, "description": "Sourced data from 2.6", "displayOrder": 0 }, { "name": "Bioterrorism", "topicId": 5310, "language": "English", "childCount": 0, "mediaCount": 2, "description": "Sourced data from 2.6", "displayOrder": 0 }, { "name": "Bioterrorism Agents/Diseases", "topicId": 5311, "language": "English", "childCount": 0, "mediaCount": 2, "description": "Sourced data from 2.6", "displayOrder": 0 }, { "name": "Blood Safety", "topicId": 5323, "language": "English", "childCount": 0, "mediaCount": 3, "description": "Sourced data from 2.6", "displayOrder": 0 }, { "name": "Blood supply safety", "topicId": 5324, "language": "English", "childCount": 0, "mediaCount": 2, "description": "Sourced data from 2.6", "displayOrder": 0 } ], "language": "English", "childCount": 64, "mediaCount": 787, "description": "Sourced data from 2.6", "displayOrder": 0 } ], "limit": 3, "total": 13, "hasMore": true, "nextPage": 2, "provider": "cdc", "totalPages": 5 } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:cdc/content/{mediaId}": { "get": { "operationId": "health_cdc_content", "summary": "Content", "description": "One CDC syndicated media item, with all 60 upstream fields kept. A retired or unknown id answers HTTP 200 with an empty result set rather than a 404, so emptiness is the not-found signal here.", "tags": [ "CDC" ], "externalDocs": { "url": "https://zapi.ink/api/health/cdc#reference-content" }, "parameters": [ { "name": "mediaId", "in": "path", "required": true, "description": "Media item id, as returned by the content-search endpoint", "schema": { "type": "number", "example": "405289" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "name": "Respiratory Infections and Asthma", "tags": [ { "id": 5288, "name": "Asthma", "type": "Topic", "language": "English" } ], "apiUrl": "https://tools.cdc.gov/api/v2/resources/media/405289.json", "author": "lza2", "source": { "name": "Centers for Disease Control and Prevention", "acronym": "CDC" }, "status": "Published", "mediaId": 405289, "embedUrl": "https://tools.cdc.gov/api/v2/resources/media/405289/embed.json", "language": { "name": "English", "isoCode": "eng", "isoCode2": "en" }, "provider": "cdc", "embedCode": "
", "mediaType": "HTML", "pageCount": 0, "sourceUrl": "https://www.cdc.gov/asthma/respiratory-infections/index.html", "targetUrl": "https://www.cdc.gov/asthma/respiratory-infections/index.html", "updatedAt": "2026-08-28T21:10:24Z", "childCount": 0, "contentUrl": "https://tools.cdc.gov/api/v2/resources/media/405289/content.html", "attribution": "
Content provided and maintained by the US Centers for Disease Control and Prevention (CDC). Please see our system usage guidelines and disclaimer.
", "description": "Information on flu, COVID, RSV and other respiratory infections and relation to asthma", "owningOrgId": "HCUG", "parentCount": 0, "publishedAt": "2026-08-28T04:00:00Z", "syndicateUrl": "https://tools.cdc.gov/api/v2/resources/media/405289/syndicate.json", "thumbnailUrl": "https://tools.cdc.gov/api/v2/resources/media/405289/thumbnail.png", "owningOrgName": "NATIONAL CENTER FOR ENVIRONMENTAL HEALTH", "persistentUrl": "https://tools.cdc.gov/api/v2/resources/purls/XXMPR", "alternateImages": [ { "id": 1347454, "url": "https://tools.cdc.gov/api/v2/resources/links/1347454.png", "name": "thumbnail", "type": "Thumbnail", "width": 155, "height": 84 }, { "id": 1352891, "url": "https://tools.cdc.gov/api/v2/resources/links/1352891.png", "name": "200x200", "type": "Sized Preview", "width": 200, "height": 200 }, { "id": 1358324, "url": "https://tools.cdc.gov/api/v2/resources/links/1358324.png", "name": "300x300", "type": "Sized Preview", "width": 300, "height": 300 } ], "isTopSyndicated": false, "contentUpdatedAt": "2026-08-28T04:00:00Z", "maintainingOrgId": "HCUG", "contentAuthoredAt": "2020-03-17T19:26:21Z", "contentReviewedAt": "2026-08-28T04:00:00Z", "maintainingOrgName": "NATIONAL CENTER FOR ENVIRONMENTAL HEALTH", "persistentUrlToken": "XXMPR", "syndicationUpdatedAt": "2026-08-28T21:10:24Z", "syndicationVisibleAt": "2026-08-28T04:00:00Z", "syndicationCapturedAt": "2020-03-18T17:18:49Z" } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:cdc/dataset-count/{datasetId}": { "get": { "operationId": "health_cdc_dataset_count", "summary": "Dataset Count", "description": "Row count for a CDC Socrata dataset, optionally under a SoQL filter. One-shot: the upstream has no page concept here, so no page/limit envelope.", "tags": [ "CDC" ], "externalDocs": { "url": "https://zapi.ink/api/health/cdc#reference-dataset-count" }, "parameters": [ { "name": "datasetId", "in": "path", "required": true, "description": "Socrata four-by-four dataset id. CDC retires ids, so resolve a current one through the datasets endpoint", "schema": { "type": "string", "example": "x9gk-5huc" } }, { "name": "where", "in": "query", "required": false, "description": "SoQL $where filter. Omit to count every row in the dataset", "schema": { "type": "string", "example": "year='2024'" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "total": 425880, "where": "year='2024'", "provider": "cdc", "datasetId": "x9gk-5huc" } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:cdc/dataset-rows/{datasetId}": { "get": { "operationId": "health_cdc_dataset_rows", "summary": "Dataset Rows", "description": "Rows from any CDC Socrata dataset via SoQL. The row shape is defined by the dataset's own column schema — NNDSS returns 11 fields, BRFSS 27 — so nothing here assumes a field name. Keys are camelCased and", "tags": [ "CDC" ], "externalDocs": { "url": "https://zapi.ink/api/health/cdc#reference-dataset-rows" }, "parameters": [ { "name": "datasetId", "in": "path", "required": true, "description": "Socrata four-by-four dataset id. CDC retires ids, so resolve a current one through the datasets endpoint", "schema": { "type": "string", "example": "x9gk-5huc" } }, { "name": "select", "in": "query", "required": false, "description": "SoQL $select. Supports count(), sum(), avg(), min(), max(), date_trunc_y, date_trunc_ym, date_trunc_ymd", "schema": { "type": "string", "example": "states,year,week,label,m1" } }, { "name": "where", "in": "query", "required": false, "description": "SoQL $where filter. Also supports within_circle()", "schema": { "type": "string", "example": "year='2024' AND label='Anthrax'" } }, { "name": "group", "in": "query", "required": false, "description": "SoQL $group — column list to aggregate by", "schema": { "type": "string", "example": "label" } }, { "name": "having", "in": "query", "required": false, "description": "SoQL $having filter on aggregated rows", "schema": { "type": "string", "example": "sum(m1) > 100" } }, { "name": "order", "in": "query", "required": false, "description": "SoQL $order. Use it whenever paging deeply", "schema": { "type": "string", "example": "sort_order ASC" } }, { "name": "query", "in": "query", "required": false, "description": "Full-text search across the whole row ($q)", "schema": { "type": "string", "example": "anthrax" } }, { "name": "excludeSystemFields", "in": "query", "required": false, "description": "Drop Socrata's :computed_region and :id columns. Default false", "schema": { "type": "string", "enum": [ "true", "false" ], "example": "true" } }, { "name": "page", "in": "query", "required": false, "description": "Page number. Default 1", "schema": { "type": "number", "example": "1" } }, { "name": "limit", "in": "query", "required": false, "description": "Rows per page. Default 100, max 1000", "schema": { "type": "number", "example": "100" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "page": 1, "count": 100, "items": [ { "m2": "0", "week": "1", "year": "2022", "label": "Anthrax", "m1Flag": "-", "m2Flag": "-", "m3Flag": "-", "m4Flag": "-", "states": "US RESIDENTS", "location2": "US RESIDENTS", "sortOrder": "20220100001" }, { "m2": "0", "week": "1", "year": "2022", "label": "Anthrax", "m1Flag": "-", "m2Flag": "-", "m3Flag": "-", "m4Flag": "-", "states": "NEW ENGLAND", "location2": "NEW ENGLAND", "sortOrder": "20220100002" }, { "m2": "0", "week": "1", "year": "2022", "label": "Anthrax", "m1Flag": "-", "m2Flag": "-", "m3Flag": "-", "m4Flag": "-", "states": "CONNECTICUT", "geocode": { "type": "Point", "coordinates": [ -72.738288, 41.575155 ] }, "location1": "CONNECTICUT", "sortOrder": "20220100003", "computedRegionHjspUmg2": "24", "computedRegionSkr5Azej": "1043" }, { "m2": "0", "week": "1", "year": "2022", "label": "Anthrax", "m1Flag": "-", "m2Flag": "-", "m3Flag": "-", "m4Flag": "-", "states": "MAINE", "geocode": { "type": "Point", "coordinates": [ -69.06137, 45.117911 ] }, "location1": "MAINE", "sortOrder": "20220100004", "computedRegionHjspUmg2": "49", "computedRegionSkr5Azej": "1725" }, { "m2": "0", "week": "1", "year": "2022", "label": "Anthrax", "m1Flag": "-", "m2Flag": "-", "m3Flag": "-", "m4Flag": "-", "states": "MASSACHUSETTS", "geocode": { "type": "Point", "coordinates": [ -71.481104, 42.151077 ] }, "location1": "MASSACHUSETTS", "sortOrder": "20220100005", "computedRegionHjspUmg2": "25", "computedRegionSkr5Azej": "1916" }, { "m2": "0", "week": "1", "year": "2022", "label": "Anthrax", "m1Flag": "-", "m2Flag": "-", "m3Flag": "-", "m4Flag": "-", "states": "NEW HAMPSHIRE", "geocode": { "type": "Point", "coordinates": [ -71.57139, 43.680429 ] }, "location1": "NEW HAMPSHIRE", "sortOrder": "20220100006", "computedRegionHjspUmg2": "26", "computedRegionSkr5Azej": "2405" }, { "m2": "0", "week": "1", "year": "2022", "label": "Anthrax", "m1Flag": "-", "m2Flag": "-", "m3Flag": "-", "m4Flag": "-", "states": "RHODE ISLAND", "geocode": { "type": "Point", "coordinates": [ -71.534637, 41.572574 ] }, "location1": "RHODE ISLAND", "sortOrder": "20220100007", "computedRegionHjspUmg2": "27", "computedRegionSkr5Azej": "2703" }, { "m2": "0", "week": "1", "year": "2022", "label": "Anthrax", "m1Flag": "-", "m2Flag": "-", "m3Flag": "-", "m4Flag": "-", "states": "VERMONT", "geocode": { "type": "Point", "coordinates": [ -72.662695, 44.075252 ] }, "location1": "VERMONT", "sortOrder": "20220100008", "computedRegionHjspUmg2": "28", "computedRegionSkr5Azej": "905" } ], "limit": 100, "total": null, "fields": [ "states", "year", "week", "label", "m1Flag", "m2", "m2Flag", "m3Flag" ], "hasMore": true, "nextPage": 2, "provider": "cdc", "datasetId": "x9gk-5huc" } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:cdc/dataset/{datasetId}": { "get": { "operationId": "health_cdc_dataset", "summary": "Dataset", "description": "One CDC dataset's metadata and column schema (Socrata views API). Socrata row shape is per-dataset, so this is the schema source that dataset-rows deliberately does not guess at.", "tags": [ "CDC" ], "externalDocs": { "url": "https://zapi.ink/api/health/cdc#reference-dataset" }, "parameters": [ { "name": "datasetId", "in": "path", "required": true, "description": "Socrata four-by-four dataset id. CDC retires ids, so resolve a current one through the datasets endpoint", "schema": { "type": "string", "example": "x9gk-5huc" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "name": "NNDSS Weekly Data", "tags": [ "nndss", "2022", "wonder", "2023", "2024", "2025" ], "owner": { "id": "jy77-2p5t", "name": "Nicole Pham", "type": "interactive", "screenName": "Nicole Pham" }, "author": { "id": "jy77-2p5t", "name": "Nicole Pham", "type": "interactive", "screenName": "Nicole Pham" }, "locked": false, "rights": [ "read" ], "columns": [ { "id": 554475832, "name": "Reporting Area", "stats": { "count": 1958040, "largest": "WYOMING", "nonNull": 1958040, "smallest": "Alabama", "nullCount": 0, "topValues": [ { "count": 17705, "value": "GUAM" }, { "count": 17705, "value": "INDIANA" }, { "count": 17705, "value": "EAST SOUTH CENTRAL" }, { "count": 17705, "value": "GEORGIA" }, { "count": 17705, "value": "HAWAII" }, { "count": 17705, "value": "ILLINOIS" }, { "count": 17705, "value": "DISTRICT OF COLUMBIA" }, { "count": 17705, "value": "EAST NORTH CENTRAL" } ], "cardinality": 1958040 }, "dataType": "text", "position": 1, "fieldName": "states", "renderType": "text" }, { "id": 554475833, "name": "Current MMWR Year", "stats": { "count": 1958040, "largest": "2026", "nonNull": 1958040, "smallest": "2022", "nullCount": 0, "topValues": [ { "count": 441490, "value": "2025" }, { "count": 425880, "value": "2024" }, { "count": 413070, "value": "2023" }, { "count": 400400, "value": "2022" }, { "count": 277200, "value": "2026" } ], "cardinality": 1958040 }, "dataType": "text", "position": 2, "fieldName": "year", "renderType": "text" }, { "id": 554475834, "name": "MMWR WEEK", "stats": { "count": 1958040, "largest": "53", "nonNull": 1958040, "smallest": "1", "nullCount": 0, "topValues": [ { "count": 40530, "value": "2" }, { "count": 40530, "value": "3" }, { "count": 40530, "value": "4" }, { "count": 40530, "value": "5" }, { "count": 40530, "value": "6" }, { "count": 40530, "value": "7" }, { "count": 40530, "value": "8" }, { "count": 40530, "value": "9" } ], "cardinality": 1958040 }, "dataType": "number", "position": 3, "fieldName": "week", "renderType": "number" }, { "id": 554475836, "name": "Label", "stats": { "count": 1958040, "largest": "Zika virus disease, non-congenital", "nonNull": 1958040, "smallest": "Anthrax", "nullCount": 0, "topValues": [ { "count": 16940, "value": "Cryptosporidiosis" }, { "count": 16940, "value": "Arboviral diseases, Eastern equine encephalitis virus disease" }, { "count": 16940, "value": "Cholera" }, { "count": 16940, "value": "Arboviral diseases, Chikungunya virus disease" }, { "count": 16940, "value": "Arboviral diseases, Powassan virus disease" }, { "count": 16940, "value": "Arboviral diseases, St. Louis encephalitis virus disease" }, { "count": 16940, "value": "Arboviral diseases, Jamestown Canyon virus disease" }, { "count": 16940, "value": "Chlamydia trachomatis infection" } ], "cardinality": 1958040 }, "dataType": "text", "position": 5, "fieldName": "label", "renderType": "text" }, { "id": 554475853, "name": "Current week", "stats": { "count": 1958040, "largest": "18198", "nonNull": 203193, "smallest": "1.0", "nullCount": 1754847, "topValues": [ { "count": 54812, "value": "1" }, { "count": 23154, "value": "2" }, { "count": 14189, "value": "3" }, { "count": 9900, "value": "4" }, { "count": 7377, "value": "5" }, { "count": 5920, "value": "6" }, { "count": 4961, "value": "7" }, { "count": 4079, "value": "8" } ], "cardinality": 1958040 }, "dataType": "number", "position": 6, "fieldName": "m1", "renderType": "number" }, { "id": 554475838, "name": "Current week, flag", "stats": { "count": 1958040, "largest": "U", "nonNull": 1877768, "smallest": "-", "nullCount": 80272, "topValues": [ { "count": 1798982, "value": "-" }, { "count": 71474, "value": "N" }, { "count": 7312, "value": "U" } ], "cardinality": 1958040 }, "dataType": "text", "position": 7, "fieldName": "m1_flag", "renderType": "text" }, { "id": 554475839, "name": "Previous 52 week Max", "stats": { "count": 1958040, "largest": "37668", "nonNull": 1745678, "smallest": "0.0", "nullCount": 212362, "topValues": [ { "count": 907857, "value": "0" }, { "count": 292049, "value": "1" }, { "count": 122266, "value": "2" }, { "count": 65543, "value": "3" }, { "count": 43737, "value": "4" }, { "count": 29055, "value": "5" }, { "count": 21538, "value": "6" }, { "count": 18219, "value": "7" } ], "cardinality": 1958040 }, "dataType": "number", "position": 8, "fieldName": "m2", "renderType": "number" }, { "id": 554475840, "name": "Previous 52 weeks Max, flag", "stats": { "count": 1958040, "largest": "NC", "nonNull": 1310748, "smallest": "-", "nullCount": 647292, "topValues": [ { "count": 1098386, "value": "-" }, { "count": 212362, "value": "NC" } ], "cardinality": 1958040 }, "dataType": "text", "position": 9, "fieldName": "m2_flag", "renderType": "text" } ], "rowsUrl": "https://data.cdc.gov/resource/x9gk-5huc.json", "category": "NNDSS", "isPublic": true, "provider": "cdc", "viewType": "tabular", "assetType": "dataset", "createdAt": "2021-07-20T14:27:50.000Z", "datasetId": "x9gk-5huc", "permalink": "https://data.cdc.gov/d/x9gk-5huc", "viewCount": 124337, "provenance": "official", "attribution": "Office of Public Health Data, Surveillance, and Technology, Centers for Disease Control and Prevention", "columnCount": 18, "description": "NNDSS - In this Table, provisional cases* of notifiable diseases are displayed for United States, U.S. territories, and Non-U.S. residents.\n\n\nNotes:\n• These are weekly cases of selected infectious national notifiable diseases, from the National Notifiable Diseases Surveillance System (NNDSS). NNDSS data reported by the 50 states, New York City, the District of Columbia, and the U.S. territories are collated and published weekly as numbered tables available at https://www.cdc.gov/nndss/infectious-disease/index.html. Cases reported by state health departments to CDC for weekly publication are subject to ongoing revision of information and delayed reporting. Therefore, numbers listed in later weeks may reflect changes made to these counts as additional information becomes available. Case counts in the tables are presented as published each week. See also Guide to Interpreting Provisional and Finalized NNDSS Data.\n\n• Notices, errata, and other notes are available in the Notice To Data Users page https://www.cdc.gov/nndss/infectious-disease/notice-to-data-users.html.\n\n• The list of national notifiable infectious diseases and conditions and their national surveillance case definitions are available at https://ndc.services.cdc.gov/. This list incorporates the Council of State and Territorial Epidemiologists (CSTE) position statements approved by CSTE for national surveillance.\n\nFootnotes:\n*Case counts for reporting years 2024 and 2025 are provisional and subject to change. Cases are assigned to the reporting jurisdiction submitting the case to NNDSS, if the case's country of usual residence is the U.S., a U.S. territory, unknown, or null (i.e. country not reported); otherwise, the case is assigned to the 'Non-U.S. Residents' category. Country of usual residence is currently not reported by all jurisdictions or for all conditions. For further information on interpretation of these data, see https://www.cdc.gov/nndss/docs/Readers-Guide-WONDER-Tables-20210421-508.pdf.\n†Previous 52 week maximum and cumulative YTD are determined from periods of time when the condition was reportable in the jurisdiction (i.e., may be less than 52 weeks of data or incomplete YTD data).\n• Please refer to the Stacks publication for weekly updates to the footnote for influenza-associated pediatric mortality.\nU: Unavailable — The reporting jurisdiction was unable to send the data to CDC or CDC was unable to process the data.\n-: No reported cases — The reporting jurisdiction did not submit any cases to CDC.\nN: Not reportable — The disease or condition was not reportable by law, statute, or regulation in the reporting jurisdiction.\nNN: Not nationally notifiable — This condition was not designated as being nationally notifiable.\nNP: Nationally notifiable but not published.\nNC: Not calculated — There is insufficient data available to support the calculation of this statistic.\nCum: Cumulative year-to-date counts.\nMax: Maximum — Maximum case count during the previous 52 weeks.", "displayType": "table", "publishedAt": "2022-01-18T19:31:36.000Z", "ratingCount": 0, "commentCount": 0, "customFields": { "Common Core": { "Bureau Code": "009:20", "Contact Name": "NNDSS Team", "Program Code": "009:020", "Contact Email": "NNDSSWeb@cdc.gov" } }, "averageRating": 0, "downloadCount": 26861, "rowsUpdatedAt": "2026-08-27T15:35:36.000Z", "hideFromCatalog": false, "publicationStage": "published", "metadataUpdatedAt": "2026-08-27T15:35:35.000Z", "rowIdentifierColumnId": 554475847 } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:cdc/datasets": { "get": { "operationId": "health_cdc_datasets", "summary": "Datasets", "description": "CDC open-data catalogue (Socrata discovery API) — no key, direct fetch. This is the only supported way to resolve a dataset id: CDC retires ids without", "tags": [ "CDC" ], "externalDocs": { "url": "https://zapi.ink/api/health/cdc#reference-datasets" }, "parameters": [ { "name": "query", "in": "query", "required": false, "description": "Free-text search across dataset titles, descriptions and columns", "schema": { "type": "string", "example": "nndss" } }, { "name": "only", "in": "query", "required": false, "description": "Restrict to one asset type. Default all types", "schema": { "type": "string", "enum": [ "dataset", "chart", "map", "filter", "href" ], "example": "dataset" } }, { "name": "categories", "in": "query", "required": false, "description": "Comma-separated category names to filter on", "schema": { "type": "string", "example": "NNDSS" } }, { "name": "tags", "in": "query", "required": false, "description": "Comma-separated tags to filter on, as listed on a dataset's tags field", "schema": { "type": "string", "example": "wonder" } }, { "name": "order", "in": "query", "required": false, "description": "Sort field. Default relevance", "schema": { "type": "string", "enum": [ "relevance", "name", "createdAt", "updatedAt", "pageViewsLastWeek", "pageViewsLastMonth", "pageViewsTotal" ], "example": "pageViewsTotal" } }, { "name": "page", "in": "query", "required": false, "description": "Page number. Default 1", "schema": { "type": "number", "example": "1" } }, { "name": "limit", "in": "query", "required": false, "description": "Items per page. Default 20, max 100", "schema": { "type": "number", "example": "20" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "page": 1, "count": 3, "items": [ { "url": "https://data.cdc.gov/NNDSS/NNDSS-Weekly-Data/x9gk-5huc", "name": "NNDSS Weekly Data", "tags": [ "2023", "2022", "2025", "nndss", "2024", "wonder" ], "type": "dataset", "owner": { "id": "jy77-2p5t", "name": "Nicole Pham", "type": "interactive" }, "domain": "data.cdc.gov", "locked": false, "backend": "nbe", "columns": [ { "name": "States", "dataType": "Number", "fieldName": ":@computed_region_hjsp_umg2", "description": "This column was automatically created in order to record in what polygon from the dataset 'States' (hjsp-umg2) the point in column 'geocode' is located. This enables the creation of region maps (choropleths) in the visualization canvas and data lens." }, { "name": "Reporting Area", "dataType": "Text", "fieldName": "states" }, { "name": "Label", "dataType": "Text", "fieldName": "label" }, { "name": "Cumulative YTD Current MMWR Year, flag", "dataType": "Text", "fieldName": "m3_flag" }, { "name": "Current MMWR Year", "dataType": "Text", "fieldName": "year" }, { "name": "Cumulative YTD Previous MMWR Year", "dataType": "Number", "fieldName": "m4" }, { "name": "MMWR WEEK", "dataType": "Number", "fieldName": "week" }, { "name": "Previous 52 week Max", "dataType": "Number", "fieldName": "m2" } ], "creator": { "id": "jy77-2p5t", "name": "Nicole Pham", "type": "interactive" }, "category": "NNDSS", "metadata": [ { "key": "Common-Core_Bureau-Code", "value": "009:20" }, { "key": "Common-Core_Contact-Name", "value": "NNDSS Team" }, { "key": "Common-Core_Program-Code", "value": "009:020" }, { "key": "Common-Core_Contact-Email", "value": "NNDSSWeb@cdc.gov" } ], "viewType": "tabular", "createdAt": "2021-07-20T14:27:50.000Z", "datasetId": "x9gk-5huc", "pageViews": { "total": 124337, "lastWeek": 1356, "lastMonth": 6533 }, "permalink": "https://data.cdc.gov/d/x9gk-5huc", "updatedAt": "2026-08-27T15:35:36.000Z", "provenance": "official", "attribution": "Office of Public Health Data, Surveillance, and Technology, Centers for Disease Control and Prevention", "description": "NNDSS - In this Table, provisional cases* of notifiable diseases are displayed for United States, U.S. territories, and Non-U.S. residents.\n\n\nNotes:\n• These are weekly cases of selected infectious national notifiable diseases, from the National Notifiable Diseases Surveillance System (NNDSS). NNDSS data reported by the 50 states, New York City, the District of Columbia, and the U.S. territories are collated and published weekly as numbered tables available at https://www.cdc.gov/nndss/infectious-disease/index.html. Cases reported by state health departments to CDC for weekly publication are subject to ongoing revision of information and delayed reporting. Therefore, numbers listed in later weeks may reflect changes made to these counts as additional information becomes available. Case counts in the tables are presented as published each week. See also Guide to Interpreting Provisional and Finalized NNDSS Data.\n\n• Notices, errata, and other notes are available in the Notice To Data Users page https://www.cdc.gov/nndss/infectious-disease/notice-to-data-users.html.\n\n• The list of national notifiable infectious diseases and conditions and their national surveillance case definitions are available at https://ndc.services.cdc.gov/. This list incorporates the Council of State and Territorial Epidemiologists (CSTE) position statements approved by CSTE for national surveillance.\n\nFootnotes:\n*Case counts for reporting years 2024 and 2025 are provisional and subject to change. Cases are assigned to the reporting jurisdiction submitting the case to NNDSS, if the case's country of usual residence is the U.S., a U.S. territory, unknown, or null (i.e. country not reported); otherwise, the case is assigned to the 'Non-U.S. Residents' category. Country of usual residence is currently not reported by all jurisdictions or for all conditions. For further information on interpretation of these data, see https://www.cdc.gov/nndss/docs/Readers-Guide-WONDER-Tables-20210421-508.pdf.\n†Previous 52 week maximum and cumulative YTD are determined from periods of time when the condition was reportable in the jurisdiction (i.e., may be less than 52 weeks of data or incomplete YTD data).\n• Please refer to the Stacks publication for weekly updates to the footnote for influenza-associated pediatric mortality.\nU: Unavailable — The reporting jurisdiction was unable to send the data to CDC or CDC was unable to process the data.\n-: No reported cases — The reporting jurisdiction did not submit any cases to CDC.\nN: Not reportable — The disease or condition was not reportable by law, statute, or regulation in the reporting jurisdiction.\nNN: Not nationally notifiable — This condition was not designated as being nationally notifiable.\nNP: Nationally notifiable but not published.\nNC: Not calculated — There is insufficient data available to support the calculation of this statistic.\nCum: Cumulative year-to-date counts.\nMax: Maximum — Maximum case count during the previous 52 weeks.", "displayType": "table", "publishedAt": "2022-01-18T19:31:36.000Z", "contactEmail": "NNDSSWeb@cdc.gov", "dataUpdatedAt": "2026-08-27T15:35:36.000Z", "downloadCount": 26861, "metadataUpdatedAt": "2026-08-27T15:35:35.000Z" }, { "url": "https://data.cdc.gov/NNDSS/NNDSS-TABLE-1JJ-Tuberculosis-to-Tularemia/tfu6-pjxh", "name": "NNDSS - TABLE 1JJ. Tuberculosis to Tularemia", "tags": [ "nedss", "netss", "nndss", "tuberculosis", "tularemia", "wonder", "2022" ], "type": "dataset", "owner": { "id": "vu8q-ns5k", "name": "aso7@cdc.gov", "type": "interactive" }, "domain": "data.cdc.gov", "locked": false, "backend": "nbe", "columns": [ { "name": "MMWR Year", "dataType": "Text", "fieldName": "mmwr_year" }, { "name": "Tuberculosis, Cum 2021†, flag", "dataType": "Text", "fieldName": "tuberculosis_cum_2021_flag" }, { "name": "Counties", "dataType": "Number", "fieldName": ":@computed_region_skr5_azej", "description": "This column was automatically created in order to record in what polygon from the dataset 'Counties' (skr5-azej) the point in column 'tableonejj' is located. This enables the creation of region maps (choropleths) in the visualization canvas and data lens." }, { "name": "States", "dataType": "Number", "fieldName": ":@computed_region_hjsp_umg2", "description": "This column was automatically created in order to record in what polygon from the dataset 'States' (hjsp-umg2) the point in column 'tableonejj' is located. This enables the creation of region maps (choropleths) in the visualization canvas and data lens." }, { "name": "Tularemia, Current week", "dataType": "Number", "fieldName": "tularemia_current_week" }, { "name": "Tularemia, Cum 2022†", "dataType": "Number", "fieldName": "tularemia_cum_2022" }, { "name": "MMWR Week", "dataType": "Number", "fieldName": "mmwr_week" }, { "name": "Tuberculosis, Previous 52 weeks Max†, flag", "dataType": "Text", "fieldName": "tuberculosis_previous_52_1" } ], "creator": { "id": "vu8q-ns5k", "name": "aso7@cdc.gov", "type": "interactive" }, "category": "NNDSS", "metadata": [ { "key": "Common-Core_Bureau-Code", "value": "009:20" }, { "key": "Common-Core_Contact-Name", "value": "CDC INFO" }, { "key": "Common-Core_Program-Code", "value": "009:020" }, { "key": "Common-Core_Contact-Email", "value": "cdcinfo@cdc.gov" } ], "viewType": "tabular", "createdAt": "2021-12-30T16:42:30.000Z", "datasetId": "tfu6-pjxh", "pageViews": { "total": 31762, "lastWeek": 30, "lastMonth": 1670 }, "permalink": "https://data.cdc.gov/d/tfu6-pjxh", "updatedAt": "2022-02-11T16:35:27.000Z", "provenance": "official", "attribution": "Division of Health Informatics and Surveillance (DHIS), Centers for Disease Control and Prevention", "description": "NNDSS - TABLE 1JJ. Tuberculosis to Tularemia – 2022. In this Table, provisional cases* of notifiable diseases are displayed for United States, U.S. territories, and Non-U.S. residents.\nNotes:\n\n•\tThese are weekly cases of selected infectious national notifiable diseases, from the National Notifiable Diseases Surveillance System (NNDSS). NNDSS data reported by the 50 states, New York City, the District of Columbia, and the U.S. territories are collated and published weekly as numbered tables available at https://www.cdc.gov/nndss/data-statistics/index.html. Cases reported by state health departments to CDC for weekly publication are subject to ongoing revision of information and delayed reporting. Therefore, numbers listed in later weeks may reflect changes made to these counts as additional information becomes available. Case counts in the tables are presented as published each week. See also Guide to Interpreting Provisional and Finalized NNDSS Data at https://www.cdc.gov/nndss/docs/Readers-Guide-WONDER-Tables-20210421-508.pdf.\n• Notices, errata, and other notes are available in the Notice To Data Users page at https://wonder.cdc.gov/nndss/NTR.html.\n•\tThe list of national notifiable infectious diseases and conditions and their national surveillance case definitions are available at https://ndc.services.cdc.gov/. This list incorporates the Council of State and Territorial Epidemiologists (CSTE) position statements approved by CSTE for national surveillance.\n\nFootnotes:\n\n*Case counts for reporting years 2021 and 2022 are provisional and subject to change. Cases are assigned to the reporting jurisdiction submitting the case to NNDSS, if the case's country of usual residence is the U.S., a U.S. territory, unknown, or null (i.e. country not reported); otherwise, the case is assigned to the 'Non-U.S. Residents' category. Country of usual residence is currently not reported by all jurisdictions or for all conditions. For further information on interpretation of these data, see https://www.cdc.gov/nndss/docs/Readers-Guide-WONDER-Tables-20210421-508.pdf.\n†Previous 52 week maximum and cumulative YTD are determined from periods of time when the condition was reportable in the jurisdiction (i.e., may be less than 52 weeks of data or incomplete YTD data).\nU: Unavailable — The reporting jurisdiction was unable to send the data to CDC or CDC was unable to process the data.\n-: No reported cases — The reporting jurisdiction did not submit any cases to CDC.\nN: Not reportable — The disease or condition was not reportable by law, statute, or regulation in the reporting jurisdiction.\nNN: Not nationally notifiable — This condition was not designated as being nationally notifiable.\nNP: Nationally notifiable but not published.\nNC: Not calculated — There is insufficient data available to support the calculation of this statistic.\nCum: Cumulative year-to-date counts.\nMax: Maximum — Maximum case count during the previous 52 weeks.", "displayType": "table", "publishedAt": "2022-01-14T21:25:39.000Z", "contactEmail": "cdcinfo@cdc.gov", "dataUpdatedAt": "2022-02-11T16:35:27.000Z", "downloadCount": 1801, "metadataUpdatedAt": "2022-01-19T19:19:53.000Z" }, { "url": "https://data.cdc.gov/NNDSS/NNDSS-TABLE-1PP-Viral-hemorrhagic-fevers-Sabia-vir/3nij-2pw6", "name": "NNDSS - TABLE 1PP. Viral hemorrhagic fevers, Sabia virus to Zika virus disease, non-congenital", "tags": [ "zika virus disease", "2022", "nedss", "netss", "nndss", "non-congenital", "sabia virus", "viral hemorrhagic fevers" ], "type": "dataset", "owner": { "id": "vu8q-ns5k", "name": "aso7@cdc.gov", "type": "interactive" }, "domain": "data.cdc.gov", "locked": false, "backend": "nbe", "columns": [ { "name": "Zika virus disease, non-congenital, Cum 2022†", "dataType": "Number", "fieldName": "zika_virus_disease_non_4" }, { "name": "Zika virus disease, non-congenital, Cum 2021†", "dataType": "Number", "fieldName": "zika_virus_disease_non_6" }, { "name": "Yellow fever, Current week", "dataType": "Number", "fieldName": "yellow_fever_current_week" }, { "name": "Viral hemorrhagic fevers§, Sabia virus¶, Current week", "dataType": "Number", "fieldName": "viral_hemorrhagic_fevers" }, { "name": "States", "dataType": "Number", "fieldName": ":@computed_region_hjsp_umg2", "description": "This column was automatically created in order to record in what polygon from the dataset 'States' (hjsp-umg2) the point in column 'tableonepp' is located. This enables the creation of region maps (choropleths) in the visualization canvas and data lens." }, { "name": "Counties", "dataType": "Number", "fieldName": ":@computed_region_skr5_azej", "description": "This column was automatically created in order to record in what polygon from the dataset 'Counties' (skr5-azej) the point in column 'tableonepp' is located. This enables the creation of region maps (choropleths) in the visualization canvas and data lens." }, { "name": "Zika virus disease, non-congenital, Current week, flag", "dataType": "Text", "fieldName": "zika_virus_disease_non_1" }, { "name": "Yellow fever, Cum 2021†, flag", "dataType": "Text", "fieldName": "yellow_fever_cum_2021_flag" } ], "creator": { "id": "vu8q-ns5k", "name": "aso7@cdc.gov", "type": "interactive" }, "category": "NNDSS", "metadata": [ { "key": "Common-Core_Bureau-Code", "value": "009:20" }, { "key": "Common-Core_Contact-Name", "value": "CDC INFO" }, { "key": "Common-Core_Program-Code", "value": "009:020" }, { "key": "Common-Core_Contact-Email", "value": "cdcinfo@cdc.gov" } ], "viewType": "tabular", "createdAt": "2022-01-03T14:47:50.000Z", "datasetId": "3nij-2pw6", "pageViews": { "total": 30680, "lastWeek": 14, "lastMonth": 820 }, "permalink": "https://data.cdc.gov/d/3nij-2pw6", "updatedAt": "2022-02-11T16:37:45.000Z", "provenance": "official", "attribution": "Division of Health Informatics and Surveillance (DHIS), Centers for Disease Control and Prevention", "description": "NNDSS - TABLE 1PP. Viral hemorrhagic fevers, Sabia virus to Zika virus disease, non-congenital – 2022. In this Table, provisional cases* of notifiable diseases are displayed for United States, U.S. territories, and Non-U.S. residents.\n\nNotes:\n\n•\tThese are weekly cases of selected infectious national notifiable diseases, from the National Notifiable Diseases Surveillance System (NNDSS). NNDSS data reported by the 50 states, New York City, the District of Columbia, and the U.S. territories are collated and published weekly as numbered tables available at https://www.cdc.gov/nndss/data-statistics/index.html. Cases reported by state health departments to CDC for weekly publication are subject to ongoing revision of information and delayed reporting. Therefore, numbers listed in later weeks may reflect changes made to these counts as additional information becomes available. Case counts in the tables are presented as published each week. See also Guide to Interpreting Provisional and Finalized NNDSS Data at https://www.cdc.gov/nndss/docs/Readers-Guide-WONDER-Tables-20210421-508.pdf.\n• Notices, errata, and other notes are available in the Notice To Data Users page at https://wonder.cdc.gov/nndss/NTR.html.\n•\tThe list of national notifiable infectious diseases and conditions and their national surveillance case definitions are available at https://ndc.services.cdc.gov/. This list incorporates the Council of State and Territorial Epidemiologists (CSTE) position statements approved by CSTE for national surveillance.\n\nFootnotes:\n\n*Case counts for reporting years 2021 and 2022 are provisional and subject to change. Cases are assigned to the reporting jurisdiction submitting the case to NNDSS, if the case's country of usual residence is the U.S., a U.S. territory, unknown, or null (i.e. country not reported); otherwise, the case is assigned to the 'Non-U.S. Residents' category. Country of usual residence is currently not reported by all jurisdictions or for all conditions. For further information on interpretation of these data, see https://www.cdc.gov/nndss/docs/Readers-Guide-WONDER-Tables-20210421-508.pdf.\n†Previous 52 week maximum and cumulative YTD are determined from periods of time when the condition was reportable in the jurisdiction (i.e., may be less than 52 weeks of data or incomplete YTD data).\nU: Unavailable — The reporting jurisdiction was unable to send the data to CDC or CDC was unable to process the data.\n-: No reported cases — The reporting jurisdiction did not submit any cases to CDC.\nN: Not reportable — The disease or condition was not reportable by law, statute, or regulation in the reporting jurisdiction.\nNN: Not nationally notifiable — This condition was not designated as being nationally notifiable.\nNP: Nationally notifiable but not published.\nNC: Not calculated — There is insufficient data available to support the calculation of this statistic.\nCum: Cumulative year-to-date counts.\nMax: Maximum — Maximum case count during the previous 52 weeks.", "displayType": "table", "publishedAt": "2022-01-14T21:51:56.000Z", "contactEmail": "cdcinfo@cdc.gov", "dataUpdatedAt": "2022-02-11T16:37:45.000Z", "downloadCount": 1801, "metadataUpdatedAt": "2022-01-19T19:48:42.000Z" } ], "limit": 3, "query": "nndss", "total": 294, "hasMore": true, "nextPage": 2, "provider": "cdc" } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:cdc/mortality-query": { "post": { "operationId": "health_cdc_mortality_query", "summary": "Mortality Query", "description": "CDC WONDER mortality query (D-series databases, D76 = Underlying Cause of Death). WONDER answers an incomplete request document with HTTP 500 carrying a parsed,", "tags": [ "CDC" ], "externalDocs": { "url": "https://zapi.ink/api/health/cdc#reference-mortality-query" }, "parameters": [ { "name": "database", "in": "query", "required": false, "description": "WONDER database code. Default D76, Underlying Cause of Death 1999-2020", "schema": { "type": "string", "example": "D76" } }, { "name": "groupBy", "in": "query", "required": false, "description": "Comma-separated group-by variable codes, up to 5. Default D76.V1-level1 (year). Location and urbanization codes are refused upstream", "schema": { "type": "string", "example": "D76.V1-level1" } }, { "name": "measures", "in": "query", "required": false, "description": "Comma-separated measure codes. Default deaths, population and crude rate", "schema": { "type": "string", "example": "D76.M1,D76.M2,D76.M3" } }, { "name": "showTotals", "in": "query", "required": false, "description": "Append a totals row. Default true", "schema": { "type": "string", "enum": [ "true", "false" ], "example": "true" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "count": 23, "items": [ { "type": "data", "year": "1999", "deaths": 2391399, "crudeRate": 857, "population": 279040168 }, { "type": "data", "year": "2000", "deaths": 2403351, "crudeRate": 854, "population": 281421906 }, { "type": "data", "year": "2001", "deaths": 2416425, "crudeRate": 848, "population": 284968955 }, { "type": "data", "year": "2002", "deaths": 2443387, "crudeRate": 849.5, "population": 287625193 }, { "type": "data", "year": "2003", "deaths": 2448288, "crudeRate": 843.9, "population": 290107933 }, { "type": "data", "year": "2004", "deaths": 2397615, "crudeRate": 818.8, "population": 292805298 }, { "type": "data", "year": "2005", "deaths": 2448017, "crudeRate": 828.4, "population": 295516599 }, { "type": "data", "year": "2006", "deaths": 2426264, "crudeRate": 813.1, "population": 298379912 } ], "title": "Underlying Cause of Death, 1999-2020 Results Form", "columns": [ { "key": "year", "code": "D76.V1-level1", "type": "group", "label": "Year" }, { "key": "deaths", "code": "D76.M1", "type": "measure", "label": "Deaths" }, { "key": "population", "code": "D76.M2", "type": "measure", "label": "Population" }, { "key": "crudeRate", "code": "D76.M3", "type": "measure", "label": "Crude Rate" } ], "groupBy": [ "D76.V1-level1" ], "vintage": "2020", "database": "D76", "measures": [ "D76.M1", "D76.M2", "D76.M3" ], "provider": "cdc", "databaseLabel": "Underlying Cause of Death, 1999-2020" } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": { "parameters": { "type": "string", "example": { "V_D76.V1": "2019" } }, "requestXml": { "type": "string", "example": "" } } } } } } } }, "/v1/health:cdc/tracking-content-areas": { "get": { "operationId": "health_cdc_tracking_content_areas", "summary": "Tracking Content Areas", "description": "Environmental Public Health Tracking content areas — the top of the contentArea → indicator → measure hierarchy. The gateway answers HTTP 200 even when it refuses: the real verdict is the", "tags": [ "CDC" ], "externalDocs": { "url": "https://zapi.ink/api/health/cdc#reference-tracking-content-areas" }, "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "count": 27, "items": [ { "name": "Air Quality", "shortName": "AQ", "contentAreaId": 11 }, { "name": "Asthma", "shortName": "AS", "contentAreaId": 3 }, { "name": "Biomonitoring: Population Exposures", "shortName": "BIO", "contentAreaId": 18 }, { "name": "Birth Defects", "shortName": "BD", "contentAreaId": 5 }, { "name": "Built Environment", "shortName": "BE", "contentAreaId": 42 }, { "name": "Cancer", "shortName": "CR", "contentAreaId": 9 }, { "name": "Childhood Cancers", "shortName": "CHCR", "contentAreaId": 10 }, { "name": "Childhood Lead Poisoning", "shortName": "CLP", "contentAreaId": 6 } ], "provider": "cdc" } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:cdc/tracking-indicators/{contentAreaId}": { "get": { "operationId": "health_cdc_tracking_indicators", "summary": "Tracking Indicators", "description": "Indicators inside one Environmental Public Health Tracking content area. The route carries no format segment — `/indicators/{id}/json` is a 400, verified", "tags": [ "CDC" ], "externalDocs": { "url": "https://zapi.ink/api/health/cdc#reference-tracking-indicators" }, "parameters": [ { "name": "contentAreaId", "in": "path", "required": true, "description": "Content area id from the tracking-content-areas endpoint", "schema": { "type": "number", "example": "1" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "count": 13, "items": [ { "name": "Arsenic in Community Water Systems (CWS)", "shortName": "Arsenic in CWS", "indicatorId": 42 }, { "name": "Atrazine in Community Water Systems (CWS)", "shortName": "Atrazine in CWS", "indicatorId": 82 }, { "name": "Di(2-ethylhexyl) phthalate (DEHP) in Community Water Systems (CWS)", "shortName": "DEHP in CWS", "indicatorId": 83 }, { "name": "Disinfection Byproducts in Community Water Systems (CWS)", "shortName": "Byproducts in CWS", "indicatorId": 43 }, { "name": "Nitrates in Community Water Systems (CWS)", "shortName": "Nitrates in CWS", "indicatorId": 44 }, { "name": "Per- and Polyfluoroalkyl Substances (PFAS) in Community Water Systems (CWS)", "shortName": "PFAS in Community Water Systems", "indicatorId": 139 }, { "name": "Perchlorate in Drinking Water", "shortName": "Perchlorate in Drinking Water", "indicatorId": 147 }, { "name": "Private Well Water", "shortName": "Pvt Well Wt", "indicatorId": 240 } ], "provider": "cdc", "contentAreaId": 1 } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:cdc/tracking-measures/{indicatorId}": { "get": { "operationId": "health_cdc_tracking_measures", "summary": "Tracking Measures", "description": "Measures published under one Environmental Public Health Tracking indicator. The route carries no format segment — `/measures/{id}/json` is a 400, verified", "tags": [ "CDC" ], "externalDocs": { "url": "https://zapi.ink/api/health/cdc#reference-tracking-measures" }, "parameters": [ { "name": "indicatorId", "in": "path", "required": true, "description": "Indicator id from the tracking-indicators endpoint", "schema": { "type": "number", "example": "42" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "count": 5, "items": [ { "name": "Annual Mean Concentration of Arsenic (µg/L)", "measureId": 769, "shortName": "Annual mean Arsenic concentrations (µg/L)", "temporalsSortedAscending": false }, { "name": "Annual Percent of CWS by Maximum Arsenic Concentrations (µg/L)", "measureId": 1047, "shortName": "Percent of CWS by annual maximum Arsenic concentrations (µg/L)", "temporalsSortedAscending": false }, { "name": "Annual Percent of CWS by Mean Arsenic Concentrations (µg/L)", "measureId": 1045, "shortName": "Percent of CWS by annual mean Arsenic concentrations (µg/L)", "temporalsSortedAscending": false }, { "name": "Annual Percent of People Served by CWS by Maximum Arsenic Concentrations (µg/L)", "measureId": 1048, "shortName": "Percent Population served by CWS by annual maximum Arsenic concentrations (µg/L)", "temporalsSortedAscending": false }, { "name": "Annual Percent of People Served by CWS by Mean Arsenic Concentrations (µg/L)", "measureId": 1046, "shortName": "Percent of population served by CWS by annual mean Arsenic concentrations (µg/L)", "temporalsSortedAscending": false } ], "provider": "cdc", "indicatorId": 42 } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:clinical-tables/answer-list": { "get": { "operationId": "health_clinical_tables_answer_list", "summary": "Answer List", "description": "LOINC answer list for one question code — clinicaltables.nlm.nih.gov, direct JSON. Sits outside the /api//v3/search grammar: its own path, one code in,", "tags": [ "Clinical Tables" ], "externalDocs": { "url": "https://zapi.ink/api/health/clinical-tables#reference-answer-list" }, "parameters": [ { "name": "loincNum", "in": "query", "required": true, "description": "LOINC code of the question whose answer list to return", "schema": { "type": "string", "example": "45592-3" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "count": 7, "items": [ { "code": "LA12637-7", "text": "Independent - no help or staff oversight at any time", "sequence": 1 }, { "code": "LA12638-5", "text": "Supervision - oversight, encouragement or cueing", "sequence": 2 }, { "code": "LA12639-3", "text": "Limited assistance - resident highly involved in activity; staff provide guided maneuvering of limbs or other non-weight-bearing assistance", "sequence": 3 }, { "code": "LA12640-1", "text": "Extensive assistance - resident involved in activity, staff provide weight-bearing support", "sequence": 4 }, { "code": "LA12641-9", "text": "Total dependence - full staff performance every time during entire 7-day period", "sequence": 5 }, { "code": "LA12642-7", "text": "Activity occurred only once or twice - activity did occur but only once or twice", "sequence": 6 }, { "code": "LA18614-0", "text": "Activity did not occur - activity did not occur or family and/or non-facility staff provided care 100% of the time for that activity over the entire 7-day period", "sequence": 7 } ], "loincNum": "45592-3", "provider": "clinical-tables" } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:clinical-tables/conditions": { "get": { "operationId": "health_clinical_tables_conditions", "summary": "Conditions", "description": "Problem-list conditions — clinicaltables.nlm.nih.gov `conditions`, direct JSON, no key. The service answers with a positional array [total, codes, extra, displayRows]", "tags": [ "Clinical Tables" ], "externalDocs": { "url": "https://zapi.ink/api/health/clinical-tables#reference-conditions" }, "parameters": [ { "name": "terms", "in": "query", "required": true, "description": "Search text. Several partial words are combined with an implicit AND", "schema": { "type": "string", "example": "asthma" } }, { "name": "page", "in": "query", "required": false, "description": "Page number. Default 1", "schema": { "type": "number", "example": "1" } }, { "name": "limit", "in": "query", "required": false, "description": "Items per page. Default 10, max 500. Page times limit may not exceed 7500", "schema": { "type": "number", "example": "10" } }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated fields returned as display strings. Allowed: primary_name, consumer_name, key_id, icd10cm_codes, icd10cm, term_icd9_code, term_icd9_text, word_synonyms, synonyms, info_link_data.", "schema": { "type": "string", "example": "primary_name,consumer_name,key_id" } }, { "name": "extraFields", "in": "query", "required": false, "description": "Comma-separated fields returned with their native types, so objects and arrays stay structured. Accepts field:alias. Allowed: primary_name, consumer_name, key_id, icd10cm_codes, icd10cm, term_icd9_code, term_icd9_text, word_synonyms, synonyms, info_link_data.", "schema": { "type": "string", "example": "synonyms,word_synonyms" } }, { "name": "searchFields", "in": "query", "required": false, "description": "Comma-separated fields the search text is matched against. Allowed: primary_name, consumer_name, key_id, icd10cm_codes, icd10cm, term_icd9_code, term_icd9_text, word_synonyms, synonyms, info_link_data.", "schema": { "type": "string", "example": "primary_name,consumer_name,key_id" } }, { "name": "codeField", "in": "query", "required": false, "description": "The single field to report as each item's code. Allowed: primary_name, consumer_name, key_id, icd10cm_codes, icd10cm, term_icd9_code, term_icd9_text, word_synonyms, synonyms, info_link_data.", "schema": { "type": "string", "example": "key_id" } }, { "name": "filter", "in": "query", "required": false, "description": "Elasticsearch query-string filter applied on top of the search text. It is not wildcarded automatically", "schema": { "type": "string", "example": "primary_name:asthma*" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "page": 1, "count": 3, "items": [ { "code": "366", "keyId": "366", "primaryName": "Asthma", "consumerName": "Asthma" }, { "code": "30572", "keyId": "30572", "synonyms": [ "asthma mild persistent" ], "primaryName": "Asthma - mild persistent", "consumerName": "Asthma - mild persistent" }, { "code": "30573", "keyId": "30573", "synonyms": [ "asthma moderate persistent" ], "primaryName": "Asthma - moderate persistent", "consumerName": "Asthma - moderate persistent" } ], "limit": 3, "terms": "asthma", "total": 5, "hasMore": true, "nextPage": 2, "provider": "clinical-tables" } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:clinical-tables/cosmic": { "get": { "operationId": "health_clinical_tables_cosmic", "summary": "Cosmic", "description": "COSMIC structural variants — clinicaltables.nlm.nih.gov `cosmic_struct`, direct JSON. The service answers with a positional array [total, codes, extra, displayRows]", "tags": [ "Clinical Tables" ], "externalDocs": { "url": "https://zapi.ink/api/health/clinical-tables#reference-cosmic" }, "parameters": [ { "name": "terms", "in": "query", "required": true, "description": "Search text. Several partial words are combined with an implicit AND", "schema": { "type": "string", "example": "deletion" } }, { "name": "page", "in": "query", "required": false, "description": "Page number. Default 1", "schema": { "type": "number", "example": "1" } }, { "name": "limit", "in": "query", "required": false, "description": "Items per page. Default 10, max 500. Page times limit may not exceed 7500", "schema": { "type": "number", "example": "10" } }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated fields returned as display strings. Allowed: BreakPointOrder, ChromFrom, ChromTo, Description, ID_STUDY, LocationFromMax, LocationFromMin, LocationToMax, LocationToMin, MutationID, MutationType, NonTemplatedInsSeq, PrimaryHistology, PrimarySite, Site, StrandFrom, StrandTo, GRChVer, COSMIC_STRUCTURAL_ID, COSMIC_PHENOTYPE_ID, COSMIC_STUDY_ID.", "schema": { "type": "string", "example": "MutationID,MutationType,Description" } }, { "name": "extraFields", "in": "query", "required": false, "description": "Comma-separated fields returned with their native types, so objects and arrays stay structured. Accepts field:alias. Allowed: BreakPointOrder, ChromFrom, ChromTo, Description, ID_STUDY, LocationFromMax, LocationFromMin, LocationToMax, LocationToMin, MutationID, MutationType, NonTemplatedInsSeq, PrimaryHistology, PrimarySite, Site, StrandFrom, StrandTo, GRChVer, COSMIC_STRUCTURAL_ID, COSMIC_PHENOTYPE_ID, COSMIC_STUDY_ID.", "schema": { "type": "string", "example": "ChromFrom,ChromTo" } }, { "name": "searchFields", "in": "query", "required": false, "description": "Comma-separated fields the search text is matched against. Allowed: BreakPointOrder, ChromFrom, ChromTo, Description, ID_STUDY, LocationFromMax, LocationFromMin, LocationToMax, LocationToMin, MutationID, MutationType, NonTemplatedInsSeq, PrimaryHistology, PrimarySite, Site, StrandFrom, StrandTo, GRChVer, COSMIC_STRUCTURAL_ID, COSMIC_PHENOTYPE_ID, COSMIC_STUDY_ID.", "schema": { "type": "string", "example": "MutationID,MutationType,Description" } }, { "name": "codeField", "in": "query", "required": false, "description": "The single field to report as each item's code. Allowed: BreakPointOrder, ChromFrom, ChromTo, Description, ID_STUDY, LocationFromMax, LocationFromMin, LocationToMax, LocationToMin, MutationID, MutationType, NonTemplatedInsSeq, PrimaryHistology, PrimarySite, Site, StrandFrom, StrandTo, GRChVer, COSMIC_STRUCTURAL_ID, COSMIC_PHENOTYPE_ID, COSMIC_STUDY_ID.", "schema": { "type": "string", "example": "MutationID" } }, { "name": "filter", "in": "query", "required": false, "description": "Elasticsearch query-string filter applied on top of the search text. It is not wildcarded automatically", "schema": { "type": "string", "example": "MutationType:deletion" } }, { "name": "genomeBuild", "in": "query", "required": false, "description": "GRCh human genome build the coordinates refer to. Default 37", "schema": { "type": "string", "enum": [ "37", "38" ], "example": "38" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "page": 1, "count": 3, "items": [ { "code": "119626", "chromTo": "7", "chromFrom": "7", "mutationID": "119626", "description": "chr7:g.(145808590_145808610)_(145874585_145874605)del", "mutationType": "intrachromosomal deletion" }, { "code": "119635", "chromTo": "18", "chromFrom": "18", "mutationID": "119635", "description": "chr18:g.(50962789_50962809)_(51078735_51078755)del", "mutationType": "intrachromosomal deletion" }, { "code": "119648", "chromTo": "13", "chromFrom": "13", "mutationID": "119648", "description": "chr13:g.(23495219_23495239)_(23495527_23495547)del", "mutationType": "intrachromosomal deletion" } ], "limit": 3, "terms": "deletion", "total": 49355, "hasMore": true, "nextPage": 2, "provider": "clinical-tables" } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:clinical-tables/cytogenetic-locations": { "get": { "operationId": "health_clinical_tables_cytogenetic_locations", "summary": "Cytogenetic Locations", "description": "Cytogenetic band locations — clinicaltables.nlm.nih.gov `cytogenetic_locs`, direct JSON, no key. The service answers with a positional array [total, codes, extra, displayRows]", "tags": [ "Clinical Tables" ], "externalDocs": { "url": "https://zapi.ink/api/health/clinical-tables#reference-cytogenetic-locations" }, "parameters": [ { "name": "terms", "in": "query", "required": true, "description": "Search text. Several partial words are combined with an implicit AND", "schema": { "type": "string", "example": "7q31" } }, { "name": "page", "in": "query", "required": false, "description": "Page number. Default 1", "schema": { "type": "number", "example": "1" } }, { "name": "limit", "in": "query", "required": false, "description": "Items per page. Default 10, max 500. Page times limit may not exceed 7500", "schema": { "type": "number", "example": "10" } }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated fields returned as display strings. Allowed: chromosome, arm, band, iscn_start, iscn_stop, stain, cytogenetic.", "schema": { "type": "string", "example": "cytogenetic,chromosome,arm" } }, { "name": "extraFields", "in": "query", "required": false, "description": "Comma-separated fields returned with their native types, so objects and arrays stay structured. Accepts field:alias. Allowed: chromosome, arm, band, iscn_start, iscn_stop, stain, cytogenetic.", "schema": { "type": "string", "example": "cytogenetic,chromosome" } }, { "name": "searchFields", "in": "query", "required": false, "description": "Comma-separated fields the search text is matched against. Allowed: chromosome, arm, band, iscn_start, iscn_stop, stain, cytogenetic.", "schema": { "type": "string", "example": "cytogenetic,chromosome,arm" } }, { "name": "codeField", "in": "query", "required": false, "description": "The single field to report as each item's code. Allowed: chromosome, arm, band, iscn_start, iscn_stop, stain, cytogenetic.", "schema": { "type": "string", "example": "cytogenetic" } }, { "name": "filter", "in": "query", "required": false, "description": "Elasticsearch query-string filter applied on top of the search text. It is not wildcarded automatically", "schema": { "type": "string", "example": "chromosome:7" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "page": 1, "count": 3, "items": [ { "arm": "q", "code": "7q31.1", "chromosome": "7", "cytogenetic": "7q31.1" }, { "arm": "q", "code": "7q31.31", "chromosome": "7", "cytogenetic": "7q31.31" }, { "arm": "q", "code": "7q31.33", "chromosome": "7", "cytogenetic": "7q31.33" } ], "limit": 3, "terms": "7q31", "total": 5, "hasMore": true, "nextPage": 2, "provider": "clinical-tables" } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:clinical-tables/dbvar": { "get": { "operationId": "health_clinical_tables_dbvar", "summary": "Dbvar", "description": "dbVar structural variants — clinicaltables.nlm.nih.gov `dbvar`, direct JSON, no key. The service answers with a positional array [total, codes, extra, displayRows]", "tags": [ "Clinical Tables" ], "externalDocs": { "url": "https://zapi.ink/api/health/clinical-tables#reference-dbvar" }, "parameters": [ { "name": "terms", "in": "query", "required": true, "description": "Search text. Several partial words are combined with an implicit AND", "schema": { "type": "string", "example": "nsv" } }, { "name": "page", "in": "query", "required": false, "description": "Page number. Default 1", "schema": { "type": "number", "example": "1" } }, { "name": "limit", "in": "query", "required": false, "description": "Items per page. Default 10, max 500. Page times limit may not exceed 7500", "schema": { "type": "number", "example": "10" } }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated fields returned as display strings. Allowed: Alias, ciend, cipos, clinical_int, copy_number, Dbxref, End_range, FeatureEnd, FeatureStart, gender, ID, Name, parent, phenotype, sampleset_name, sampleset_type, SeqID, Start_range, Type, var_origin, Zygosity.", "schema": { "type": "string", "example": "Name,Type,ID" } }, { "name": "extraFields", "in": "query", "required": false, "description": "Comma-separated fields returned with their native types, so objects and arrays stay structured. Accepts field:alias. Allowed: Alias, ciend, cipos, clinical_int, copy_number, Dbxref, End_range, FeatureEnd, FeatureStart, gender, ID, Name, parent, phenotype, sampleset_name, sampleset_type, SeqID, Start_range, Type, var_origin, Zygosity.", "schema": { "type": "string", "example": "Alias,Dbxref" } }, { "name": "searchFields", "in": "query", "required": false, "description": "Comma-separated fields the search text is matched against. Allowed: Alias, ciend, cipos, clinical_int, copy_number, Dbxref, End_range, FeatureEnd, FeatureStart, gender, ID, Name, parent, phenotype, sampleset_name, sampleset_type, SeqID, Start_range, Type, var_origin, Zygosity.", "schema": { "type": "string", "example": "Name,Type,ID" } }, { "name": "codeField", "in": "query", "required": false, "description": "The single field to report as each item's code. Allowed: Alias, ciend, cipos, clinical_int, copy_number, Dbxref, End_range, FeatureEnd, FeatureStart, gender, ID, Name, parent, phenotype, sampleset_name, sampleset_type, SeqID, Start_range, Type, var_origin, Zygosity.", "schema": { "type": "string", "example": "Name" } }, { "name": "filter", "in": "query", "required": false, "description": "Elasticsearch query-string filter applied on top of the search text. It is not wildcarded automatically", "schema": { "type": "string", "example": "var_origin:germline" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "page": 1, "count": 3, "items": [ { "id": "7945772", "code": "nsv7447629", "name": "nsv7447629", "type": "copy_number_variation", "alias": "3___122567173_122571435___GRCh37_copy_number_variation_from_gain_or_loss", "dbxref": "URL:www.ncbi.nlm.nih.gov/dbvar/variants/nsv7447629" }, { "id": "7945768", "code": "nsv7447625", "name": "nsv7447625", "type": "copy_number_variation", "alias": "2___241740907_241778621___GRCh37_copy_number_variation_from_gain_or_loss", "dbxref": "URL:www.ncbi.nlm.nih.gov/dbvar/variants/nsv7447625" }, { "id": "7945758", "code": "nsv7447615", "name": "nsv7447615", "type": "copy_number_variation", "alias": "3___46130509_46180416___GRCh37_copy_number_variation_from_gain_or_loss", "dbxref": "URL:www.ncbi.nlm.nih.gov/dbvar/variants/nsv7447615" } ], "limit": 3, "terms": "nsv", "total": 10000, "hasMore": true, "nextPage": 2, "provider": "clinical-tables" } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:clinical-tables/disease-names": { "get": { "operationId": "health_clinical_tables_disease_names", "summary": "Disease Names", "description": "Disease names from MedGen — clinicaltables.nlm.nih.gov `disease_names`, direct JSON, no key. The service answers with a positional array [total, codes, extra, displayRows]", "tags": [ "Clinical Tables" ], "externalDocs": { "url": "https://zapi.ink/api/health/clinical-tables#reference-disease-names" }, "parameters": [ { "name": "terms", "in": "query", "required": true, "description": "Search text. Several partial words are combined with an implicit AND", "schema": { "type": "string", "example": "marfan" } }, { "name": "page", "in": "query", "required": false, "description": "Page number. Default 1", "schema": { "type": "number", "example": "1" } }, { "name": "limit", "in": "query", "required": false, "description": "Items per page. Default 10, max 500. Page times limit may not exceed 7500", "schema": { "type": "number", "example": "10" } }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated fields returned as display strings. Allowed: DiseaseName, ConceptID.", "schema": { "type": "string", "example": "DiseaseName,ConceptID" } }, { "name": "extraFields", "in": "query", "required": false, "description": "Comma-separated fields returned with their native types, so objects and arrays stay structured. Accepts field:alias. Allowed: DiseaseName, ConceptID.", "schema": { "type": "string", "example": "DiseaseName,ConceptID" } }, { "name": "searchFields", "in": "query", "required": false, "description": "Comma-separated fields the search text is matched against. Allowed: DiseaseName, ConceptID.", "schema": { "type": "string", "example": "DiseaseName,ConceptID" } }, { "name": "codeField", "in": "query", "required": false, "description": "The single field to report as each item's code. Allowed: DiseaseName, ConceptID.", "schema": { "type": "string", "example": "ConceptID" } }, { "name": "filter", "in": "query", "required": false, "description": "Elasticsearch query-string filter applied on top of the search text. It is not wildcarded automatically", "schema": { "type": "string", "example": "DiseaseName:marfan*" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "page": 1, "count": 3, "items": [ { "code": "C5681015", "conceptID": "C5681015", "diseaseName": "Marfan and Marfan-related disorder" }, { "code": "C0024796", "conceptID": "C0024796", "diseaseName": "Marfan syndrome" }, { "code": "C4016055", "conceptID": "C4016055", "diseaseName": "Marfan syndrome, atypical" } ], "limit": 3, "terms": "marfan", "total": 19, "hasMore": true, "nextPage": 2, "provider": "clinical-tables" } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:clinical-tables/drug-ingredients": { "get": { "operationId": "health_clinical_tables_drug_ingredients", "summary": "Drug Ingredients", "description": "Drug ingredient names — clinicaltables.nlm.nih.gov `drug_ingredients`, direct JSON, no key. The service answers with a positional array [total, codes, extra, displayRows]", "tags": [ "Clinical Tables" ], "externalDocs": { "url": "https://zapi.ink/api/health/clinical-tables#reference-drug-ingredients" }, "parameters": [ { "name": "terms", "in": "query", "required": true, "description": "Search text. Several partial words are combined with an implicit AND", "schema": { "type": "string", "example": "aspirin" } }, { "name": "page", "in": "query", "required": false, "description": "Page number. Default 1", "schema": { "type": "number", "example": "1" } }, { "name": "limit", "in": "query", "required": false, "description": "Items per page. Default 10, max 500. Page times limit may not exceed 7500", "schema": { "type": "number", "example": "10" } }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated fields returned as display strings. Allowed: code, name.", "schema": { "type": "string", "example": "code,name" } }, { "name": "extraFields", "in": "query", "required": false, "description": "Comma-separated fields returned with their native types, so objects and arrays stay structured. Accepts field:alias. Allowed: code, name.", "schema": { "type": "string", "example": "code,name" } }, { "name": "searchFields", "in": "query", "required": false, "description": "Comma-separated fields the search text is matched against. Allowed: code, name.", "schema": { "type": "string", "example": "code,name" } }, { "name": "codeField", "in": "query", "required": false, "description": "The single field to report as each item's code. Allowed: code, name.", "schema": { "type": "string", "example": "code" } }, { "name": "filter", "in": "query", "required": false, "description": "Elasticsearch query-string filter applied on top of the search text. It is not wildcarded automatically", "schema": { "type": "string", "example": "name:aspirin*" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "page": 1, "count": 1, "items": [ { "code": "1191", "name": "aspirin" } ], "limit": 3, "terms": "aspirin", "total": 1, "hasMore": false, "nextPage": null, "provider": "clinical-tables" } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:clinical-tables/drugs": { "get": { "operationId": "health_clinical_tables_drugs", "summary": "Drugs", "description": "RxTerms drug names — clinicaltables.nlm.nih.gov `rxterms`, direct JSON, no key. The service answers with a positional array [total, codes, extra, displayRows]", "tags": [ "Clinical Tables" ], "externalDocs": { "url": "https://zapi.ink/api/health/clinical-tables#reference-drugs" }, "parameters": [ { "name": "terms", "in": "query", "required": true, "description": "Search text. Several partial words are combined with an implicit AND", "schema": { "type": "string", "example": "aspirin" } }, { "name": "page", "in": "query", "required": false, "description": "Page number. Default 1", "schema": { "type": "number", "example": "1" } }, { "name": "limit", "in": "query", "required": false, "description": "Items per page. Default 10, max 500. Page times limit may not exceed 7500", "schema": { "type": "number", "example": "10" } }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated fields returned as display strings. Allowed: DISPLAY_NAME, STRENGTHS_AND_FORMS, RXCUIS, SXDG_RXCUI, DISPLAY_NAME_SYNONYM.", "schema": { "type": "string", "example": "DISPLAY_NAME,SXDG_RXCUI" } }, { "name": "extraFields", "in": "query", "required": false, "description": "Comma-separated fields returned with their native types, so objects and arrays stay structured. Accepts field:alias. Allowed: DISPLAY_NAME, STRENGTHS_AND_FORMS, RXCUIS, SXDG_RXCUI, DISPLAY_NAME_SYNONYM.", "schema": { "type": "string", "example": "STRENGTHS_AND_FORMS,RXCUIS" } }, { "name": "searchFields", "in": "query", "required": false, "description": "Comma-separated fields the search text is matched against. Allowed: DISPLAY_NAME, STRENGTHS_AND_FORMS, RXCUIS, SXDG_RXCUI, DISPLAY_NAME_SYNONYM.", "schema": { "type": "string", "example": "DISPLAY_NAME,SXDG_RXCUI" } }, { "name": "codeField", "in": "query", "required": false, "description": "The single field to report as each item's code. Allowed: DISPLAY_NAME, STRENGTHS_AND_FORMS, RXCUIS, SXDG_RXCUI, DISPLAY_NAME_SYNONYM.", "schema": { "type": "string", "example": "DISPLAY_NAME" } }, { "name": "filter", "in": "query", "required": false, "description": "Elasticsearch query-string filter applied on top of the search text. It is not wildcarded automatically", "schema": { "type": "string", "example": "DISPLAY_NAME:aspirin*" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "page": 1, "count": 3, "items": [ { "code": "Aspirin (Oral Pill)", "rxcuis": [ "252857", "308416", "243670", "198466", "198467", "212033", "308409", "198471" ], "sxdgRxcui": "1154070", "displayName": "Aspirin (Oral Pill)", "strengthsAndForms": [ " 81 mg Cap", " 81 mg DR Tab", " 81 mg Tab", "325 mg Cap", "325 mg DR Tab", "325 mg Tab", "500 mg DR Tab", "500 mg Tab" ] }, { "code": "Aspirin (Chewable)", "rxcuis": [ "318272" ], "sxdgRxcui": "1294937", "displayName": "Aspirin (Chewable)", "strengthsAndForms": [ "81 mg Tab" ] }, { "code": "Aspirin/oxyCODONE (Oral Pill)", "rxcuis": [ "637540", "848768" ], "sxdgRxcui": "1153750", "displayName": "Aspirin/oxyCODONE (Oral Pill)", "strengthsAndForms": [ "325-4.5-0.38 mg Tab", "325-4.84 mg Tab" ] } ], "limit": 3, "terms": "aspirin", "total": 15, "hasMore": true, "nextPage": 2, "provider": "clinical-tables" } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:clinical-tables/form-definition": { "get": { "operationId": "health_clinical_tables_form_definition", "summary": "Form Definition", "description": "Renderable LOINC panel definition — clinicaltables.nlm.nih.gov, direct JSON. The one rich payload in this source: a nested question tree with units, answer", "tags": [ "Clinical Tables" ], "externalDocs": { "url": "https://zapi.ink/api/health/clinical-tables#reference-form-definition" }, "parameters": [ { "name": "loincNum", "in": "query", "required": true, "description": "LOINC code of the panel or form whose definition to return", "schema": { "type": "string", "example": "34565-2" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "code": "34565-2", "name": "Vital signs, weight and height panel", "items": [ { "items": [ { "units": [ { "code": "{beats}/min", "name": "{beats}/min", "system": "http://unitsofmeasure.org", "isDefault": false }, { "code": "{counts}/min", "name": "{counts}/min", "system": "http://unitsofmeasure.org", "isDefault": false } ], "linkId": "/34566-0/8867-4", "dataType": "REAL", "isHeader": false, "question": "Heart rate", "questionCode": "8867-4", "questionCodeSystem": "http://loinc.org" }, { "units": [ { "code": "{breaths}/min", "name": "{breaths}/min", "system": "http://unitsofmeasure.org", "isDefault": false }, { "code": "{counts}/min", "name": "{counts}/min", "system": "http://unitsofmeasure.org", "isDefault": false } ], "linkId": "/34566-0/9279-1", "dataType": "REAL", "isHeader": false, "question": "Resp rate", "questionCode": "9279-1", "questionCodeSystem": "http://loinc.org" }, { "items": [ { "units": [ { "code": "mm[Hg]", "name": "mm[Hg]", "system": "http://unitsofmeasure.org", "isDefault": false } ], "linkId": "/34566-0/35094-2/8480-6", "dataType": "REAL", "isHeader": false, "question": "BP sys", "questionCode": "8480-6", "questionCodeSystem": "http://loinc.org" }, { "units": [ { "code": "mm[Hg]", "name": "mm[Hg]", "system": "http://unitsofmeasure.org", "isDefault": false } ], "linkId": "/34566-0/35094-2/8462-4", "dataType": "REAL", "isHeader": false, "question": "BP dias", "questionCode": "8462-4", "questionCodeSystem": "http://loinc.org" }, { "units": [ { "code": "mm[Hg]", "name": "mm[Hg]", "system": "http://unitsofmeasure.org", "isDefault": false } ], "linkId": "/34566-0/35094-2/8478-0", "dataType": "REAL", "isHeader": false, "question": "BP mean", "questionCode": "8478-0", "questionCodeSystem": "http://loinc.org" }, { "linkId": "/34566-0/35094-2/8357-6", "answers": [ { "code": "LA24013-7", "text": "Auscultation - automatic", "system": "http://loinc.org" }, { "code": "LA24012-9", "text": "Auscultation - manual", "system": "http://loinc.org" }, { "code": "LA24014-5", "text": "Oscillometry", "system": "http://loinc.org" }, { "code": "LA24016-0", "text": "Continuous noninvasive arterial pressure (CNAP)", "system": "http://loinc.org" }, { "code": "LA24015-2", "text": "Invasive (intravascular transducer)", "system": "http://loinc.org" }, { "code": "LA25780-0", "text": "Arterial line", "label": "3308001", "system": "http://loinc.org" }, { "code": "LA19771-7", "text": "Doppler", "label": "3308003", "system": "http://loinc.org" }, { "code": "LA25782-6", "text": "Cuff-manual palpated only", "label": "3308009", "system": "http://loinc.org" } ], "dataType": "CNE", "isHeader": false, "question": "BP method", "questionCode": "8357-6", "questionCodeSystem": "http://loinc.org" }, { "units": [ { "code": "cm", "name": "cm", "system": "http://unitsofmeasure.org", "isDefault": false } ], "linkId": "/34566-0/35094-2/8358-4", "answers": [ { "code": "LA11162-7", "text": "Adult standard", "system": "http://loinc.org" }, { "code": "LA11163-5", "text": "Adult large", "system": "http://loinc.org" }, { "code": "LA11164-3", "text": "Thigh extra large", "system": "http://loinc.org" } ], "dataType": "CNE", "isHeader": false, "question": "BP device Cuff size", "questionCode": "8358-4", "questionCodeSystem": "http://loinc.org" }, { "linkId": "/34566-0/35094-2/8359-2", "dataType": "ST", "isHeader": false, "question": "Periph a measurement site", "questionCode": "8359-2", "questionCodeSystem": "http://loinc.org" }, { "linkId": "/34566-0/35094-2/9856-6", "dataType": "ST", "isHeader": false, "question": "BP device Inventory #", "questionCode": "9856-6", "questionCodeSystem": "http://loinc.org" }, { "linkId": "/34566-0/35094-2/9857-4", "dataType": "ST", "isHeader": false, "question": "BP device Model #", "questionCode": "9857-4", "questionCodeSystem": "http://loinc.org" } ], "linkId": "/34566-0/35094-2", "dataType": "SECTION", "isHeader": true, "question": "BP Pnl", "questionCode": "35094-2", "questionCodeSystem": "http://loinc.org" }, { "items": [ { "units": [ { "code": "Cel", "name": "Cel", "system": "http://unitsofmeasure.org", "isDefault": false } ], "linkId": "/34566-0/35095-9/8310-5", "dataType": "REAL", "isHeader": false, "question": "Body temperature", "questionCode": "8310-5", "questionCodeSystem": "http://loinc.org" }, { "linkId": "/34566-0/35095-9/8326-1", "answers": [ { "code": "LA24040-0", "text": "Digital thermometer", "system": "http://loinc.org" }, { "code": "LA24043-4", "text": "Liquid-crystal temperature-sensitive strip", "system": "http://loinc.org" }, { "code": "LA24038-4", "text": "Mercury thermometer", "system": "http://loinc.org" }, { "code": "LA24037-6", "text": "Non-contact infrared thermometer (NCIT)", "system": "http://loinc.org" }, { "code": "LA24042-6", "text": "Temporal artery infrared thermometer", "system": "http://loinc.org" }, { "code": "LA24039-2", "text": "Thermal scanner camera", "system": "http://loinc.org" }, { "code": "LA24041-8", "text": "Tympanic infrared thermometer", "system": "http://loinc.org" } ], "dataType": "CNE", "isHeader": false, "question": "Bdy Temp Device Class", "questionCode": "8326-1", "questionCodeSystem": "http://loinc.org" }, { "linkId": "/34566-0/35095-9/8327-9", "answers": [ { "code": "LA9370-3", "text": "Axillary", "system": "http://loinc.org" }, { "code": "LA9367-9", "text": "Oral", "system": "http://loinc.org" }, { "code": "LA21929-7", "text": "Ear", "system": "http://loinc.org" }, { "code": "LA9368-7", "text": "Tympanic membrane", "system": "http://loinc.org" }, { "code": "LA21928-9", "text": "Temporal artery (forehead)", "system": "http://loinc.org" }, { "code": "LA9369-5", "text": "Rectal", "system": "http://loinc.org" }, { "code": "LA9371-1", "text": "Urinary bladder", "system": "http://loinc.org" }, { "code": "LA9263-0", "text": "Nasal", "system": "http://loinc.org" } ], "dataType": "CNE", "isHeader": false, "question": "Bdy temp measurement site", "questionCode": "8327-9", "questionCodeSystem": "http://loinc.org" }, { "linkId": "/34566-0/35095-9/9849-1", "dataType": "ST", "isHeader": false, "question": "Bdy Temp Device Inventory #", "questionCode": "9849-1", "questionCodeSystem": "http://loinc.org" }, { "linkId": "/34566-0/35095-9/9850-9", "dataType": "ST", "isHeader": false, "question": "Bdy Temp Device Model #", "questionCode": "9850-9", "questionCodeSystem": "http://loinc.org" }, { "linkId": "/34566-0/35095-9/9851-7", "dataType": "ST", "isHeader": false, "question": "Bdy Temp Device Serial #", "questionCode": "9851-7", "questionCodeSystem": "http://loinc.org" } ], "linkId": "/34566-0/35095-9", "dataType": "SECTION", "isHeader": true, "question": "Bdy temp Pnl", "questionCode": "35095-9", "questionCodeSystem": "http://loinc.org" }, { "units": [ { "name": "centimeters", "isDefault": false }, { "name": "feet", "isDefault": false }, { "name": "inches", "isDefault": false }, { "name": "meters", "isDefault": false } ], "linkId": "/34566-0/8302-2", "dataType": "REAL", "isHeader": false, "question": "Body height", "questionCode": "8302-2", "questionCodeSystem": "http://loinc.org" }, { "units": [ { "code": "[lb_av]", "name": "[lb_av]", "system": "http://unitsofmeasure.org", "isDefault": false }, { "code": "kg", "name": "kg", "system": "http://unitsofmeasure.org", "isDefault": false } ], "linkId": "/34566-0/3141-9", "dataType": "REAL", "isHeader": false, "question": "Weight Measured", "questionCode": "3141-9", "questionCodeSystem": "http://loinc.org" }, { "linkId": "/34566-0/8361-8", "answers": [ { "code": "LA11868-9", "text": "Sitting", "system": "http://loinc.org" }, { "code": "LA11869-7", "text": "Lying", "system": "http://loinc.org" }, { "code": "LA11870-5", "text": "Standing", "system": "http://loinc.org" } ], "dataType": "CNE", "isHeader": false, "question": "Bdy position with respect to gravity", "questionCode": "8361-8", "questionCodeSystem": "http://loinc.org" }, { "linkId": "/34566-0/8352-7", "answers": [ { "code": "LA11871-3", "text": "Underwear or less", "system": "http://loinc.org" }, { "code": "LA11872-1", "text": "Street clothes, no shoes", "system": "http://loinc.org" }, { "code": "LA11873-9", "text": "Street clothes & shoes", "system": "http://loinc.org" } ], "dataType": "CNE", "isHeader": false, "question": "Clothing worn during measure", "questionCode": "8352-7", "questionCodeSystem": "http://loinc.org" } ], "linkId": "/34566-0", "dataType": "SECTION", "isHeader": true, "question": "Vital Signs Pnl", "questionCode": "34566-0", "questionCodeSystem": "http://loinc.org" } ], "codeType": "LOINC", "loincNum": "34565-2", "provider": "clinical-tables", "codeSystem": "http://loinc.org", "lformsVersion": "29.0.0", "copyrightNotice": null, "codingInstructions": null } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:clinical-tables/genes": { "get": { "operationId": "health_clinical_tables_genes", "summary": "Genes", "description": "NCBI gene records — clinicaltables.nlm.nih.gov `ncbi_genes`, direct JSON, no key. The service answers with a positional array [total, codes, extra, displayRows]", "tags": [ "Clinical Tables" ], "externalDocs": { "url": "https://zapi.ink/api/health/clinical-tables#reference-genes" }, "parameters": [ { "name": "terms", "in": "query", "required": true, "description": "Search text. Several partial words are combined with an implicit AND", "schema": { "type": "string", "example": "BRCA1" } }, { "name": "page", "in": "query", "required": false, "description": "Page number. Default 1", "schema": { "type": "number", "example": "1" } }, { "name": "limit", "in": "query", "required": false, "description": "Items per page. Default 10, max 500. Page times limit may not exceed 7500", "schema": { "type": "number", "example": "10" } }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated fields returned as display strings. Allowed: GeneID, HGNC_ID, Symbol, Synonyms, dbXrefs, chromosome, map_location, description, type_of_gene, na_symbol, na_name, Other_designations, Modification_date.", "schema": { "type": "string", "example": "Symbol,description,chromosome" } }, { "name": "extraFields", "in": "query", "required": false, "description": "Comma-separated fields returned with their native types, so objects and arrays stay structured. Accepts field:alias. Allowed: GeneID, HGNC_ID, Symbol, Synonyms, dbXrefs, chromosome, map_location, description, type_of_gene, na_symbol, na_name, Other_designations, Modification_date.", "schema": { "type": "string", "example": "Synonyms,dbXrefs" } }, { "name": "searchFields", "in": "query", "required": false, "description": "Comma-separated fields the search text is matched against. Allowed: GeneID, HGNC_ID, Symbol, Synonyms, dbXrefs, chromosome, map_location, description, type_of_gene, na_symbol, na_name, Other_designations, Modification_date.", "schema": { "type": "string", "example": "Symbol,description,chromosome" } }, { "name": "codeField", "in": "query", "required": false, "description": "The single field to report as each item's code. Allowed: GeneID, HGNC_ID, Symbol, Synonyms, dbXrefs, chromosome, map_location, description, type_of_gene, na_symbol, na_name, Other_designations, Modification_date.", "schema": { "type": "string", "example": "GeneID" } }, { "name": "filter", "in": "query", "required": false, "description": "Elasticsearch query-string filter applied on top of the search text. It is not wildcarded automatically", "schema": { "type": "string", "example": "chromosome:17" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "page": 1, "count": 3, "items": [ { "code": "394269", "symbol": "BRCA1P1", "dbXrefs": "HGNC:HGNC:28470|AllianceGenome:HGNC:28470", "synonyms": "LBRCA1|PsiBRCA1|pseudo-BRCA1", "chromosome": "17", "codeSystem": "NCBI-gene code", "description": "BRCA1 pseudogene 1" }, { "code": "111589215", "symbol": "LOC111589215", "dbXrefs": "-", "synonyms": "-", "chromosome": "17", "codeSystem": "NCBI-gene code", "description": "BRCA1 promoter region" }, { "code": "101929767", "symbol": "BRCA1-OT1", "dbXrefs": "HGNC:HGNC:58363", "synonyms": "-", "chromosome": "17", "codeSystem": "NCBI-gene code", "description": "BRCA1 overlapping transcript 1" } ], "limit": 3, "terms": "BRCA1", "total": 9, "hasMore": true, "nextPage": 2, "provider": "clinical-tables" } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:clinical-tables/hcpcs": { "get": { "operationId": "health_clinical_tables_hcpcs", "summary": "Hcpcs", "description": "HCPCS Level II codes — clinicaltables.nlm.nih.gov `hcpcs`, direct JSON, no key. The service answers with a positional array [total, codes, extra, displayRows]", "tags": [ "Clinical Tables" ], "externalDocs": { "url": "https://zapi.ink/api/health/clinical-tables#reference-hcpcs" }, "parameters": [ { "name": "terms", "in": "query", "required": true, "description": "Search text. Several partial words are combined with an implicit AND", "schema": { "type": "string", "example": "wheelchair" } }, { "name": "page", "in": "query", "required": false, "description": "Page number. Default 1", "schema": { "type": "number", "example": "1" } }, { "name": "limit", "in": "query", "required": false, "description": "Items per page. Default 10, max 500. Page times limit may not exceed 7500", "schema": { "type": "number", "example": "10" } }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated fields returned as display strings. Allowed: code, short_desc, long_desc, display, add_dt, term_dt, act_eff_dt, obsolete, is_noc.", "schema": { "type": "string", "example": "code,display,short_desc" } }, { "name": "extraFields", "in": "query", "required": false, "description": "Comma-separated fields returned with their native types, so objects and arrays stay structured. Accepts field:alias. Allowed: code, short_desc, long_desc, display, add_dt, term_dt, act_eff_dt, obsolete, is_noc.", "schema": { "type": "string", "example": "code,display" } }, { "name": "searchFields", "in": "query", "required": false, "description": "Comma-separated fields the search text is matched against. Allowed: code, short_desc, long_desc, display, add_dt, term_dt, act_eff_dt, obsolete, is_noc.", "schema": { "type": "string", "example": "code,display,short_desc" } }, { "name": "codeField", "in": "query", "required": false, "description": "The single field to report as each item's code. Allowed: code, short_desc, long_desc, display, add_dt, term_dt, act_eff_dt, obsolete, is_noc.", "schema": { "type": "string", "example": "code" } }, { "name": "filter", "in": "query", "required": false, "description": "Elasticsearch query-string filter applied on top of the search text. It is not wildcarded automatically", "schema": { "type": "string", "example": "obsolete:false" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "page": 1, "count": 3, "items": [ { "code": "E2210", "display": "Wheelchair bearings", "shortDesc": "Wheelchair bearings" }, { "code": "K0001", "display": "Standard wheelchair", "shortDesc": "Standard wheelchair" }, { "code": "K0003", "display": "Lightweight wheelchair", "shortDesc": "Lightweight wheelchair" } ], "limit": 3, "terms": "wheelchair", "total": 63, "hasMore": true, "nextPage": 2, "provider": "clinical-tables" } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:clinical-tables/hpo": { "get": { "operationId": "health_clinical_tables_hpo", "summary": "Hpo", "description": "Human Phenotype Ontology terms — clinicaltables.nlm.nih.gov `hpo`, direct JSON, no key. The service answers with a positional array [total, codes, extra, displayRows]", "tags": [ "Clinical Tables" ], "externalDocs": { "url": "https://zapi.ink/api/health/clinical-tables#reference-hpo" }, "parameters": [ { "name": "terms", "in": "query", "required": true, "description": "Search text. Several partial words are combined with an implicit AND", "schema": { "type": "string", "example": "seizure" } }, { "name": "page", "in": "query", "required": false, "description": "Page number. Default 1", "schema": { "type": "number", "example": "1" } }, { "name": "limit", "in": "query", "required": false, "description": "Items per page. Default 10, max 500. Page times limit may not exceed 7500", "schema": { "type": "number", "example": "10" } }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated fields returned as display strings. Allowed: id, name, definition, def_xref, created_by, creation_date, comment, is_obsolete, replaced_by, consider, alt_id, synonym, synonym.term, synonym.relation, synonym.type, synonym.xref, is_a, is_a.id, is_a.name, xref, xref.id, xref.name, property, property.name, property.value, property.data_type, property.xref.", "schema": { "type": "string", "example": "id,name,definition" } }, { "name": "extraFields", "in": "query", "required": false, "description": "Comma-separated fields returned with their native types, so objects and arrays stay structured. Accepts field:alias. Allowed: id, name, definition, def_xref, created_by, creation_date, comment, is_obsolete, replaced_by, consider, alt_id, synonym, synonym.term, synonym.relation, synonym.type, synonym.xref, is_a, is_a.id, is_a.name, xref, xref.id, xref.name, property, property.name, property.value, property.data_type, property.xref.", "schema": { "type": "string", "example": "synonym,is_a" } }, { "name": "searchFields", "in": "query", "required": false, "description": "Comma-separated fields the search text is matched against. Allowed: id, name, definition, def_xref, created_by, creation_date, comment, is_obsolete, replaced_by, consider, alt_id, synonym, synonym.term, synonym.relation, synonym.type, synonym.xref, is_a, is_a.id, is_a.name, xref, xref.id, xref.name, property, property.name, property.value, property.data_type, property.xref.", "schema": { "type": "string", "example": "id,name,definition" } }, { "name": "codeField", "in": "query", "required": false, "description": "The single field to report as each item's code. Allowed: id, name, definition, def_xref, created_by, creation_date, comment, is_obsolete, replaced_by, consider, alt_id, synonym, synonym.term, synonym.relation, synonym.type, synonym.xref, is_a, is_a.id, is_a.name, xref, xref.id, xref.name, property, property.name, property.value, property.data_type, property.xref.", "schema": { "type": "string", "example": "id" } }, { "name": "filter", "in": "query", "required": false, "description": "Elasticsearch query-string filter applied on top of the search text. It is not wildcarded automatically", "schema": { "type": "string", "example": "id:HP\\:0001250" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "page": 1, "count": 1, "items": [ { "id": "HP:0001250", "isA": [ { "id": "HP:0012638", "name": "Abnormal nervous system physiology" } ], "code": "HP:0001250", "name": "Seizure", "synonym": [ { "term": "Epilepsy", "type": "layperson", "relation": "RELATED" }, { "term": "Epileptic seizure", "relation": "EXACT" }, { "term": "Seizures", "type": "plural_form", "relation": "EXACT" } ], "definition": "A seizure is an intermittent abnormality of nervous system physiology characterized by a transient occurrence of signs and/or symptoms due to abnormal excessive or synchronous neuronal activity in the brain" } ], "limit": 3, "terms": "seizure", "total": 1, "hasMore": false, "nextPage": null, "provider": "clinical-tables" } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:clinical-tables/icd10": { "get": { "operationId": "health_clinical_tables_icd10", "summary": "Icd10", "description": "ICD-10-CM diagnosis codes — clinicaltables.nlm.nih.gov, direct JSON, no key. The service answers with a positional array and returns empty strings on a 200", "tags": [ "Clinical Tables" ], "externalDocs": { "url": "https://zapi.ink/api/health/clinical-tables#reference-icd10" }, "parameters": [ { "name": "terms", "in": "query", "required": true, "description": "Search text. Several partial words are combined with an implicit AND", "schema": { "type": "string", "example": "diabetes" } }, { "name": "page", "in": "query", "required": false, "description": "Page number. Default 1", "schema": { "type": "number", "example": "1" } }, { "name": "limit", "in": "query", "required": false, "description": "Items per page. Default 10, max 500. Page times limit may not exceed 7500", "schema": { "type": "number", "example": "10" } }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated fields returned as display strings. Allowed: code, name.", "schema": { "type": "string", "example": "code,name" } }, { "name": "extraFields", "in": "query", "required": false, "description": "Comma-separated fields returned with their native types, so objects and arrays stay structured. Accepts field:alias. Allowed: code, name.", "schema": { "type": "string", "example": "code,name" } }, { "name": "searchFields", "in": "query", "required": false, "description": "Comma-separated fields the search text is matched against. Allowed: code, name.", "schema": { "type": "string", "example": "code,name" } }, { "name": "codeField", "in": "query", "required": false, "description": "The single field to report as each item's code. Allowed: code, name.", "schema": { "type": "string", "example": "code" } }, { "name": "filter", "in": "query", "required": false, "description": "Elasticsearch query-string filter applied on top of the search text. It is not wildcarded automatically", "schema": { "type": "string", "example": "code:E11*" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "page": 1, "count": 3, "items": [ { "code": "E11.65", "name": "Type 2 diabetes mellitus with hyperglycemia" }, { "code": "E11.9", "name": "Type 2 diabetes mellitus without complications" }, { "code": "E11.21", "name": "Type 2 diabetes mellitus with diabetic nephropathy" } ], "limit": 3, "terms": "diabetes", "total": 87, "hasMore": true, "nextPage": 2, "provider": "clinical-tables" } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:clinical-tables/icd11": { "get": { "operationId": "health_clinical_tables_icd11", "summary": "Icd11", "description": "ICD-11 codes — clinicaltables.nlm.nih.gov `icd11_codes`, direct JSON, no key. The service answers with a positional array [total, codes, extra, displayRows]", "tags": [ "Clinical Tables" ], "externalDocs": { "url": "https://zapi.ink/api/health/clinical-tables#reference-icd11" }, "parameters": [ { "name": "terms", "in": "query", "required": true, "description": "Search text. Several partial words are combined with an implicit AND", "schema": { "type": "string", "example": "diabetes" } }, { "name": "page", "in": "query", "required": false, "description": "Page number. Default 1", "schema": { "type": "number", "example": "1" } }, { "name": "limit", "in": "query", "required": false, "description": "Items per page. Default 10, max 500. Page times limit may not exceed 7500", "schema": { "type": "number", "example": "10" } }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated fields returned as display strings. Allowed: code, title, definition, type, chapter, entityId, source, indexTerm, browserUrl, parent.", "schema": { "type": "string", "example": "code,title,definition" } }, { "name": "extraFields", "in": "query", "required": false, "description": "Comma-separated fields returned with their native types, so objects and arrays stay structured. Accepts field:alias. Allowed: code, title, definition, type, chapter, entityId, source, indexTerm, browserUrl, parent.", "schema": { "type": "string", "example": "indexTerm" } }, { "name": "searchFields", "in": "query", "required": false, "description": "Comma-separated fields the search text is matched against. Allowed: code, title, definition, type, chapter, entityId, source, indexTerm, browserUrl, parent.", "schema": { "type": "string", "example": "code,title,definition" } }, { "name": "codeField", "in": "query", "required": false, "description": "The single field to report as each item's code. Allowed: code, title, definition, type, chapter, entityId, source, indexTerm, browserUrl, parent.", "schema": { "type": "string", "example": "code" } }, { "name": "filter", "in": "query", "required": false, "description": "Elasticsearch query-string filter applied on top of the search text. It is not wildcarded automatically", "schema": { "type": "string", "example": "type:stem" } }, { "name": "codeType", "in": "query", "required": false, "description": "Restrict to stem codes, extension codes, or both. Default category, which is both", "schema": { "type": "string", "enum": [ "stem", "extension", "category" ], "example": "stem" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "page": 1, "count": 3, "items": [ { "code": "5A10", "title": "Type 1 diabetes mellitus", "indexTerm": "Type 1 diabetes mellitus; IDDM - [insulin dependent diabetes mellitus]; T1DM - [type 1 diabetes mellitus]; idiopathic insulin-dependent diabetes mellitus without complications; juvenile diabetes mellitus without complications; juvenile-onset diabetes mellitus without complications; juvenile-onset-type diabetes mellitus without complications; ketosis-prone diabetes mellitus without complications; type 1 IDDM; type 1 diabetes; Idiopathic Type 1 diabetes mellitus; Fulminant type 1 diabetes mellitus; Immune-related Type 1 diabetes mellitus; Immune-mediated Type 1 diabetes mellitus; Juvenile onset diabetes mellitus; Latent autoimmune diabetes in adults; LADA - [Latent autoimmune diabetes in adults]; SPIDDM - [Slowly progressive insulin-dependent diabetes mellitus]; slowly progressive insulin-dependent diabetes mellitus", "definition": "Diabetes mellitus type 1 (type 1 diabetes, T1DM, formerly insulin dependent or juvenile diabetes) is a form of diabetes mellitus that results from destruction of insulin-producing beta cells, mostly by autoimmune mechanisms. The subsequent lack of insulin leads to increased blood and urine glucose." }, { "code": "5A13", "title": "Diabetes mellitus, other specified type", "indexTerm": "Diabetes mellitus, other specified type; Other specified Diabetes mellitus, not Type 1 and not Type 2", "definition": "Diabetes mellitus which cannot be classified as either Type 1 or Type 2 diabetes mellitus." }, { "code": "5A11", "title": "Type 2 diabetes mellitus", "indexTerm": "Type 2 diabetes mellitus; DM type II; DM2; Diabetic type 2; NIDDM - [non insulin dependent diabetes mellitus]; T2DM - [Type 2 diabetes mellitus]; Type II diabetes mellitus; adult onset diabetes; diabetes due to insulin secretory defect; diabetes mellitus Type 2; diabetes mellitus due to insulin secretory defect; insulin requiring type 2 diabetes; maturity onset diabetes; maturity-onset diabetes mellitus; non-insulin dependent diabetes mellitus; non-insulin-dependent diabetes mellitus without complications; non-insulin-dependent diabetes of the young; noninsulin dependent diabetes; nonketotic diabetes; nonketotic hyperglycaemia; senile diabetes; stable diabetes; type 2 diabetes; type II diabetes; Ketosis-resistant diabetes mellitus; Insulin resistant diabetes mellitus; insulin resistant diabetes", "definition": "Diabetes mellitus type 2 (formerly noninsulin-dependent diabetes mellitus (NIDDM) or adult-onset diabetes) is a metabolic disorder that is characterised by high blood glucose in the context of insulin resistance and relative insulin deficiency." } ], "limit": 3, "terms": "diabetes", "total": 81, "hasMore": true, "nextPage": 2, "provider": "clinical-tables" } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:clinical-tables/icd9-dx": { "get": { "operationId": "health_clinical_tables_icd9_dx", "summary": "Icd9 Dx", "description": "ICD-9-CM diagnosis codes — clinicaltables.nlm.nih.gov `icd9cm_dx`, direct JSON, no key. The service answers with a positional array [total, codes, extra, displayRows]", "tags": [ "Clinical Tables" ], "externalDocs": { "url": "https://zapi.ink/api/health/clinical-tables#reference-icd9-dx" }, "parameters": [ { "name": "terms", "in": "query", "required": true, "description": "Search text. Several partial words are combined with an implicit AND", "schema": { "type": "string", "example": "asthma" } }, { "name": "page", "in": "query", "required": false, "description": "Page number. Default 1", "schema": { "type": "number", "example": "1" } }, { "name": "limit", "in": "query", "required": false, "description": "Items per page. Default 10, max 500. Page times limit may not exceed 7500", "schema": { "type": "number", "example": "10" } }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated fields returned as display strings. Allowed: code, code_dotted, short_name, long_name.", "schema": { "type": "string", "example": "code,code_dotted,short_name" } }, { "name": "extraFields", "in": "query", "required": false, "description": "Comma-separated fields returned with their native types, so objects and arrays stay structured. Accepts field:alias. Allowed: code, code_dotted, short_name, long_name.", "schema": { "type": "string", "example": "code,code_dotted" } }, { "name": "searchFields", "in": "query", "required": false, "description": "Comma-separated fields the search text is matched against. Allowed: code, code_dotted, short_name, long_name.", "schema": { "type": "string", "example": "code,code_dotted,short_name" } }, { "name": "codeField", "in": "query", "required": false, "description": "The single field to report as each item's code. Allowed: code, code_dotted, short_name, long_name.", "schema": { "type": "string", "example": "code" } }, { "name": "filter", "in": "query", "required": false, "description": "Elasticsearch query-string filter applied on top of the search text. It is not wildcarded automatically", "schema": { "type": "string", "example": "code:493*" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "page": 1, "count": 3, "items": [ { "code": "49390", "shortName": "Asthma NOS", "codeDotted": "493.90" }, { "code": "49300", "shortName": "Extrinsic asthma NOS", "codeDotted": "493.00" }, { "code": "49310", "shortName": "Intrinsic asthma NOS", "codeDotted": "493.10" } ], "limit": 3, "terms": "asthma", "total": 12, "hasMore": true, "nextPage": 2, "provider": "clinical-tables" } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:clinical-tables/icd9-sg": { "get": { "operationId": "health_clinical_tables_icd9_sg", "summary": "Icd9 Sg", "description": "ICD-9-CM procedure codes — clinicaltables.nlm.nih.gov `icd9cm_sg`, direct JSON, no key. The service answers with a positional array [total, codes, extra, displayRows]", "tags": [ "Clinical Tables" ], "externalDocs": { "url": "https://zapi.ink/api/health/clinical-tables#reference-icd9-sg" }, "parameters": [ { "name": "terms", "in": "query", "required": true, "description": "Search text. Several partial words are combined with an implicit AND", "schema": { "type": "string", "example": "appendectomy" } }, { "name": "page", "in": "query", "required": false, "description": "Page number. Default 1", "schema": { "type": "number", "example": "1" } }, { "name": "limit", "in": "query", "required": false, "description": "Items per page. Default 10, max 500. Page times limit may not exceed 7500", "schema": { "type": "number", "example": "10" } }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated fields returned as display strings. Allowed: code, code_dotted, short_name, long_name.", "schema": { "type": "string", "example": "code,code_dotted,short_name" } }, { "name": "extraFields", "in": "query", "required": false, "description": "Comma-separated fields returned with their native types, so objects and arrays stay structured. Accepts field:alias. Allowed: code, code_dotted, short_name, long_name.", "schema": { "type": "string", "example": "code,code_dotted" } }, { "name": "searchFields", "in": "query", "required": false, "description": "Comma-separated fields the search text is matched against. Allowed: code, code_dotted, short_name, long_name.", "schema": { "type": "string", "example": "code,code_dotted,short_name" } }, { "name": "codeField", "in": "query", "required": false, "description": "The single field to report as each item's code. Allowed: code, code_dotted, short_name, long_name.", "schema": { "type": "string", "example": "code" } }, { "name": "filter", "in": "query", "required": false, "description": "Elasticsearch query-string filter applied on top of the search text. It is not wildcarded automatically", "schema": { "type": "string", "example": "code:47*" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "page": 1, "count": 3, "items": [ { "code": "4701", "shortName": "Lap appendectomy", "codeDotted": "47.01" }, { "code": "4709", "shortName": "Other appendectomy", "codeDotted": "47.09" }, { "code": "4711", "shortName": "Lap incid appendectomy", "codeDotted": "47.11" } ], "limit": 3, "terms": "appendectomy", "total": 4, "hasMore": true, "nextPage": 2, "provider": "clinical-tables" } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:clinical-tables/lab-codes": { "get": { "operationId": "health_clinical_tables_lab_codes", "summary": "Lab Codes", "description": "LOINC panels and forms — clinicaltables.nlm.nih.gov `loinc_items`, direct JSON. This is the panels-and-forms subset of LOINC, not the full six-axis lab table:", "tags": [ "Clinical Tables" ], "externalDocs": { "url": "https://zapi.ink/api/health/clinical-tables#reference-lab-codes" }, "parameters": [ { "name": "terms", "in": "query", "required": true, "description": "Search text. Several partial words are combined with an implicit AND", "schema": { "type": "string", "example": "glucose" } }, { "name": "page", "in": "query", "required": false, "description": "Page number. Default 1", "schema": { "type": "number", "example": "1" } }, { "name": "limit", "in": "query", "required": false, "description": "Items per page. Default 10, max 500. Page times limit may not exceed 7500", "schema": { "type": "number", "example": "10" } }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated fields returned as display strings. Allowed: text, LOINC_NUM, LONG_COMMON_NAME, COMPONENT, PROPERTY, RELATEDNAMES2, METHOD_TYP, SHORTNAME, CONSUMER_NAME, SURVEY_QUEST_TEXT, AnswerLists, units, datatype, isCopyrighted, containsCopyrighted, EXTERNAL_COPYRIGHT_NOTICE.", "schema": { "type": "string", "example": "text,LOINC_NUM,LONG_COMMON_NAME" } }, { "name": "extraFields", "in": "query", "required": false, "description": "Comma-separated fields returned with their native types, so objects and arrays stay structured. Accepts field:alias. Allowed: text, LOINC_NUM, LONG_COMMON_NAME, COMPONENT, PROPERTY, RELATEDNAMES2, METHOD_TYP, SHORTNAME, CONSUMER_NAME, SURVEY_QUEST_TEXT, AnswerLists, units, datatype, isCopyrighted, containsCopyrighted, EXTERNAL_COPYRIGHT_NOTICE.", "schema": { "type": "string", "example": "RELATEDNAMES2,AnswerLists" } }, { "name": "searchFields", "in": "query", "required": false, "description": "Comma-separated fields the search text is matched against. Allowed: text, LOINC_NUM, LONG_COMMON_NAME, COMPONENT, PROPERTY, RELATEDNAMES2, METHOD_TYP, SHORTNAME, CONSUMER_NAME, SURVEY_QUEST_TEXT, AnswerLists, units, datatype, isCopyrighted, containsCopyrighted, EXTERNAL_COPYRIGHT_NOTICE.", "schema": { "type": "string", "example": "text,LOINC_NUM,LONG_COMMON_NAME" } }, { "name": "codeField", "in": "query", "required": false, "description": "The single field to report as each item's code. Allowed: text, LOINC_NUM, LONG_COMMON_NAME, COMPONENT, PROPERTY, RELATEDNAMES2, METHOD_TYP, SHORTNAME, CONSUMER_NAME, SURVEY_QUEST_TEXT, AnswerLists, units, datatype, isCopyrighted, containsCopyrighted, EXTERNAL_COPYRIGHT_NOTICE.", "schema": { "type": "string", "example": "LOINC_NUM" } }, { "name": "filter", "in": "query", "required": false, "description": "Elasticsearch query-string filter applied on top of the search text. It is not wildcarded automatically", "schema": { "type": "string", "example": "isCopyrighted:false" } }, { "name": "type", "in": "query", "required": false, "description": "Restrict to questions, forms or panels. Default searches questions and panel names together", "schema": { "type": "string", "enum": [ "question", "form", "panel" ], "example": "panel" } }, { "name": "available", "in": "query", "required": false, "description": "With true, only forms whose definition the form-definition endpoint can return", "schema": { "type": "string", "enum": [ "true", "false" ], "example": "true" } }, { "name": "excludeCopyrighted", "in": "query", "required": false, "description": "With true, drop items that are copyrighted or carry a copyrighted item. Default false", "schema": { "type": "string", "enum": [ "true", "false" ], "example": "false" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "page": 1, "count": 3, "items": [ { "code": "101652-6", "text": "Somatotropin & glucose post glucose stimulation panel", "loincNum": "101652-6", "relatednames2": "After; CHEMISTRY.CHALLENGE TESTING; GH; GH + Glc pst Glc stim pnl; Glu; Glu tol; Gluc; Glucose tolerance; Glucoseur; Growth hormone; GTT; HGH; Human growth hormone; Pan; PANEL.CHALLENGE; Panl; Pl; Plasma; Plsm; Pnl; Point in time; PST; Random; SerP; SerPl; SerPlas; Serum; Serum or plasma; Somatotropic hormone; SR; STH; Stim", "longCommonName": "Somatotropin and glucose post glucose stimulation panel - Serum or Plasma" }, { "code": "43151-0", "text": "Glucose meter device panel", "loincNum": "43151-0", "relatednames2": "Glu; Gluc; Glucose Meter Device Pnl; Glucoseur; Pan; Panel.devices; Panl; Pnl; Point in time; Random", "longCommonName": "Glucose meter device panel" }, { "code": "74790-7", "text": "Glucose challenge panel", "loincNum": "74790-7", "relatednames2": "Breath; CHEMISTRY.CHALLENGE TESTING; ExG; Exhaled gas; Exhaled gas (=breath); Gases; Glu; Glu tol; Gluc; Glucose HBT; Glucose HBT Pnl; Glucose tolerance; Glucoseur; GTT; Pan; PANEL.CHALLENGE; Panl; Pnl; Point in time; QNT; Quan; Quant; Quantitative; Random", "longCommonName": "Glucose challenge (hydrogen breath test) panel - Exhaled gas" } ], "limit": 3, "terms": "glucose", "total": 33, "hasMore": true, "nextPage": 2, "provider": "clinical-tables" } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:clinical-tables/procedures": { "get": { "operationId": "health_clinical_tables_procedures", "summary": "Procedures", "description": "Procedure names — clinicaltables.nlm.nih.gov `procedures`, direct JSON, no key. The service answers with a positional array [total, codes, extra, displayRows]", "tags": [ "Clinical Tables" ], "externalDocs": { "url": "https://zapi.ink/api/health/clinical-tables#reference-procedures" }, "parameters": [ { "name": "terms", "in": "query", "required": true, "description": "Search text. Several partial words are combined with an implicit AND", "schema": { "type": "string", "example": "appendectomy" } }, { "name": "page", "in": "query", "required": false, "description": "Page number. Default 1", "schema": { "type": "number", "example": "1" } }, { "name": "limit", "in": "query", "required": false, "description": "Items per page. Default 10, max 500. Page times limit may not exceed 7500", "schema": { "type": "number", "example": "10" } }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated fields returned as display strings. Allowed: primary_name, consumer_name, key_id, term_icd9_code, term_icd9_text, word_synonyms, synonyms, info_link_data.", "schema": { "type": "string", "example": "primary_name,consumer_name,key_id" } }, { "name": "extraFields", "in": "query", "required": false, "description": "Comma-separated fields returned with their native types, so objects and arrays stay structured. Accepts field:alias. Allowed: primary_name, consumer_name, key_id, term_icd9_code, term_icd9_text, word_synonyms, synonyms, info_link_data.", "schema": { "type": "string", "example": "synonyms,word_synonyms" } }, { "name": "searchFields", "in": "query", "required": false, "description": "Comma-separated fields the search text is matched against. Allowed: primary_name, consumer_name, key_id, term_icd9_code, term_icd9_text, word_synonyms, synonyms, info_link_data.", "schema": { "type": "string", "example": "primary_name,consumer_name,key_id" } }, { "name": "codeField", "in": "query", "required": false, "description": "The single field to report as each item's code. Allowed: primary_name, consumer_name, key_id, term_icd9_code, term_icd9_text, word_synonyms, synonyms, info_link_data.", "schema": { "type": "string", "example": "key_id" } }, { "name": "filter", "in": "query", "required": false, "description": "Elasticsearch query-string filter applied on top of the search text. It is not wildcarded automatically", "schema": { "type": "string", "example": "primary_name:append*" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "page": 1, "count": 1, "items": [ { "code": "377", "keyId": "377", "synonyms": [ "appy" ], "primaryName": "Appendectomy", "consumerName": "Appendectomy" } ], "limit": 3, "terms": "appendectomy", "total": 1, "hasMore": false, "nextPage": null, "provider": "clinical-tables" } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:clinical-tables/providers-individual": { "get": { "operationId": "health_clinical_tables_providers_individual", "summary": "Providers Individual", "description": "NPI registry — individual providers — clinicaltables.nlm.nih.gov `npi_idv`, direct JSON, no key. The service answers with a positional array [total, codes, extra, displayRows]", "tags": [ "Clinical Tables" ], "externalDocs": { "url": "https://zapi.ink/api/health/clinical-tables#reference-providers-individual" }, "parameters": [ { "name": "terms", "in": "query", "required": true, "description": "Search text. Several partial words are combined with an implicit AND", "schema": { "type": "string", "example": "john smith" } }, { "name": "page", "in": "query", "required": false, "description": "Page number. Default 1", "schema": { "type": "number", "example": "1" } }, { "name": "limit", "in": "query", "required": false, "description": "Items per page. Default 10, max 500. Page times limit may not exceed 7500", "schema": { "type": "number", "example": "10" } }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated fields returned as display strings. Allowed: NPI, provider_type, gender, name, name.full, name.last, name.first, name.middle, name.credential, name.prefix, name.suffix, addr_practice, addr_practice.full, addr_practice.line1, addr_practice.line2, addr_practice.city, addr_practice.state, addr_practice.zip, addr_practice.phone, addr_practice.fax, addr_practice.country, addr_mailing, addr_mailing.full, addr_mailing.line1, addr_mailing.line2, addr_mailing.city, addr_mailing.state, addr_mailing.zip, addr_mailing.phone, addr_mailing.fax, addr_mailing.country, name_other, name_other.full, name_other.last, name_other.first, name_other.middle, name_other.credential, name_other.prefix, name_other.suffix, licenses, licenses.taxonomy, licenses.taxonomy.code, licenses.taxonomy.grouping, licenses.taxonomy.classification, licenses.taxonomy.specialization, licenses.medicare, licenses.medicare.spc_code, licenses.medicare.type, other_ids, other_ids.id, other_ids.type, other_ids.issuer, other_ids.state, misc, misc.auth_official, misc.replacement_NPI, misc.EIN, misc.enumeration_date, misc.last_update_date, misc.is_sole_proprietor, misc.is_org_subpart, misc.parent_LBN, misc.parent_TIN.", "schema": { "type": "string", "example": "NPI,provider_type,gender" } }, { "name": "extraFields", "in": "query", "required": false, "description": "Comma-separated fields returned with their native types, so objects and arrays stay structured. Accepts field:alias. Allowed: NPI, provider_type, gender, name, name.full, name.last, name.first, name.middle, name.credential, name.prefix, name.suffix, addr_practice, addr_practice.full, addr_practice.line1, addr_practice.line2, addr_practice.city, addr_practice.state, addr_practice.zip, addr_practice.phone, addr_practice.fax, addr_practice.country, addr_mailing, addr_mailing.full, addr_mailing.line1, addr_mailing.line2, addr_mailing.city, addr_mailing.state, addr_mailing.zip, addr_mailing.phone, addr_mailing.fax, addr_mailing.country, name_other, name_other.full, name_other.last, name_other.first, name_other.middle, name_other.credential, name_other.prefix, name_other.suffix, licenses, licenses.taxonomy, licenses.taxonomy.code, licenses.taxonomy.grouping, licenses.taxonomy.classification, licenses.taxonomy.specialization, licenses.medicare, licenses.medicare.spc_code, licenses.medicare.type, other_ids, other_ids.id, other_ids.type, other_ids.issuer, other_ids.state, misc, misc.auth_official, misc.replacement_NPI, misc.EIN, misc.enumeration_date, misc.last_update_date, misc.is_sole_proprietor, misc.is_org_subpart, misc.parent_LBN, misc.parent_TIN.", "schema": { "type": "string", "example": "name,addr_practice" } }, { "name": "searchFields", "in": "query", "required": false, "description": "Comma-separated fields the search text is matched against. Allowed: NPI, provider_type, gender, name, name.full, name.last, name.first, name.middle, name.credential, name.prefix, name.suffix, addr_practice, addr_practice.full, addr_practice.line1, addr_practice.line2, addr_practice.city, addr_practice.state, addr_practice.zip, addr_practice.phone, addr_practice.fax, addr_practice.country, addr_mailing, addr_mailing.full, addr_mailing.line1, addr_mailing.line2, addr_mailing.city, addr_mailing.state, addr_mailing.zip, addr_mailing.phone, addr_mailing.fax, addr_mailing.country, name_other, name_other.full, name_other.last, name_other.first, name_other.middle, name_other.credential, name_other.prefix, name_other.suffix, licenses, licenses.taxonomy, licenses.taxonomy.code, licenses.taxonomy.grouping, licenses.taxonomy.classification, licenses.taxonomy.specialization, licenses.medicare, licenses.medicare.spc_code, licenses.medicare.type, other_ids, other_ids.id, other_ids.type, other_ids.issuer, other_ids.state, misc, misc.auth_official, misc.replacement_NPI, misc.EIN, misc.enumeration_date, misc.last_update_date, misc.is_sole_proprietor, misc.is_org_subpart, misc.parent_LBN, misc.parent_TIN.", "schema": { "type": "string", "example": "NPI,provider_type,gender" } }, { "name": "codeField", "in": "query", "required": false, "description": "The single field to report as each item's code. Allowed: NPI, provider_type, gender, name, name.full, name.last, name.first, name.middle, name.credential, name.prefix, name.suffix, addr_practice, addr_practice.full, addr_practice.line1, addr_practice.line2, addr_practice.city, addr_practice.state, addr_practice.zip, addr_practice.phone, addr_practice.fax, addr_practice.country, addr_mailing, addr_mailing.full, addr_mailing.line1, addr_mailing.line2, addr_mailing.city, addr_mailing.state, addr_mailing.zip, addr_mailing.phone, addr_mailing.fax, addr_mailing.country, name_other, name_other.full, name_other.last, name_other.first, name_other.middle, name_other.credential, name_other.prefix, name_other.suffix, licenses, licenses.taxonomy, licenses.taxonomy.code, licenses.taxonomy.grouping, licenses.taxonomy.classification, licenses.taxonomy.specialization, licenses.medicare, licenses.medicare.spc_code, licenses.medicare.type, other_ids, other_ids.id, other_ids.type, other_ids.issuer, other_ids.state, misc, misc.auth_official, misc.replacement_NPI, misc.EIN, misc.enumeration_date, misc.last_update_date, misc.is_sole_proprietor, misc.is_org_subpart, misc.parent_LBN, misc.parent_TIN.", "schema": { "type": "string", "example": "NPI" } }, { "name": "filter", "in": "query", "required": false, "description": "Elasticsearch query-string filter applied on top of the search text. It is not wildcarded automatically", "schema": { "type": "string", "example": "addr_practice.state:PA" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "page": 1, "count": 0, "items": [], "limit": 3, "terms": "john smith", "total": 0, "hasMore": false, "nextPage": null, "provider": "clinical-tables" } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:clinical-tables/providers-organisation": { "get": { "operationId": "health_clinical_tables_providers_organisation", "summary": "Providers Organisation", "description": "NPI registry — organisation providers — clinicaltables.nlm.nih.gov `npi_org`, direct JSON, no key. The service answers with a positional array [total, codes, extra, displayRows]", "tags": [ "Clinical Tables" ], "externalDocs": { "url": "https://zapi.ink/api/health/clinical-tables#reference-providers-organisation" }, "parameters": [ { "name": "terms", "in": "query", "required": true, "description": "Search text. Several partial words are combined with an implicit AND", "schema": { "type": "string", "example": "hospital" } }, { "name": "page", "in": "query", "required": false, "description": "Page number. Default 1", "schema": { "type": "number", "example": "1" } }, { "name": "limit", "in": "query", "required": false, "description": "Items per page. Default 10, max 500. Page times limit may not exceed 7500", "schema": { "type": "number", "example": "10" } }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated fields returned as display strings. Allowed: NPI, provider_type, name, name.full, name.last, name.first, name.middle, name.credential, name.prefix, name.suffix, addr_practice, addr_practice.full, addr_practice.line1, addr_practice.line2, addr_practice.city, addr_practice.state, addr_practice.zip, addr_practice.phone, addr_practice.fax, addr_practice.country, addr_mailing, addr_mailing.full, addr_mailing.line1, addr_mailing.line2, addr_mailing.city, addr_mailing.state, addr_mailing.zip, addr_mailing.phone, addr_mailing.fax, addr_mailing.country, name_other, name_other.full, name_other.last, name_other.first, name_other.middle, name_other.credential, name_other.prefix, name_other.suffix, licenses, licenses.taxonomy, licenses.taxonomy.code, licenses.taxonomy.grouping, licenses.taxonomy.classification, licenses.taxonomy.specialization, licenses.medicare, licenses.medicare.spc_code, licenses.medicare.type, other_ids, other_ids.id, other_ids.type, other_ids.issuer, other_ids.state, misc, misc.auth_official, misc.replacement_NPI, misc.EIN, misc.enumeration_date, misc.last_update_date, misc.is_sole_proprietor, misc.is_org_subpart, misc.parent_LBN, misc.parent_TIN.", "schema": { "type": "string", "example": "NPI,provider_type,name.full" } }, { "name": "extraFields", "in": "query", "required": false, "description": "Comma-separated fields returned with their native types, so objects and arrays stay structured. Accepts field:alias. Allowed: NPI, provider_type, name, name.full, name.last, name.first, name.middle, name.credential, name.prefix, name.suffix, addr_practice, addr_practice.full, addr_practice.line1, addr_practice.line2, addr_practice.city, addr_practice.state, addr_practice.zip, addr_practice.phone, addr_practice.fax, addr_practice.country, addr_mailing, addr_mailing.full, addr_mailing.line1, addr_mailing.line2, addr_mailing.city, addr_mailing.state, addr_mailing.zip, addr_mailing.phone, addr_mailing.fax, addr_mailing.country, name_other, name_other.full, name_other.last, name_other.first, name_other.middle, name_other.credential, name_other.prefix, name_other.suffix, licenses, licenses.taxonomy, licenses.taxonomy.code, licenses.taxonomy.grouping, licenses.taxonomy.classification, licenses.taxonomy.specialization, licenses.medicare, licenses.medicare.spc_code, licenses.medicare.type, other_ids, other_ids.id, other_ids.type, other_ids.issuer, other_ids.state, misc, misc.auth_official, misc.replacement_NPI, misc.EIN, misc.enumeration_date, misc.last_update_date, misc.is_sole_proprietor, misc.is_org_subpart, misc.parent_LBN, misc.parent_TIN.", "schema": { "type": "string", "example": "name,addr_practice" } }, { "name": "searchFields", "in": "query", "required": false, "description": "Comma-separated fields the search text is matched against. Allowed: NPI, provider_type, name, name.full, name.last, name.first, name.middle, name.credential, name.prefix, name.suffix, addr_practice, addr_practice.full, addr_practice.line1, addr_practice.line2, addr_practice.city, addr_practice.state, addr_practice.zip, addr_practice.phone, addr_practice.fax, addr_practice.country, addr_mailing, addr_mailing.full, addr_mailing.line1, addr_mailing.line2, addr_mailing.city, addr_mailing.state, addr_mailing.zip, addr_mailing.phone, addr_mailing.fax, addr_mailing.country, name_other, name_other.full, name_other.last, name_other.first, name_other.middle, name_other.credential, name_other.prefix, name_other.suffix, licenses, licenses.taxonomy, licenses.taxonomy.code, licenses.taxonomy.grouping, licenses.taxonomy.classification, licenses.taxonomy.specialization, licenses.medicare, licenses.medicare.spc_code, licenses.medicare.type, other_ids, other_ids.id, other_ids.type, other_ids.issuer, other_ids.state, misc, misc.auth_official, misc.replacement_NPI, misc.EIN, misc.enumeration_date, misc.last_update_date, misc.is_sole_proprietor, misc.is_org_subpart, misc.parent_LBN, misc.parent_TIN.", "schema": { "type": "string", "example": "NPI,provider_type,name.full" } }, { "name": "codeField", "in": "query", "required": false, "description": "The single field to report as each item's code. Allowed: NPI, provider_type, name, name.full, name.last, name.first, name.middle, name.credential, name.prefix, name.suffix, addr_practice, addr_practice.full, addr_practice.line1, addr_practice.line2, addr_practice.city, addr_practice.state, addr_practice.zip, addr_practice.phone, addr_practice.fax, addr_practice.country, addr_mailing, addr_mailing.full, addr_mailing.line1, addr_mailing.line2, addr_mailing.city, addr_mailing.state, addr_mailing.zip, addr_mailing.phone, addr_mailing.fax, addr_mailing.country, name_other, name_other.full, name_other.last, name_other.first, name_other.middle, name_other.credential, name_other.prefix, name_other.suffix, licenses, licenses.taxonomy, licenses.taxonomy.code, licenses.taxonomy.grouping, licenses.taxonomy.classification, licenses.taxonomy.specialization, licenses.medicare, licenses.medicare.spc_code, licenses.medicare.type, other_ids, other_ids.id, other_ids.type, other_ids.issuer, other_ids.state, misc, misc.auth_official, misc.replacement_NPI, misc.EIN, misc.enumeration_date, misc.last_update_date, misc.is_sole_proprietor, misc.is_org_subpart, misc.parent_LBN, misc.parent_TIN.", "schema": { "type": "string", "example": "NPI" } }, { "name": "filter", "in": "query", "required": false, "description": "Elasticsearch query-string filter applied on top of the search text. It is not wildcarded automatically", "schema": { "type": "string", "example": "addr_practice.state:TX" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "page": 1, "count": 3, "items": [ { "npi": "1821205840", "code": "1821205840", "name": { "full": "HOSPITAL" }, "nameFull": "HOSPITAL", "addrPractice": { "zip": "75115", "city": "DESOTO", "full": "605 AUSTIN DR, DESOTO, TX 75115", "zip4": "6605", "line1": "605 AUSTIN DR", "phone": "(972) 230-0854", "state": "TX", "country": "US" }, "providerType": "Hospital-General" }, { "npi": "1922162403", "code": "1922162403", "name": { "full": "INNOVA HOSPITAL HOUSTON LP DBA INNOVA HOSPITAL HOUSTON" }, "nameFull": "INNOVA HOSPITAL HOUSTON LP DBA INNOVA HOSPITAL HOUSTON", "addrPractice": { "zip": "77004", "city": "HOUSTON", "full": "2001 HERMANN DR, HOUSTON, TX 77004", "zip4": "7321", "line1": "2001 HERMANN DR", "phone": "(713) 358-5300", "state": "TX", "country": "US" }, "providerType": "Hospital-General" }, { "npi": "1114293701", "code": "1114293701", "name": { "full": "REDOAK HOSPITAL" }, "nameFull": "REDOAK HOSPITAL", "addrPractice": { "fax": "(281) 605-4563", "zip": "77090", "city": "HOUSTON", "full": "17440 REDOAK DR, HOUSTON, TX 77090", "line1": "17440 REDOAK DR", "phone": "(281) 257-0404", "state": "TX", "country": "US" }, "providerType": "Hospital-General" } ], "limit": 3, "terms": "hospital", "total": 5386, "hasMore": true, "nextPage": 2, "provider": "clinical-tables" } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:clinical-tables/refseqs": { "get": { "operationId": "health_clinical_tables_refseqs", "summary": "Refseqs", "description": "RefSeq transcript accessions — clinicaltables.nlm.nih.gov `refseqs`, direct JSON, no key. The service answers with a positional array [total, codes, extra, displayRows]", "tags": [ "Clinical Tables" ], "externalDocs": { "url": "https://zapi.ink/api/health/clinical-tables#reference-refseqs" }, "parameters": [ { "name": "terms", "in": "query", "required": true, "description": "Search text. Several partial words are combined with an implicit AND", "schema": { "type": "string", "example": "BRCA1" } }, { "name": "page", "in": "query", "required": false, "description": "Page number. Default 1", "schema": { "type": "number", "example": "1" } }, { "name": "limit", "in": "query", "required": false, "description": "Items per page. Default 10, max 500. Page times limit may not exceed 7500", "schema": { "type": "number", "example": "10" } }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated fields returned as display strings. Allowed: RefSeq, gene, NP_RefSeq, NC_RefSeq.", "schema": { "type": "string", "example": "RefSeq,gene,NP_RefSeq" } }, { "name": "extraFields", "in": "query", "required": false, "description": "Comma-separated fields returned with their native types, so objects and arrays stay structured. Accepts field:alias. Allowed: RefSeq, gene, NP_RefSeq, NC_RefSeq.", "schema": { "type": "string", "example": "RefSeq,gene" } }, { "name": "searchFields", "in": "query", "required": false, "description": "Comma-separated fields the search text is matched against. Allowed: RefSeq, gene, NP_RefSeq, NC_RefSeq.", "schema": { "type": "string", "example": "RefSeq,gene,NP_RefSeq" } }, { "name": "codeField", "in": "query", "required": false, "description": "The single field to report as each item's code. Allowed: RefSeq, gene, NP_RefSeq, NC_RefSeq.", "schema": { "type": "string", "example": "RefSeq" } }, { "name": "filter", "in": "query", "required": false, "description": "Elasticsearch query-string filter applied on top of the search text. It is not wildcarded automatically", "schema": { "type": "string", "example": "gene:BRCA1" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "page": 1, "count": 3, "items": [ { "code": "NM_007300.3", "gene": "BRCA1", "refSeq": "NM_007300.3", "npRefSeq": "NP_009231.2" }, { "code": "NR_027676.1", "gene": "BRCA1", "refSeq": "NR_027676.1" }, { "code": "NM_007294.3", "gene": "BRCA1", "refSeq": "NM_007294.3", "npRefSeq": "NP_009225.1" } ], "limit": 3, "terms": "BRCA1", "total": 11, "hasMore": true, "nextPage": 2, "provider": "clinical-tables" } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:clinical-tables/search": { "get": { "operationId": "health_clinical_tables_search", "summary": "Search", "description": "Generic Clinical Table Search — one grammar over all 22 keyless NLM tables. The escape hatch for the per-table endpoints: a table added upstream is reachable here without a new handler.", "tags": [ "Clinical Tables" ], "externalDocs": { "url": "https://zapi.ink/api/health/clinical-tables#reference-search" }, "parameters": [ { "name": "table", "in": "query", "required": true, "description": "The NLM clinical table to search", "schema": { "type": "string", "enum": [ "conditions", "cosmic_struct", "cytogenetic_locs", "dbvar", "disease_names", "drug_ingredients", "hcpcs", "hpo", "icd10cm", "icd11_codes", "icd9cm_dx", "icd9cm_sg", "loinc_items", "ncbi_genes", "npi_idv", "npi_org", "procedures", "refseqs", "rxterms", "snps", "star_alleles", "ucum" ], "example": "icd10cm" } }, { "name": "terms", "in": "query", "required": true, "description": "Search text. Several partial words are combined with an implicit AND", "schema": { "type": "string", "example": "diabetes" } }, { "name": "page", "in": "query", "required": false, "description": "Page number. Default 1", "schema": { "type": "number", "example": "1" } }, { "name": "limit", "in": "query", "required": false, "description": "Items per page. Default 10, max 500. Page times limit may not exceed 7500", "schema": { "type": "number", "example": "10" } }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated fields returned as display strings. Each table has its own field list, and a name outside it is rejected rather than passed on", "schema": { "type": "string", "example": "code,name" } }, { "name": "extraFields", "in": "query", "required": false, "description": "Comma-separated fields returned with their native types, so objects and arrays stay structured. Accepts field:alias", "schema": { "type": "string", "example": "synonyms" } }, { "name": "searchFields", "in": "query", "required": false, "description": "Comma-separated fields the search text is matched against", "schema": { "type": "string", "example": "code,name" } }, { "name": "codeField", "in": "query", "required": false, "description": "The single field to report as each item's code", "schema": { "type": "string", "example": "code" } }, { "name": "filter", "in": "query", "required": false, "description": "Elasticsearch query-string filter applied on top of the search text. It is not wildcarded automatically", "schema": { "type": "string", "example": "code:E11*" } }, { "name": "type", "in": "query", "required": false, "description": "loinc_items only. Restrict to questions, forms or panels", "schema": { "type": "string", "enum": [ "question", "form", "panel" ], "example": "panel" } }, { "name": "available", "in": "query", "required": false, "description": "loinc_items only. With true, only forms whose definition this service can return", "schema": { "type": "string", "enum": [ "true", "false" ], "example": "true" } }, { "name": "excludeCopyrighted", "in": "query", "required": false, "description": "loinc_items only. With true, drop copyrighted items. Default false", "schema": { "type": "string", "enum": [ "true", "false" ], "example": "false" } }, { "name": "codeType", "in": "query", "required": false, "description": "icd11_codes only. Restrict to stem codes, extension codes, or both", "schema": { "type": "string", "enum": [ "stem", "extension", "category" ], "example": "stem" } }, { "name": "genomeBuild", "in": "query", "required": false, "description": "cosmic_struct only. GRCh human genome build the coordinates refer to", "schema": { "type": "string", "enum": [ "37", "38" ], "example": "38" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "page": 1, "count": 10, "items": [ { "code": "E23.2", "name": "Diabetes insipidus" }, { "code": "N25.1", "name": "Nephrogenic diabetes insipidus" }, { "code": "P70.2", "name": "Neonatal diabetes mellitus" }, { "code": "O24.92", "name": "Unspecified diabetes mellitus in childbirth" }, { "code": "Z83.3", "name": "Family history of diabetes mellitus" }, { "code": "Z86.32", "name": "Personal history of gestational diabetes" }, { "code": "E10.65", "name": "Type 1 diabetes mellitus with hyperglycemia" }, { "code": "E10.9", "name": "Type 1 diabetes mellitus without complications" } ], "limit": 10, "table": "icd10cm", "terms": "diabetes", "total": 481, "hasMore": true, "nextPage": 2, "provider": "clinical-tables" } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:clinical-tables/snps": { "get": { "operationId": "health_clinical_tables_snps", "summary": "Snps", "description": "dbSNP reference SNPs — clinicaltables.nlm.nih.gov `snps`, direct JSON, no key. The service answers with a positional array [total, codes, extra, displayRows]", "tags": [ "Clinical Tables" ], "externalDocs": { "url": "https://zapi.ink/api/health/clinical-tables#reference-snps" }, "parameters": [ { "name": "terms", "in": "query", "required": true, "description": "Search text. Several partial words are combined with an implicit AND", "schema": { "type": "string", "example": "rs1000" } }, { "name": "page", "in": "query", "required": false, "description": "Page number. Default 1", "schema": { "type": "number", "example": "1" } }, { "name": "limit", "in": "query", "required": false, "description": "Items per page. Default 10, max 500. Page times limit may not exceed 7500", "schema": { "type": "number", "example": "10" } }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated fields returned as display strings. Allowed: rsNum, 38.alleles, 38.chr, 38.pos, 38.gene, 38.assembly, 38.seqID, 37.alleles, 37.chr, 37.pos, 37.gene, 37.assembly, 37.seqID.", "schema": { "type": "string", "example": "rsNum,38.chr,38.pos" } }, { "name": "extraFields", "in": "query", "required": false, "description": "Comma-separated fields returned with their native types, so objects and arrays stay structured. Accepts field:alias. Allowed: rsNum, 38.alleles, 38.chr, 38.pos, 38.gene, 38.assembly, 38.seqID, 37.alleles, 37.chr, 37.pos, 37.gene, 37.assembly, 37.seqID.", "schema": { "type": "string", "example": "rsNum,38.chr" } }, { "name": "searchFields", "in": "query", "required": false, "description": "Comma-separated fields the search text is matched against. Allowed: rsNum, 38.alleles, 38.chr, 38.pos, 38.gene, 38.assembly, 38.seqID, 37.alleles, 37.chr, 37.pos, 37.gene, 37.assembly, 37.seqID.", "schema": { "type": "string", "example": "rsNum,38.chr,38.pos" } }, { "name": "codeField", "in": "query", "required": false, "description": "The single field to report as each item's code. Allowed: rsNum, 38.alleles, 38.chr, 38.pos, 38.gene, 38.assembly, 38.seqID, 37.alleles, 37.chr, 37.pos, 37.gene, 37.assembly, 37.seqID.", "schema": { "type": "string", "example": "rsNum" } }, { "name": "filter", "in": "query", "required": false, "description": "Elasticsearch query-string filter applied on top of the search text. It is not wildcarded automatically", "schema": { "type": "string", "example": "38.chr:6" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "page": 1, "count": 3, "items": [ { "code": "rs1000", "chr38": "6", "pos38": "32186117", "rsNum": "rs1000" }, { "code": "rs1000000629", "chr38": "6", "pos38": "33235706", "rsNum": "rs1000000629" }, { "code": "rs1000001594", "chr38": "6", "pos38": "33021616", "rsNum": "rs1000001594" } ], "limit": 3, "terms": "rs1000", "total": 10000, "hasMore": true, "nextPage": 2, "provider": "clinical-tables" } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:clinical-tables/star-alleles": { "get": { "operationId": "health_clinical_tables_star_alleles", "summary": "Star Alleles", "description": "Pharmacogenomic star alleles — clinicaltables.nlm.nih.gov `star_alleles`, direct JSON, no key. The service answers with a positional array [total, codes, extra, displayRows]", "tags": [ "Clinical Tables" ], "externalDocs": { "url": "https://zapi.ink/api/health/clinical-tables#reference-star-alleles" }, "parameters": [ { "name": "terms", "in": "query", "required": true, "description": "Search text. Several partial words are combined with an implicit AND", "schema": { "type": "string", "example": "CYP2D6" } }, { "name": "page", "in": "query", "required": false, "description": "Page number. Default 1", "schema": { "type": "number", "example": "1" } }, { "name": "limit", "in": "query", "required": false, "description": "Items per page. Default 10, max 500. Page times limit may not exceed 7500", "schema": { "type": "number", "example": "10" } }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated fields returned as display strings. Allowed: StarAlleleName, GenBank, ProteinAffected, cDNANucleotideChanges, GeneNucleotideChange, XbaIHaplotype, RFLP, OtherNames, ProteinChange, InVivoEnzymeActivity, InVitroEnzymeActivity, References, ClinicalPhenotype, Notes.", "schema": { "type": "string", "example": "StarAlleleName,OtherNames,GenBank" } }, { "name": "extraFields", "in": "query", "required": false, "description": "Comma-separated fields returned with their native types, so objects and arrays stay structured. Accepts field:alias. Allowed: StarAlleleName, GenBank, ProteinAffected, cDNANucleotideChanges, GeneNucleotideChange, XbaIHaplotype, RFLP, OtherNames, ProteinChange, InVivoEnzymeActivity, InVitroEnzymeActivity, References, ClinicalPhenotype, Notes.", "schema": { "type": "string", "example": "XbaIHaplotype,RFLP" } }, { "name": "searchFields", "in": "query", "required": false, "description": "Comma-separated fields the search text is matched against. Allowed: StarAlleleName, GenBank, ProteinAffected, cDNANucleotideChanges, GeneNucleotideChange, XbaIHaplotype, RFLP, OtherNames, ProteinChange, InVivoEnzymeActivity, InVitroEnzymeActivity, References, ClinicalPhenotype, Notes.", "schema": { "type": "string", "example": "StarAlleleName,OtherNames,GenBank" } }, { "name": "codeField", "in": "query", "required": false, "description": "The single field to report as each item's code. Allowed: StarAlleleName, GenBank, ProteinAffected, cDNANucleotideChanges, GeneNucleotideChange, XbaIHaplotype, RFLP, OtherNames, ProteinChange, InVivoEnzymeActivity, InVitroEnzymeActivity, References, ClinicalPhenotype, Notes.", "schema": { "type": "string", "example": "StarAlleleName" } }, { "name": "filter", "in": "query", "required": false, "description": "Elasticsearch query-string filter applied on top of the search text. It is not wildcarded automatically", "schema": { "type": "string", "example": "StarAlleleName:CYP2D6*" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "page": 1, "count": 3, "items": [ { "code": "CYP2D6*18", "otherNames": "CYP2D6(J9)", "xbaIHaplotype": "29", "starAlleleName": "CYP2D6*18" }, { "code": "CYP2D6*1A", "genBank": "M33388.1", "otherNames": "Wild-type", "xbaIHaplotype": "29", "starAlleleName": "CYP2D6*1A" }, { "code": "CYP2D6*1B", "genBank": "M33388.1", "xbaIHaplotype": "29", "starAlleleName": "CYP2D6*1B" } ], "limit": 3, "terms": "CYP2D6", "total": 168, "hasMore": true, "nextPage": 2, "provider": "clinical-tables" } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:clinical-tables/units": { "get": { "operationId": "health_clinical_tables_units", "summary": "Units", "description": "UCUM units of measure — clinicaltables.nlm.nih.gov `ucum`, direct JSON, no key. The service answers with a positional array [total, codes, extra, displayRows]", "tags": [ "Clinical Tables" ], "externalDocs": { "url": "https://zapi.ink/api/health/clinical-tables#reference-units" }, "parameters": [ { "name": "terms", "in": "query", "required": true, "description": "Search text. Several partial words are combined with an implicit AND", "schema": { "type": "string", "example": "mg" } }, { "name": "page", "in": "query", "required": false, "description": "Page number. Default 1", "schema": { "type": "number", "example": "1" } }, { "name": "limit", "in": "query", "required": false, "description": "Items per page. Default 10, max 500. Page times limit may not exceed 7500", "schema": { "type": "number", "example": "10" } }, { "name": "fields", "in": "query", "required": false, "description": "Comma-separated fields returned as display strings. Allowed: cs_code, name, category, synonyms, loinc_property, guidance, source, is_simple, cs_code_tokens.", "schema": { "type": "string", "example": "cs_code,name,category" } }, { "name": "extraFields", "in": "query", "required": false, "description": "Comma-separated fields returned with their native types, so objects and arrays stay structured. Accepts field:alias. Allowed: cs_code, name, category, synonyms, loinc_property, guidance, source, is_simple, cs_code_tokens.", "schema": { "type": "string", "example": "synonyms,cs_code_tokens" } }, { "name": "searchFields", "in": "query", "required": false, "description": "Comma-separated fields the search text is matched against. Allowed: cs_code, name, category, synonyms, loinc_property, guidance, source, is_simple, cs_code_tokens.", "schema": { "type": "string", "example": "cs_code,name,category" } }, { "name": "codeField", "in": "query", "required": false, "description": "The single field to report as each item's code. Allowed: cs_code, name, category, synonyms, loinc_property, guidance, source, is_simple, cs_code_tokens.", "schema": { "type": "string", "example": "cs_code" } }, { "name": "filter", "in": "query", "required": false, "description": "Elasticsearch query-string filter applied on top of the search text. It is not wildcarded automatically", "schema": { "type": "string", "example": "is_simple:true" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "page": 1, "count": 1, "items": [ { "code": "mg", "name": "milligram", "csCode": "mg", "category": "Clinical", "synonyms": "milligrams", "csCodeTokens": "mg" } ], "limit": 3, "terms": "mg", "total": 1, "hasMore": false, "nextPage": null, "provider": "clinical-tables" } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:halodoc/list": { "get": { "operationId": "health_halodoc_list", "summary": "Daftar Artikel", "description": "Daftar artikel kesehatan Halodoc (mendukung filter trending & pagination).", "tags": [ "Halodoc" ], "externalDocs": { "url": "https://zapi.ink/api/health/halodoc#reference-list" }, "parameters": [ { "name": "page", "in": "query", "required": false, "description": "Nomor halaman (1-based), default 1, max 500", "schema": { "type": "number", "example": "1" } }, { "name": "perPage", "in": "query", "required": false, "description": "Jumlah artikel per halaman, default 10, max 30", "schema": { "type": "number", "example": "10" } }, { "name": "trending", "in": "query", "required": false, "description": "Ambil artikel trending saja, default false", "schema": { "type": "string", "enum": [ "true", "false" ], "example": "false" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "page": 1, "count": 10, "items": [ { "id": "b97e2b0e-fa8d-49c5-9191-3f3524cf5992", "url": "https://www.halodoc.com/artikel/apa-itu-sikap-denial-ini-penyebab-dampak-dan-cara-mengatasinya", "slug": "apa-itu-sikap-denial-ini-penyebab-dampak-dan-cara-mengatasinya", "image": "https://d1vbn70lmn1nqe.cloudfront.net/prod/wp-content/uploads/2025/01/16042551/Apa-Itu-Sikap-Denial_-Ini-Penyebab-Dampak-dan-Cara-Mengatasinya.jpg", "title": "Apa Itu Sikap Denial? Ini Penyebab, Dampak, dan Cara Mengatasinya", "summary": "Denial adalah mekanisme pertahanan psikologis yang memberikan perlindungan sementara.", "keywords": [ "apa itu sikap denial" ], "language": "bahasa_indonesia", "thumbnail": "https://d1vbn70lmn1nqe.cloudfront.net/prod/wp-content/uploads/2025/01/16042551/Apa-Itu-Sikap-Denial_-Ini-Penyebab-Dampak-dan-Cara-Mengatasinya-150x99.jpg", "updatedAt": "2026-06-12T19:55:50.000Z", "categories": [ { "name": "Hidup Sehat", "slug": "hidup-sehat" } ], "publishedAt": "2026-06-12T00:00:00.000Z", "readingTime": 5 }, { "id": "b860d150-8af8-44bf-adeb-ac368d98b01b", "url": "https://www.halodoc.com/artikel/ini-tanda-darah-tinggi-yang-harus-diketahui", "slug": "ini-tanda-darah-tinggi-yang-harus-diketahui", "image": "https://d1vbn70lmn1nqe.cloudfront.net/prod/wp-content/uploads/2023/05/30045732/Terkenal-Silent-Ini-Komplikasi-Hipertensi-yang-Sebabkan-Kematian.jpg", "title": "Ini Tanda Darah Tinggi yang Harus Diketahui", "summary": "Ada sejumlah tanda atau ciri penyakit darah tinggi, mulai dari sakit kepala akibat peningkatan tekanan hingga perubahan visual.", "keywords": [ "darah tinggi" ], "language": "bahasa_indonesia", "thumbnail": "https://d1vbn70lmn1nqe.cloudfront.net/prod/wp-content/uploads/2023/05/30045732/Terkenal-Silent-Ini-Komplikasi-Hipertensi-yang-Sebabkan-Kematian-150x99.jpg", "updatedAt": "2026-06-12T19:55:26.000Z", "categories": [ { "name": "Hidup Sehat", "slug": "hidup-sehat" } ], "publishedAt": "2026-06-12T00:00:00.000Z", "readingTime": 7 }, { "id": "4b5b11d3-1966-4d24-84d1-31b2d7b5e7c5", "url": "https://www.halodoc.com/artikel/catat-ini-cara-sederhana-atasi-gusi-bengkak-pada-anak", "slug": "catat-ini-cara-sederhana-atasi-gusi-bengkak-pada-anak", "image": "https://d1vbn70lmn1nqe.cloudfront.net/prod/wp-content/uploads/2021/08/30023258/Catat-Ini-Cara-Sederhana-Atasi-Gusi-Bengkak-pada-Anak.jpg", "title": "Catat, Ini Cara Sederhana Atasi Gusi Bengkak pada Anak", "summary": "Gusi bengkak bisa menimbulkan rasa nyeri yang membuat anak tidak nyaman. Anak bisa minum obat paracetamol untuk meredakan nyeri.", "keywords": [ "gusi bengkak" ], "language": "bahasa_indonesia", "thumbnail": "https://d1vbn70lmn1nqe.cloudfront.net/prod/wp-content/uploads/2021/08/30023258/Catat-Ini-Cara-Sederhana-Atasi-Gusi-Bengkak-pada-Anak-150x99.jpg", "updatedAt": "2026-06-12T19:55:03.000Z", "categories": [ { "name": "Hidup Sehat", "slug": "hidup-sehat" } ], "publishedAt": "2026-06-12T00:00:00.000Z", "readingTime": 5 }, { "id": "e2bcb6ef-ab60-4bde-8e19-1788abf84d92", "url": "https://www.halodoc.com/artikel/ketahui-pantangan-makanan-bagi-pengidap-hipertiroid", "slug": "ketahui-pantangan-makanan-bagi-pengidap-hipertiroid", "image": "https://d1vbn70lmn1nqe.cloudfront.net/prod/wp-content/uploads/2023/01/12043732/Ketahui-Pantangan-Makanan-bagi-Pengidap-Hipertiroid.jpg", "title": "Ketahui Pantangan Makanan bagi Pengidap Hipertiroid", "summary": "“Hipertiroid merupakan penyakit yang ditandai dengan tingginya kadar hormon tiroid di dalam tubuh. Beberapa jenis makanan yang harus dihindari, yaitu garam, kecap, tahu, lobak, wortel, dan timun. ✔️Artikel ini telah di-review dokter ”", "keywords": [ "hipertiroid" ], "language": "bahasa_indonesia", "thumbnail": "https://d1vbn70lmn1nqe.cloudfront.net/prod/wp-content/uploads/2023/01/12043732/Ketahui-Pantangan-Makanan-bagi-Pengidap-Hipertiroid-150x99.jpg", "updatedAt": "2026-06-12T19:54:39.000Z", "categories": [ { "name": "Hidup Sehat", "slug": "hidup-sehat" } ], "publishedAt": "2026-06-12T00:00:00.000Z", "readingTime": 3 }, { "id": "91021320-2120-44a6-a184-83223b486cc1", "url": "https://www.halodoc.com/artikel/ukuran-perut-hamil-4-bulan-normalnya-sebesar-alpukat", "slug": "ukuran-perut-hamil-4-bulan-normalnya-sebesar-alpukat", "image": "https://d1vbn70lmn1nqe.cloudfront.net/prod/wp-content/uploads/2026/04/07053152/ukuran-perut-hamil-4-bulan.jpg", "title": "Ukuran Perut Hamil 4 Bulan: Normalnya Sebesar Alpukat?", "summary": "Ukuran Perut Hamil 4 Bulan: Ini Normalnya Gimana?", "keywords": [ "Ukuran Perut Hamil 4 Bulan: Normalnya Sebesar Alpukat?" ], "language": "bahasa_indonesia", "thumbnail": "https://d1vbn70lmn1nqe.cloudfront.net/prod/wp-content/uploads/2026/04/07053152/ukuran-perut-hamil-4-bulan-150x100.jpg", "updatedAt": "2026-06-12T19:53:24.000Z", "categories": [ { "name": "Hidup Sehat", "slug": "hidup-sehat" } ], "publishedAt": "2026-06-12T00:00:00.000Z" }, { "id": "da6cffdd-bdbd-414c-bf76-1959ba7d3294", "url": "https://www.halodoc.com/artikel/bukan-cuma-nyeri-dada-ini-ciri-ciri-penyakit-jantung-di-usia-muda", "slug": "bukan-cuma-nyeri-dada-ini-ciri-ciri-penyakit-jantung-di-usia-muda", "image": "https://d1vbn70lmn1nqe.cloudfront.net/prod/wp-content/uploads/2022/12/23060348/Bukan-Cuma-Nyeri-Dada-Ini-Ciri-Ciri-Penyakit-Jantung-di-Usia-Muda.jpg", "title": "Bukan Cuma Nyeri Dada, Ini Ciri-Ciri Penyakit Jantung di Usia Muda", "summary": "“Penyakit jantung adalah gangguan yang bisa menyerang semua orang, termasuk anak muda. Ciri-cirinya antara lain sesak napas, tubuh mudah lelah, hingga sakit pada bagian rahang dan leher.”", "keywords": [ "ciri-ciri penyakit jantung" ], "language": "bahasa_indonesia", "thumbnail": "https://d1vbn70lmn1nqe.cloudfront.net/prod/wp-content/uploads/2022/12/23060348/Bukan-Cuma-Nyeri-Dada-Ini-Ciri-Ciri-Penyakit-Jantung-di-Usia-Muda-150x99.jpg", "updatedAt": "2026-06-12T19:52:14.000Z", "categories": [ { "name": "Hidup Sehat", "slug": "hidup-sehat" } ], "publishedAt": "2026-06-12T00:00:00.000Z", "readingTime": 3 }, { "id": "df9a4849-252a-4ed4-9e8c-2581e22b22a1", "url": "https://www.halodoc.com/artikel/efek-kemoterapi-pertama-tangani-dengan-cara-ini", "slug": "efek-kemoterapi-pertama-tangani-dengan-cara-ini", "image": "https://d1vbn70lmn1nqe.cloudfront.net/prod/wp-content/uploads/2022/01/27034223/Efek-Kemoterapi-Pertama-Tangani-dengan-Cara-Ini.jpg", "title": "Efek Kemoterapi Pertama Tangani dengan Cara Ini", "summary": "“Efek kemoterapi pertama muncul ketika sel-sel normal dalam tubuh rusak oleh bahan kimia dalam obat. Beberapa sel yang rusak, termasuk sel pembentuk darah di sumsum tulang belakang, folikel rambut, dan lain-lain. Lantas, bagaimana cara untuk mengatasinya?”", "keywords": [ "efek kemoterapi pertama kanker" ], "language": "bahasa_indonesia", "thumbnail": "https://d1vbn70lmn1nqe.cloudfront.net/prod/wp-content/uploads/2022/01/27034223/Efek-Kemoterapi-Pertama-Tangani-dengan-Cara-Ini-150x99.jpg", "updatedAt": "2026-06-12T19:51:51.000Z", "categories": [ { "name": "Hidup Sehat", "slug": "hidup-sehat" } ], "publishedAt": "2026-06-12T00:00:00.000Z", "readingTime": 3 }, { "id": "836d662e-61ad-413d-a7b7-6467ef15e10a", "url": "https://www.halodoc.com/artikel/manfaat-minum-anggur-merah-cap-orang-tua-bikin-fit", "slug": "manfaat-minum-anggur-merah-cap-orang-tua-bikin-fit", "image": "https://d1vbn70lmn1nqe.cloudfront.net/prod/wp-content/uploads/2026/04/21103949/Nutrisi-dan-Diet-657.jpg", "title": "Manfaat Minum Anggur Merah Cap Orang Tua: Bikin Fit!", "summary": "Manfaat Minum Anggur Merah Cap Orang Tua, Bugar!", "keywords": [ "Manfaat Minum Anggur Merah Cap Orang Tua: Bikin Fit!" ], "language": "bahasa_indonesia", "thumbnail": "https://d1vbn70lmn1nqe.cloudfront.net/prod/wp-content/uploads/2026/04/21103949/Nutrisi-dan-Diet-657-150x100.jpg", "updatedAt": "2026-06-12T19:51:28.000Z", "categories": [ { "name": "Hidup Sehat", "slug": "hidup-sehat" } ], "publishedAt": "2026-06-12T00:00:00.000Z" } ], "hasMore": true, "perPage": 10, "nextPage": 2, "totalCount": 10000 } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:halodoc/detail": { "get": { "operationId": "health_halodoc_detail", "summary": "Detail Artikel", "description": "Detail/isi artikel kesehatan Halodoc dari slug atau URL.", "tags": [ "Halodoc" ], "externalDocs": { "url": "https://zapi.ink/api/health/halodoc#reference-detail" }, "parameters": [ { "name": "slug", "in": "query", "required": true, "description": "Slug artikel atau URL lengkap halodoc.com/artikel/", "schema": { "type": "string", "example": "apa-itu-sikap-denial-ini-penyebab-dampak-dan-cara-mengatasinya" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "url": "https://www.halodoc.com/artikel/apa-itu-sikap-denial-ini-penyebab-dampak-dan-cara-mengatasinya", "slug": "apa-itu-sikap-denial-ini-penyebab-dampak-dan-cara-mengatasinya", "image": "https://d1vbn70lmn1nqe.cloudfront.net/prod/wp-content/uploads/2025/01/16042551/Apa-Itu-Sikap-Denial_-Ini-Penyebab-Dampak-dan-Cara-Mengatasinya.jpg", "title": "Apa Itu Sikap Denial? Ini Penyebab, Dampak & Cara Mengatasinya", "author": "Redaksi Halodoc", "bodyText": "FAQ\n\nPernahkah kamu mendengar seseorang berkata, “Ah, dia mah lagi denial aja!” atau mungkin kamu sendiri pernah melontarkan kalimat tersebut kepada temanmu? Di era digital saat ini, banyak istilah psikologi yang akhirnya melebur menjadi bahasa gaul sehari-hari, salah satunya adalah “denial”. Kata ini sering digunakan di media sosial maupun tongkrongan untuk menggambarkan seseorang yang keras kepala, tidak mau mengakui kesalahan, atau menolak kenyataan pahit yang sedang terjadi di depan matanya.\n\nDalam bahasa gaul, “denial” sering dikaitkan dengan urusan asmara. Misalnya, seseorang yang pasangannya jelas-jelas ketahuan berselingkuh atau bersikap toksik (toxic), tetapi ia tetap bertahan dan mencari-cari alasan untuk membenarkan perilaku buruk pasangannya tersebut. Teman-temannya mungkin akan gemas dan menyebutnya “si paling denial”. Namun nyatanya, konteks penggunaan kata ini jauh lebih luas dari sekadar urusan cinta. Hal ini bisa menyangkut pekerjaan, kondisi keuangan, hingga masalah kesehatan yang serius.\n\nMeskipun sudah menjadi bahasa tongkrongan, penting untuk dipahami bahwa “denial” pada dasarnya adalah sebuah terminologi medis dan psikologis yang nyata. Ini bukan sekadar sifat keras kepala biasa, melainkan sebuah mekanisme pertahanan diri (defense mechanism) bawah sadar yang dilakukan oleh otak manusia untuk melindungi diri dari rasa sakit secara emosional. Sayangnya, jika dibiarkan berlarut-larut, sikap ini bisa membawa dampak buruk yang signifikan bagi kesehatan mental maupun fisik.\n\nMemahami apa itu denial, mengapa seseorang bisa mengalaminya, dan bagaimana cara keluar dari fase tersebut adalah langkah awal yang sangat penting untuk menjaga kesejahteraan jiwa kita. Mari kita bedah lebih dalam mengenai fenomena psikologis yang sering kali tidak kita sadari ini.\n\nDalam ilmu psikologi, denial (penyangkalan) pertama kali dikemukakan oleh tokoh psikoanalisis terkenal, Sigmund Freud, dan kemudian dikembangkan lebih lanjut oleh putrinya, Anna Freud. Denial didefinisikan sebagai mekanisme pertahanan ego yang beroperasi di alam bawah sadar. Tujuannya sangat sederhana namun kuat: melindungi pikiran sadar (conscious mind) dari fakta-fakta atau kenyataan hidup yang terlalu menyakitkan, mengejutkan, atau mengancam untuk diterima pada saat itu.\n\nKetika seseorang berhadapan dengan situasi yang menimbulkan stres luar biasa, trauma, atau konflik batin yang hebat, otak akan merespons layaknya tubuh yang terkena infeksi. Jika tubuh memproduksi sel darah putih untuk melawan bakteri, maka pikiran memproduksi “denial” sebagai tameng pelindung. Dengan menolak keberadaan masalah tersebut, orang itu bisa menunda dampak emosional yang menghancurkan, setidaknya untuk sementara waktu.\n\nDalam jangka pendek, denial sebenarnya memiliki fungsi positif. Ini memberi waktu bagi sistem saraf kita untuk beradaptasi dengan kenyataan baru yang mengejutkan, mencegah terjadinya syok psikologis yang parah. Namun, masalah akan muncul ketika denial dijadikan gaya hidup atau cara permanen dalam menghadapi setiap masalah. Menolak kenyataan tidak akan membuat masalah tersebut hilang; sebaliknya, masalah biasanya akan semakin menumpuk dan berpotensi meledak menjadi gangguan mental yang lebih serius seperti depresi atau gangguan kecemasan (anxiety disorder).\n\nTerkadang, sangat sulit untuk menyadari bahwa diri kita sendiri sedang berada dalam fase denial. Hal ini karena mekanisme ini bekerja di bawah sadar. Namun, kita bisa melihat tanda-tandanya dari luar. Berikut adalah beberapa ciri umum seseorang yang sedang mengalami denial:\n\nMenolak Membicarakan Masalah: Mereka akan langsung mengubah topik pembicaraan, marah, atau menghindar ketika seseorang mencoba menyinggung masalah yang sedang mereka hadapi.\n\nMencari Pembenaran (Rasionalisasi): Mereka selalu memiliki seribu satu alasan logis (meskipun sebenarnya tidak masuk akal bagi orang lain) untuk membenarkan situasi buruk yang sedang terjadi.\n\nMenyalahkan Orang Lain (Proyeksi): Daripada mengakui bahwa mereka memiliki andil dalam suatu masalah, mereka lebih memilih menunjuk orang lain, lingkungan, atau keadaan sebagai penyebabnya.\n\nMeminimalkan Masalah: Mereka sering menggunakan kalimat seperti, “Ah, ini bukan masalah besar,” atau “Semua orang juga ngalamin ini kok,” padahal kenyataannya masalah tersebut sudah sangat merugikan.\n\nPerilaku Pasif-Agresif: Karena emosi aslinya ditekan dan tidak diakui, emosi tersebut sering kali bocor melalui tindakan pasif-agresif, seperti menyindir, mendiamkan (silent treatment), atau melakukan sabotase secara diam-diam.\n\nSatu hal yang sering luput dari perhatian banyak orang adalah bagaimana sikap denial bisa secara langsung membahayakan kesehatan fisik. Di dunia medis, penolakan pasien terhadap kondisi kesehatannya adalah tantangan besar yang sering dihadapi oleh para tenaga kesehatan.\n\nContoh yang paling umum adalah ketika seseorang merasakan gejala penyakit tertentu—seperti benjolan di tubuh, nyeri dada yang sering hilang timbul, batuk berdarah, atau penurunan berat badan yang drastis tanpa sebab—namun ia menolak untuk memeriksakan diri ke dokter. Alih-alih mencari tahu diagnosis pastinya, ia meyakinkan dirinya sendiri bahwa “ini cuma masuk angin biasa,” atau “nanti juga sembuh sendiri pakai obat warung.”\n\nDenial dalam kesehatan sangat berbahaya karena dapat menunda penanganan medis (delayed treatment). Banyak penyakit kronis seperti kanker, diabetes, dan penyakit jantung memiliki tingkat kesembuhan yang jauh lebih tinggi jika dideteksi sejak dini (early detection). Akibat denial, pasien baru datang ke rumah sakit ketika penyakitnya sudah mencapai stadium lanjut, di mana opsi pengobatan menjadi jauh lebih terbatas, lebih mahal, dan tingkat keberhasilannya menurun.\n\nSelain itu, bagi mereka yang sudah terdiagnosis pun, denial bisa bermanifestasi dalam bentuk ketidakpatuhan terhadap pengobatan. Misalnya, pasien diabetes yang masih bebas mengonsumsi makanan tinggi gula karena merasa dirinya baik-baik saja, atau pasien hipertensi yang menghentikan konsumsi obat penurun tensi secara sepihak hanya karena merasa tidak pusing lagi.\n\nRasa Takut yang Berlebihan: Takut akan masa depan, takut dihakimi, takut rasa sakit, atau takut kehilangan kendali atas hidupnya.\n\nTrauma Masa Lalu: Pengalaman buruk di masa lalu membuat otak memblokir memori atau kejadian serupa agar luka lama tidak terbuka kembali.\n\nEgo dan Gengsi: Mengakui kesalahan atau kelemahan sering kali dianggap sebagai sebuah kekalahan, sehingga ego mengambil alih untuk menyangkal realita.\n\nTidak ada asap kalau tidak ada api. Seseorang tidak serta-merta menjadi “si paling denial” tanpa adanya pemicu psikologis yang mendasarinya. Beberapa penyebab utama mengapa manusia menggunakan penyangkalan sebagai perisai mental antara lain:\n\nIni adalah alasan paling primitif dan mendasar. Manusia dirancang untuk menghindari rasa sakit. Ketika realita menyodorkan fakta yang menghancurkan hati (misalnya, pasangan selingkuh, dipecat dari pekerjaan impian, atau bisnis bangkrut), otak merespons dengan menyangkal fakta tersebut untuk memberikan efek “mati rasa” sementara.\n\nSetiap orang memiliki tingkat ketahanan mental yang berbeda-beda. Bagi individu yang tidak memiliki keterampilan koping (coping skills) yang sehat—seperti kemampuan mengelola emosi, mencari solusi, atau berkomunikasi dengan baik—denial menjadi jalan pintas termudah untuk lari dari stres.\n\nMenerima sebuah kenyataan yang buruk sering kali berarti kita harus merombak tatanan hidup yang sudah nyaman. Misalnya, mengakui bahwa sebuah pernikahan sudah sangat beracun (toxic) berarti harus siap menghadapi proses perceraian, pembagian harta, hak asuh anak, dan status baru. Ketakutan akan perubahan besar inilah yang membuat seseorang memilih untuk menutup mata.\n\nJika kita berbicara tentang denial, kita tidak bisa lepas dari teori yang dikemukakan oleh psikiater terkenal asal Swiss-Amerika, Elisabeth Kübler-Ross. Pada tahun 1969, ia memperkenalkan model Lima Tahap Kesedihan (The Five Stages of Grief), yang menjelaskan bagaimana proses emosional manusia ketika menghadapi kehilangan, kedukaan, atau penyakit terminal.\n\nDenial atau penyangkalan menempati urutan PERTAMA dalam lima tahapan tersebut. Ketika seseorang menerima berita duka atau kejadian traumatis, reaksi pertamanya hampir selalu, “Tidak, ini tidak mungkin terjadi. Dokter pasti salah diagnosis,” atau “Dia tidak mungkin pergi ninggalin aku.”\n\nTahap denial ini kemudian akan diikuti oleh kemarahan (Anger), tawar-menawar (Bargaining), depresi (Depression), hingga akhirnya sampai pada titik penerimaan (Acceptance). Mengetahui bahwa denial adalah bagian alami dari proses berduka dapat membantu kita untuk lebih berempati, baik kepada diri sendiri maupun kepada orang lain yang sedang tertimpa musibah. Namun, tantangannya adalah bagaimana agar kita tidak terjebak (stuck) di tahap pertama ini selamanya.\n\nMendobrak dinding penyangkalan memang tidak mudah, karena membutuhkan keberanian ekstra untuk menghadapi rasa sakit yang selama ini disembunyikan. Namun, demi kesehatan mental yang lebih baik, langkah ini wajib dilakukan. Berikut adalah beberapa cara untuk mengatasi denial:\n\nLangkah pertama untuk menyembuhkan apa pun adalah menyadari bahwa kamu sedang sakit. Mulailah berlatih jujur pada diri sendiri. Ambil waktu untuk duduk tenang (mindfulness) dan tanyakan pada dirimu: “Apa yang sebenarnya sedang aku hindari?”, “Kenapa aku merasa sangat cemas akhir-akhir ini?” Mencatat isi pikiran di jurnal (journaling) sangat efektif untuk melihat pola pikir yang salah.\n\nOrang yang sedang denial sering kali kehilangan objektivitas. Kamu butuh sudut pandang dari pihak ketiga (third-party perspective) yang netral. Bicarakan masalahmu dengan sahabat terdekat atau anggota keluarga yang bijak dan tidak menghakimi. Dengarkan pendapat mereka, meskipun mungkin awalnya terdengar menyakitkan.\n\nBerhenti menuntut dirimu untuk selalu “kuat” atau “baik-baik saja”. Menangislah jika ingin menangis. Marahlah jika merasa dikhianati (tentu dengan cara yang aman dan tidak merusak). Emosi yang dirasakan dan diekspresikan akan perlahan memudar, sedangkan emosi yang ditekan akan meledak di kemudian hari. Selama masa adaptasi emosional ini, penting untuk tetap menjaga vitalitas tubuh fisikmu. Memastikan asupan nutrisi terjaga dengan mengonsumsi suplemen atau vitamin yang tepat bisa membantu tubuh tetap fit meskipun pikiran sedang penat, sehingga kamu tidak mudah jatuh sakit.\n\nDenial sering muncul karena perasaan tidak berdaya. Lawan perasaan itu dengan mengidentifikasi hal-hal kecil yang masih berada di bawah kendalimu. Daripada terus menyangkal bahwa perusahaanmu bangkrut, mulailah memperbaiki CV atau mencari peluang freelance kecil-kecilan. Aksi nyata akan menggeser otak dari mode defensif menjadi mode penyelesaian masalah (problem-solving).\n\nAda kalanya dinding denial terlalu tebal untuk dirobohkan sendirian. Jika sikap penyangkalan yang kamu atau orang terdekat alami sudah memengaruhi produktivitas kerja, merusak hubungan sosial, menyebabkan gangguan tidur kronis, memicu penyalahgunaan alkohol/obat terlarang, atau menimbulkan pikiran untuk menyakiti diri sendiri, itu adalah tanda bahaya (red flag).\n\nDalam kondisi ini, intervensi profesional medis sangat dibutuhkan. Terapi kognitif-perilaku (Cognitive Behavioral Therapy/CBT) terbukti sangat efektif untuk membantu pasien mengidentifikasi pola pikir penyangkalan dan menggantinya dengan respons yang lebih sehat. Jangan tunda lagi, segera lakukan konsultasi dokter spesialis kesehatan jiwa (psikiater) atau psikolog klinis untuk mendapatkan penanganan medis yang tepat, aman, dan rahasia terjamin.\n\nAmerican Psychological Association (APA) menerbitkan berbagai literatur klinis yang menjelaskan bahwa mekanisme pertahanan diri, termasuk denial, memiliki korelasi yang kuat dengan tingkat stres yang tidak terkelola. Studi-studi modern dalam ranah psikologi klinis menunjukkan bahwa pasien yang diajarkan teknik penerimaan (Acceptance and Commitment Therapy/ACT) menunjukkan penurunan gejala kecemasan dan depresi yang signifikan dibandingkan mereka yang terus menggunakan denial sebagai koping utama.\n\nHal ini membuktikan bahwa keberanian untuk merangkul realita, betapapun pahitnya, adalah kunci utama menuju resiliensi atau ketahanan mental yang sesungguhnya. Otak kita sangat plastis dan bisa dilatih ulang untuk menghadapi kenyataan secara lebih logis dan tenang.\n\nHalodoc Intelligent Digital Assistant adalah asisten AI dari Halodoc yang siap membantu menjawab pertanyaan kesehatan umum, kasih gambaran langkah awal, dan arahin kamu ke pilihan dokter yang sesuai dengan kebutuhan.\n\nHILDA akan memandu kamu dalam memilih dokter spesialis yang tepat, menemukan obat yang dibutuhkan, dan menemukan layanan yang relevan.\n\nHILDA dapat menjawab pertanyaan umum tentang Halodoc dan berbagi informasi kesehatan umum yang kamu butuhkan.\n\nHal yang perlu diingat, HILDA tidak digunakan untuk menggantikan saran medis dari dokter, ya.", "keywords": [ "apa itu sikap denial" ], "sections": [ { "text": "FAQ", "type": "paragraph" }, { "text": "Pernahkah kamu mendengar seseorang berkata, “Ah, dia mah lagi denial aja!” atau mungkin kamu sendiri pernah melontarkan kalimat tersebut kepada temanmu? Di era digital saat ini, banyak istilah psikologi yang akhirnya melebur menjadi bahasa gaul sehari-hari, salah satunya adalah “denial”. Kata ini sering digunakan di media sosial maupun tongkrongan untuk menggambarkan seseorang yang keras kepala, tidak mau mengakui kesalahan, atau menolak kenyataan pahit yang sedang terjadi di depan matanya.", "type": "paragraph" }, { "text": "Dalam bahasa gaul, “denial” sering dikaitkan dengan urusan asmara. Misalnya, seseorang yang pasangannya jelas-jelas ketahuan berselingkuh atau bersikap toksik (toxic), tetapi ia tetap bertahan dan mencari-cari alasan untuk membenarkan perilaku buruk pasangannya tersebut. Teman-temannya mungkin akan gemas dan menyebutnya “si paling denial”. Namun nyatanya, konteks penggunaan kata ini jauh lebih luas dari sekadar urusan cinta. Hal ini bisa menyangkut pekerjaan, kondisi keuangan, hingga masalah kesehatan yang serius.", "type": "paragraph" }, { "text": "Meskipun sudah menjadi bahasa tongkrongan, penting untuk dipahami bahwa “denial” pada dasarnya adalah sebuah terminologi medis dan psikologis yang nyata. Ini bukan sekadar sifat keras kepala biasa, melainkan sebuah mekanisme pertahanan diri (defense mechanism) bawah sadar yang dilakukan oleh otak manusia untuk melindungi diri dari rasa sakit secara emosional. Sayangnya, jika dibiarkan berlarut-larut, sikap ini bisa membawa dampak buruk yang signifikan bagi kesehatan mental maupun fisik.", "type": "paragraph" }, { "text": "Memahami apa itu denial, mengapa seseorang bisa mengalaminya, dan bagaimana cara keluar dari fase tersebut adalah langkah awal yang sangat penting untuk menjaga kesejahteraan jiwa kita. Mari kita bedah lebih dalam mengenai fenomena psikologis yang sering kali tidak kita sadari ini.", "type": "paragraph" }, { "text": "Memahami Apa Itu Denial Secara Psikologis", "type": "heading", "level": 2 }, { "text": "Dalam ilmu psikologi, denial (penyangkalan) pertama kali dikemukakan oleh tokoh psikoanalisis terkenal, Sigmund Freud, dan kemudian dikembangkan lebih lanjut oleh putrinya, Anna Freud. Denial didefinisikan sebagai mekanisme pertahanan ego yang beroperasi di alam bawah sadar. Tujuannya sangat sederhana namun kuat: melindungi pikiran sadar (conscious mind) dari fakta-fakta atau kenyataan hidup yang terlalu menyakitkan, mengejutkan, atau mengancam untuk diterima pada saat itu.", "type": "paragraph" }, { "text": "Ketika seseorang berhadapan dengan situasi yang menimbulkan stres luar biasa, trauma, atau konflik batin yang hebat, otak akan merespons layaknya tubuh yang terkena infeksi. Jika tubuh memproduksi sel darah putih untuk melawan bakteri, maka pikiran memproduksi “denial” sebagai tameng pelindung. Dengan menolak keberadaan masalah tersebut, orang itu bisa menunda dampak emosional yang menghancurkan, setidaknya untuk sementara waktu.", "type": "paragraph" } ], "wordCount": 1705, "description": "Nolak kenyataan terus? Jangan-jangan kamu denial! Pahami apa itu denial dalam bahasa gaul, kenali tanda & cara mengatasinya di sini.", "publishedAt": "2026-06-12T00:00:00.000Z" } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:medlineplus/genetics-condition": { "get": { "operationId": "health_medlineplus_genetics_condition", "summary": "Genetics Condition", "description": "MedlinePlus Genetics — one condition summary from the download bundle, rung 1 (direct). There is no directory index for these files (condition/, gene/ and /xml/ all 404), so the", "tags": [ "MedlinePlus" ], "externalDocs": { "url": "https://zapi.ink/api/health/medlineplus#reference-genetics-condition" }, "parameters": [ { "name": "slug", "in": "query", "required": true, "description": "Condition slug as it appears in the MedlinePlus Genetics URL", "schema": { "type": "string", "example": "alzheimer-disease" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "url": "https://medlineplus.gov/genetics/condition/alzheimer-disease", "name": "Alzheimer disease", "slug": "alzheimer-disease", "provider": "medlineplus", "reviewed": "2019-05", "sections": [ { "html": "

Alzheimer disease is a degenerative disease of the brain that causes dementia, which is a gradual loss of memory, judgment, and ability to function. This disorder usually appears in people older than age 65, but less common forms of the disease appear earlier in adulthood.

Memory loss is the most common sign of Alzheimer disease. Forgetfulness may be subtle at first, but the loss of memory worsens over time until it interferes with most aspects of daily living. Even in familiar settings, a person with Alzheimer disease may get lost or become confused. Routine tasks such as preparing meals, doing laundry, and performing other household chores can be challenging. Additionally, it may become difficult to recognize people and name objects. Affected people increasingly require help with dressing, eating, and personal care.

As the disorder progresses, some people with Alzheimer disease experience personality and behavioral changes and have trouble interacting in a socially appropriate manner. Other common symptoms include agitation, restlessness, withdrawal, and loss of language skills. People with this disease usually require total care during the advanced stages of the disease.

Affected individuals usually survive 8 to 10 years after the appearance of symptoms, but the course of the disease can range from 1 to 25 years. Survival is usually shorter in individuals diagnosed after age 80 than in those diagnosed at a younger age. Death usually results from pneumonia, malnutrition, or general body wasting (inanition).

Alzheimer disease can be classified as early-onset or late-onset. The signs and symptoms of the early-onset form appear between a person's thirties and mid-sixties, while the late-onset form appears during or after a person's mid-sixties. The early-onset form is much less common than the late-onset form, accounting for less than 10 percent of all cases of Alzheimer disease.

", "role": "description" } ], "synonyms": [ "AD", "Alzheimer dementia (AD)", "Alzheimer sclerosis", "Alzheimer syndrome", "Alzheimer's disease", "Alzheimer-type dementia (ATD)", "DAT", "Familial Alzheimer disease (FAD)" ], "published": "2023-03-23", "relatedGenes": [ { "url": "https://medlineplus.gov/genetics/gene/app", "symbol": "APP" }, { "url": "https://medlineplus.gov/genetics/gene/apoe", "symbol": "APOE" }, { "url": "https://medlineplus.gov/genetics/gene/psen1", "symbol": "PSEN1" }, { "url": "https://medlineplus.gov/genetics/gene/psen2", "symbol": "PSEN2" } ], "crossReferences": [ { "db": "GTR", "key": "C0002395" }, { "db": "GTR", "key": "C1843013" }, { "db": "GTR", "key": "C1847200" }, { "db": "GTR", "key": "C1863051" }, { "db": "ICD-10-CM", "key": "G30" }, { "db": "ICD-10-CM", "key": "G30.0" }, { "db": "ICD-10-CM", "key": "G30.1" }, { "db": "ICD-10-CM", "key": "G30.8" } ], "inheritancePatterns": [ { "code": "u", "description": "Pattern unknown" }, { "code": "ad", "description": "Autosomal dominant" } ] } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:medlineplus/genetics-gene": { "get": { "operationId": "health_medlineplus_genetics_gene", "summary": "Genetics Gene", "description": "MedlinePlus Genetics — one gene summary from the download bundle, rung 1 (direct). The .json extension and the application/json content-type both lie here: the body is an XML", "tags": [ "MedlinePlus" ], "externalDocs": { "url": "https://zapi.ink/api/health/medlineplus#reference-genetics-gene" }, "parameters": [ { "name": "symbol", "in": "query", "required": true, "description": "Official gene symbol as used by MedlinePlus Genetics", "schema": { "type": "string", "example": "BRCA1" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "url": "https://medlineplus.gov/genetics/gene/brca1", "name": "BRCA1 DNA repair associated", "geneId": "21728", "symbol": "BRCA1", "provider": "medlineplus", "reviewed": "2015-09", "sections": [ { "html": "

The BRCA1 gene provides instructions for making a protein that acts as a tumor suppressor. Tumor suppressor proteins help prevent cells from growing and dividing too rapidly or in an uncontrolled way.

The BRCA1 protein is involved in repairing damaged DNA. In the nucleus of many types of normal cells, the BRCA1 protein interacts with several other proteins to mend breaks in DNA. These breaks can be caused by natural and medical radiation or other environmental exposures, and they also occur when chromosomes exchange genetic material in preparation for cell division. By helping to repair DNA, the BRCA1 protein plays a critical role in maintaining the stability of a cell's genetic information.

Research suggests that the BRCA1 protein also regulates the activity of other genes and plays an essential role in embryonic development. To carry out these functions, the BRCA1 protein interacts with many other proteins, including other tumor suppressors and proteins that regulate cell division.

", "role": "function" } ], "synonyms": [ "BRCA1 gene", "BRCA1_HUMAN", "BRCC1", "breast cancer 1", "breast cancer 1 gene", "breast cancer 1, early onset", "breast cancer 1, early onset gene", "breast cancer type 1 susceptibility gene" ], "published": "2025-04-03", "crossReferences": [ { "db": "NCBI Gene", "key": "672" }, { "db": "OMIM", "key": "113705" } ], "relatedConditions": [ { "url": "https://medlineplus.gov/genetics/condition/breast-cancer", "name": "Breast cancer" }, { "url": "https://medlineplus.gov/genetics/condition/fanconi-anemia", "name": "Fanconi anemia" }, { "url": "https://medlineplus.gov/genetics/condition/prostate-cancer", "name": "Prostate cancer" }, { "url": "https://medlineplus.gov/genetics/condition/ovarian-cancer", "name": "Ovarian cancer" }, { "url": "https://medlineplus.gov/genetics/condition/cholangiocarcinoma", "name": "Cholangiocarcinoma" } ] } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:medlineplus/lookup": { "get": { "operationId": "health_medlineplus_lookup", "summary": "Lookup", "description": "MedlinePlus Connect — consumer health pages for a clinical code, rung 1 (direct). Atom feed rendered as JSON: every scalar arrives wrapped in `._value`, and omitting", "tags": [ "MedlinePlus" ], "externalDocs": { "url": "https://zapi.ink/api/health/medlineplus#reference-lookup" }, "parameters": [ { "name": "codeSystem", "in": "query", "required": true, "description": "Clinical vocabulary the code belongs to", "schema": { "type": "string", "enum": [ "icd10cm", "icd9cm", "snomed", "rxcui", "ndc", "loinc", "cpt" ], "example": "icd10cm" } }, { "name": "code", "in": "query", "required": true, "description": "Code to look up inside the chosen vocabulary", "schema": { "type": "string", "example": "E11.9" } }, { "name": "language", "in": "query", "required": false, "description": "Language of the returned pages. Default en", "schema": { "type": "string", "enum": [ "en", "es" ], "example": "en" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "code": "E11.9", "count": 3, "items": [ { "id": "tag: medlineplus.gov, 2026-30-08:/diabetestype2.html?utm_source=mplusconnect&utm_medium=application", "url": "https://medlineplus.gov/diabetestype2.html?utm_source=mplusconnect&utm_medium=service", "links": [ { "rel": "alternate", "url": "https://medlineplus.gov/diabetestype2.html?utm_source=mplusconnect&utm_medium=service" } ], "title": "Diabetes Type 2", "summary": "

What is type 2 diabetes?

\n

Type 2 diabetes is a disease in which your blood glucose, or blood sugar, levels are too high. Glucose is your main source of energy. It comes from the foods you eat. A hormone called insulin helps the glucose get into your cells to give them energy. If you have diabetes, your body doesn't make enough insulin or doesn't use insulin well. The glucose then stays in your blood and not enough goes into your cells.

\n\n

Over time, having too much glucose in your blood can cause health problems. But you can take steps to manage your diabetes and try to prevent these health problems.

\n\n

What causes type 2 diabetes?

\n

Type 2 diabetes may be caused by a combination of factors:

\n\n

Type 2 diabetes usually starts with insulin resistance. This is a condition in which your cells don't respond normally to insulin. As a result, your body needs more insulin to help the glucose enter your cells. At first, your body makes more insulin to try to get cells to respond. But over time, your body can't make enough insulin, and your blood glucose levels rise.

\n\n

Who is at risk for type 2 diabetes?

\n

You are at higher risk of developing type 2 diabetes if you:

\n\n

What are the symptoms of type 2 diabetes?

\n

Many people with type 2 diabetes have no symptoms at all. If you do have them, the symptoms develop slowly over several years. They might be so mild that you do not notice them. The symptoms can include:

\n\n

How is type 2 diabetes diagnosed?

\n

Your provider will use blood tests to diagnose type 2 diabetes. The blood tests include:

\n\n

What are the treatments for type 2 diabetes?

\n

Treatment for type 2 diabetes involves managing your blood glucose levels. Many people are able to do this by living a healthy lifestyle. Some people may also need to take medicine:

\n\n\n

Can type 2 diabetes be prevented?

\n

You can take steps to help prevent or delay type 2 diabetes by losing weight if you are overweight, eating fewer calories, and being more physically active. If you have a condition which raises your risk for type 2 diabetes, managing that condition may lower your risk of getting type 2 diabetes.

\n\n

NIH: National Institute of Diabetes and Digestive and Kidney Diseases

", "updatedAt": "2026-08-30T00:46:12Z", "summaryType": "html" }, { "id": "tag: medlineplus.gov, 2026-30-08:/genetics/condition/type-2-diabetes?utm_source=mplusconnect&utm_medium=application", "url": "https://medlineplus.gov/genetics/condition/type-2-diabetes?utm_source=mplusconnect&utm_medium=service", "links": [ { "rel": "alternate", "url": "https://medlineplus.gov/genetics/condition/type-2-diabetes?utm_source=mplusconnect&utm_medium=service" } ], "title": "Type 2 diabetes", "summary": "

Type 2 diabetes is a disorder characterized by abnormally high levels of blood glucose, also called blood sugar. In this form of diabetes, the body stops using and making insulin properly. Insulin is a hormone produced in the pancreas that helps regulate blood glucose levels. Specifically, insulin controls how much glucose (a type of sugar) is passed from the blood into cells, where it is used as an energy source. When blood glucose levels are high (such as after a meal), the pancreas releases insulin to move the excess glucose into cells, which reduces the amount of glucose in the blood.

Most people who develop type 2 diabetes first have insulin resistance, a condition in which the body's cells use insulin less efficiently than normal. As insulin resistance develops, more and more insulin is needed to keep blood glucose levels in the normal range. To keep up with the increasing need, insulin-producing cells in the pancreas (called beta cells) make larger amounts of insulin. Over time, the beta cells become less able to respond to blood glucose changes, leading to an insulin shortage that prevents the body from reducing blood glucose levels effectively. Most people have some insulin resistance as they age, but inadequate exercise and excessive weight gain make it worse, greatly increasing the likelihood of developing type 2 diabetes.

Type 2 diabetes can occur at any age, but it most commonly begins in middle age or later. Signs and symptoms develop slowly over years. They include frequent urination (polyuria), excessive thirst (polydipsia), fatigue, blurred vision, tingling or loss of feeling in the hands and feet (diabetic neuropathy), sores that do not heal well, and weight loss. If blood glucose levels are not controlled through medication or diet, type 2 diabetes can cause long-lasting (chronic) health problems including heart disease and stroke; nerve damage; and damage to the kidneys, eyes, and other parts of the body.

", "updatedAt": "2026-08-30T00:46:12Z", "summaryType": "html" }, { "id": "tag: www.niddk.nih.gov, 2026-30-08:/health-information/diabetes/overview/what-is-diabetes/type-2-diabetes?utm_medium=ehr+service&utm_source=medlineplus+connect", "url": "https://www.niddk.nih.gov/health-information/diabetes/overview/what-is-diabetes/type-2-diabetes?utm_medium=ehr+service&utm_source=medlineplus+connect", "links": [ { "rel": "alternate", "url": "https://www.niddk.nih.gov/health-information/diabetes/overview/what-is-diabetes/type-2-diabetes?utm_medium=ehr+service&utm_source=medlineplus+connect" } ], "title": "Type 2 Diabetes", "summary": "Learn about the symptoms of type 2 diabetes, what causes the disease, how it’s diagnosed, and steps you can take to help prevent or delay type 2 diabetes.", "updatedAt": "2026-08-30T00:46:12Z", "summaryType": "html" } ], "title": "MedlinePlus Connect", "author": { "url": "https://www.nlm.nih.gov", "name": "U.S. National Library of Medicine" }, "matched": { "code": "E11.9", "system": "ICD10CM" }, "language": "en", "provider": "medlineplus", "subtitle": "MedlinePlus Connect results for ICD-10-CM E11.9", "updatedAt": "2026-08-30T00:46:12Z", "codeSystem": "icd10cm" } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:medlineplus/search-topics": { "get": { "operationId": "health_medlineplus_search_topics", "summary": "Search Topics", "description": "MedlinePlus health-topic search (NLM wsearch) — rung 1 (direct). The response is XML whose content is HTML-entity-escaped, and what decodes out of it still carries highlight wrappers; an unknown db answers 200 with an", "tags": [ "MedlinePlus" ], "externalDocs": { "url": "https://zapi.ink/api/health/medlineplus#reference-search-topics" }, "parameters": [ { "name": "term", "in": "query", "required": true, "description": "Search terms matched against MedlinePlus health topics", "schema": { "type": "string", "example": "asthma" } }, { "name": "language", "in": "query", "required": false, "description": "Topic collection to search. Default en", "schema": { "type": "string", "enum": [ "en", "es" ], "example": "en" } }, { "name": "page", "in": "query", "required": false, "description": "Page number. Default 1", "schema": { "type": "number", "example": "1" } }, { "name": "limit", "in": "query", "required": false, "description": "Items per page. Default 10, max 100", "schema": { "type": "number", "example": "10" } }, { "name": "detail", "in": "query", "required": false, "description": "Amount of content per topic. Default brief", "schema": { "type": "string", "enum": [ "brief", "topic", "all" ], "example": "brief" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "page": 1, "term": "asthma", "count": 3, "items": [ { "url": "https://medlineplus.gov/asthma.html", "rank": 1, "title": "Asthma", "groups": [ "Lungs and Breathing", "Immune System" ], "snippet": "What is asthma? Asthma is a chronic (long-term) lung disease. It affects your airways, the tubes that carry air in and out of your lungs. When you have ...", "summary": "What is asthma? Asthma is a chronic (long-term) lung disease. It affects your airways, the tubes that carry air in and out of your lungs. When you have asthma, your airways can become inflamed and narrowed. This can cause wheezing, coughing, and tightness in your chest. When these symptoms get worse than usual, it is called an asthma attack or flare-up. What causes asthma? The exact cause of asthma is unknown. Genetics and your environment likely play a role in who gets asthma. An asthma attack can happen when you are exposed to an asthma trigger. An asthma trigger is something that can set off or worsen your asthma symptoms. Different triggers can cause different types of asthma: Allergic asthma is caused by allergens. Allergens are substances that cause an allergic reaction. They can include Dust mites Mold Pets Pollen from grass, trees, and weeds Waste from pests such as cockroaches and mice Nonallergic asthma is caused by triggers that are not allergens, such as Breathing in cold air Certain medicines Household chemicals Infections such as colds and the flu Outdoor air pollution Tobacco smoke Occupational asthma is caused by breathing in chemicals or industrial dusts at work Exercise-induced asthma happens during physical exercise, especially when the air is dry Asthma triggers may be different for each person and can change over time. Who is at risk for asthma? Asthma affects people of all ages, but it often starts during childhood. Certain factors can raise your risk of having asthma: Being exposed to secondhand smoke when your mother is pregnant with you or when you are a small child Being exposed to certain substances at work, such as chemical irritants or industrial dusts Genetics and family history. You are more likely to have asthma if one of your parents has it, especially if it's your mother. Race or ethnicity. Black and African Americans and Puerto Ricans are at higher risk of asthma than people of other races or ethnicities. Having other diseases or conditions such as obesity and allergies Often having viral respiratory infections as a young child Sex. In children, asthma is more common in boys. In teens and adults, it is more common in women. What are the symptoms of asthma? The symptoms of asthma include: Chest tightness Coughing, especially at night or early morning Shortness of breath Wheezing, which causes a whistling sound when you breathe out These symptoms can range from mild to severe. You may have them every day or only once in a while. When you are having an asthma attack, your symptoms get much worse. The attacks may come on gradually or suddenly. Sometimes they can be life-threatening. They are more common in people who have severe asthma. If you are having asthma attacks, you may need a change in your treatment. How is asthma diagnosed? Your health care provider may use many tools to diagnose asthma: Physical exam Medical history Lung function tests, including spirometry, to test how well your lungs work Tests to measure how your airways react to specific exposures. During this test, you inhale different concentrations of allergens or medicines that may tighten the muscles in your airways. Spirometry is done before and after the test. Peak expiratory flow (PEF) tests to measure how fast you can blow air out using maximum effort Fractional exhaled nitric oxide (FeNO) tests to measure levels of nitric oxide in your breath when you breathe out. High levels of nitric oxide may mean that your lungs are inflamed. Allergy skin or blood tests, if you have a history of allergies. These tests check which allergens cause a reaction from your immune system. What are the treatments for asthma? If you have asthma, you will work with your health care provider to create a treatment plan. The plan will include ways to manage your asthma symptoms and prevent asthma attacks. It will include: Strategies to avoid triggers. For example, if tobacco smoke is a trigger for you, you should not smoke or allow other people to smoke in your home or car. Short-term relief medicines, also called quick-relief medicines. They help prevent symptoms or relieve symptoms during an asthma attack. They include an inhaler to carry with you all the time. It may also include other types of medicines which work quickly to help open your airways. Control medicines. You take them every day to help prevent symptoms. They work by reducing airway inflammation and preventing narrowing of the airways. If you have a severe attack and the short-term relief medicines do not work, you will need emergency care. Your provider may adjust your treatment until asthma symptoms are controlled. Sometimes asthma is severe and cannot be controlled with other treatments. If you are an adult with uncontrolled asthma, in some cases your provider might suggest bronchial thermoplasty. This is a procedure that uses heat to shrink the smooth muscle in the lungs. Shrinking the muscle reduces your airway's ability to tighten and allows you to breathe more easily. The procedure has some risks, so it's important to discuss them with your provider.", "altTitles": [ "Bronchial Asthma" ], "meshTerms": [ "Asthma" ], "organizationName": "National Library of Medicine" }, { "url": "https://medlineplus.gov/asthmainchildren.html", "rank": 0, "title": "Asthma in Children", "groups": [ "Children and Teenagers", "Lungs and Breathing", "Immune System" ], "snippet": "What is asthma? Asthma is a chronic (long-term) lung disease. It affects your airways, the tubes that carry air in and out of your lungs. When you have ...", "summary": "What is asthma? Asthma is a chronic (long-term) lung disease. It affects your airways, the tubes that carry air in and out of your lungs. When you have asthma, your airways can become inflamed and narrowed. This can cause wheezing, coughing, and tightness in your chest. When these symptoms get worse than usual, it is called an asthma attack or flare-up. How does asthma affect children? Asthma often starts during childhood, usually before age 5. Many children have asthma - it is the most common chronic disease of childhood. It can cause children to miss school and end up in the hospital. But treatments can help manage asthma. What causes asthma in children? The exact cause of asthma is unknown. Genetics and environment likely play a role in which children get asthma. An asthma attack can happen when your child is exposed to an asthma trigger. An asthma trigger is something that can set off or worsen asthma symptoms. Different triggers can cause different types of asthma: Allergic asthma is caused by allergens. Allergens are substances that cause an allergic reaction. They can include Dust mites Mold Pets Pollen from grass, trees, and weeds Waste from pests such as cockroaches and mice Nonallergic asthma is caused by triggers that are not allergens, such as Breathing in cold air Certain medicines Household chemicals Infections such as colds and the flu Outdoor air pollution Tobacco smoke Exercise-induced asthma happens during physical exercise, especially when the air is dry Asthma triggers may be different for each child and can change over time. Which children are at risk for asthma? Certain factors raise the risk of asthma in children: Being exposed to secondhand smoke when their mother is pregnant with them or when they are small children Genetics and family history. Children are more likely to have asthma if one of their parents has it, especially if it's the mother. Race or ethnicity. Black and African Americans and Puerto Ricans are at higher risk of asthma than people of other races or ethnicities. Having other diseases or conditions such as obesity and allergies Often having viral respiratory infections as young children Sex. In children, asthma is more common in boys. In teens, it is more common in girls. What are the symptoms of asthma in children? The symptoms of asthma in children include: Chest tightness Coughing, especially at night or early morning Breathing problems, such as shortness of breath, rapid breathing, or gasping for air Feeling tired Dark circles under the eyes Being irritable Wheezing, which causes a whistling sound when they breathe out Trouble eating or sucking (in infants) These symptoms can range from mild to severe. They may happen often or only once in a while. When children have an asthma attack, their symptoms get much worse. The attacks may come on gradually or suddenly. Sometimes they can be life-threatening. Warning signs of a severe attack include severe coughing, serious breathing problems, and turning very pale or blue in the face, lips and/or fingernails. If your child has those symptoms, get medical help right away. How is asthma in children diagnosed? It can be hard to diagnose asthma in children, especially if they are young. Asthma has similar symptoms as other childhood conditions. And some children may not have asthma symptoms very often, so it may seem like they are having respiratory infections instead. Your child's health care provider may use many tools to diagnose asthma: Physical exam Medical history Chest x-ray Lung function tests, including spirometry, to test how well the lungs work. Younger children are usually not able to do these tests. Allergy skin or blood tests, if you have a history of allergies. These tests check which allergens cause a reaction from your immune system. If you have a young child who cannot do lung function tests, the provider may suggest doing a trial of asthma medicines. The trial involves giving your child the medicines for several weeks to see whether the symptoms get better. What are the treatments for asthma in children? If your child has asthma, you will work with their health care provider to create a treatment plan. The plan will include ways to manage your child's asthma symptoms and prevent asthma attacks, such as: Strategies to avoid triggers. For example, if tobacco smoke is a trigger for your child, you should not allow anyone to smoke in your home or car. Short-term relief medicines, also called quick-relief medicines. They help prevent symptoms or relieve symptoms during an asthma attack. They include an inhaler to have for your child at all times. It may also include other types of medicines which work quickly to help open your child's airways. Control medicines. They work by reducing airway inflammation and preventing narrowing of the airways. Not all children will take control medicines. Whether or not your child needs them depends on how severe the asthma is and how often your child has symptoms. If your child has a severe attack and the short-term relief medicines do not work, get medical help right away. Your child's provider may adjust the treatment until the asthma symptoms are controlled.", "altTitles": [ "Childhood Asthma", "Pediatric asthma" ], "meshTerms": [ "Asthma" ], "organizationName": "National Library of Medicine" }, { "url": "https://medlineplus.gov/allergy.html", "rank": 2, "title": "Allergy", "groups": [ "Ear, Nose and Throat", "Immune System" ], "snippet": "An allergy is a reaction by your immune system to something that does not bother most other people. People who have allergies often are sensitive to more ...", "summary": "An allergy is a reaction by your immune system to something that does not bother most other people. People who have allergies often are sensitive to more than one thing. Substances that often cause reactions are: Pollen Dust mites Mold spores Pet dander Food Insect stings Medicines Normally, your immune system fights germs. It is your body's defense system. In most allergic reactions, however, it is responding to a false alarm. Genes and the environment probably both play a role. Allergies can cause a variety of symptoms such as a runny nose, sneezing, itching, rashes, swelling, or asthma. Allergies can range from minor to severe. Anaphylaxis is a severe reaction that can be life-threatening. Doctors use skin and blood tests to diagnose allergies. Treatments include medicines, allergy shots, and avoiding the substances that cause the reactions.", "altTitles": [ "Allergic Rhinitis", "Hypersensitivity" ], "meshTerms": [ "Hypersensitivity" ], "organizationName": "National Library of Medicine" } ], "limit": 3, "total": 55, "hasMore": true, "language": "en", "nextPage": 2, "provider": "medlineplus" } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:who/countries": { "get": { "operationId": "health_who_countries", "summary": "Countries", "description": "WHO Global Health Observatory — the COUNTRY dimension pre-bound, rung 1 (direct). These ISO3 codes are what indicator-data's `country` filter matches on, and each row", "tags": [ "WHO GHO" ], "externalDocs": { "url": "https://zapi.ink/api/health/who#reference-countries" }, "parameters": [ { "name": "region", "in": "query", "required": false, "description": "WHO region code to restrict the countries to", "schema": { "type": "string", "example": "SEAR" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "count": 10, "items": [ { "code": "BGD", "name": "Bangladesh", "regionCode": "SEAR", "regionName": "South-East Asia" }, { "code": "BTN", "name": "Bhutan", "regionCode": "SEAR", "regionName": "South-East Asia" }, { "code": "IND", "name": "India", "regionCode": "SEAR", "regionName": "South-East Asia" }, { "code": "LKA", "name": "Sri Lanka", "regionCode": "SEAR", "regionName": "South-East Asia" }, { "code": "MDV", "name": "Maldives", "regionCode": "SEAR", "regionName": "South-East Asia" }, { "code": "MMR", "name": "Myanmar", "regionCode": "SEAR", "regionName": "South-East Asia" }, { "code": "NPL", "name": "Nepal", "regionCode": "SEAR", "regionName": "South-East Asia" }, { "code": "PRK", "name": "Democratic People's Republic of Korea", "regionCode": "SEAR", "regionName": "South-East Asia" } ], "region": "SEAR", "provider": "who" } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:who/dimension-values/{dimension}": { "get": { "operationId": "health_who_dimension_values", "summary": "Dimension Values", "description": "WHO Global Health Observatory — valid values for one dimension, rung 1 (direct). An unknown dimension answers 200 with an empty `value[]` rather than a 404, so the empty", "tags": [ "WHO GHO" ], "externalDocs": { "url": "https://zapi.ink/api/health/who#reference-dimension-values" }, "parameters": [ { "name": "dimension", "in": "path", "required": true, "description": "Dimension code from the dimensions endpoint", "schema": { "type": "string", "example": "COUNTRY" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "count": 234, "items": [ { "code": "ABW", "title": "Aruba", "dimension": "COUNTRY", "parentCode": "AMR", "parentTitle": "Americas", "parentDimension": "REGION" }, { "code": "AFG", "title": "Afghanistan", "dimension": "COUNTRY", "parentCode": "EMR", "parentTitle": "Eastern Mediterranean", "parentDimension": "REGION" }, { "code": "AGO", "title": "Angola", "dimension": "COUNTRY", "parentCode": "AFR", "parentTitle": "Africa", "parentDimension": "REGION" }, { "code": "AIA", "title": "Anguilla", "dimension": "COUNTRY", "parentCode": "AMR", "parentTitle": "Americas", "parentDimension": "REGION" }, { "code": "ALB", "title": "Albania", "dimension": "COUNTRY", "parentCode": "EUR", "parentTitle": "Europe", "parentDimension": "REGION" }, { "code": "AND", "title": "Andorra", "dimension": "COUNTRY", "parentCode": "EUR", "parentTitle": "Europe", "parentDimension": "REGION" }, { "code": "ARE", "title": "United Arab Emirates", "dimension": "COUNTRY", "parentCode": "EMR", "parentTitle": "Eastern Mediterranean", "parentDimension": "REGION" }, { "code": "ARG", "title": "Argentina", "dimension": "COUNTRY", "parentCode": "AMR", "parentTitle": "Americas", "parentDimension": "REGION" } ], "provider": "who", "dimension": "COUNTRY" } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:who/dimensions": { "get": { "operationId": "health_who_dimensions", "summary": "Dimensions", "description": "WHO Global Health Observatory — the dimension catalogue, rung 1 (direct). The vocabulary behind every filterable field on indicator-data; the collection has no", "tags": [ "WHO GHO" ], "externalDocs": { "url": "https://zapi.ink/api/health/who#reference-dimensions" }, "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "count": 202, "items": [ { "code": "ADVERTISINGTYPE", "title": "SUBSTANCE_ABUSE_ADVERTISING_TYPES" }, { "code": "AGEGROUP", "title": "Age Group" }, { "code": "ALCOHOLTYPE", "title": "Beverage Types" }, { "code": "AMRGLASSCATEGORY", "title": "AMR GLASS Category" }, { "code": "ANTIBIOTIC", "title": "Antibiotic" }, { "code": "ARCHIVE", "title": "Archive date" }, { "code": "ASSISTIVETECHBARRIER", "title": "Barriers to accessing assistive products" }, { "code": "ASSISTIVETECHFUNDING", "title": "Funding for assistive tech products" } ], "provider": "who" } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:who/indicator-data/{indicator}": { "get": { "operationId": "health_who_indicator_data", "summary": "Indicator Data", "description": "WHO Global Health Observatory — observations for one indicator, rung 1 (direct). Every indicator code is its own OData collection, so the code goes in the path and an unknown", "tags": [ "WHO GHO" ], "externalDocs": { "url": "https://zapi.ink/api/health/who#reference-indicator-data" }, "parameters": [ { "name": "indicator", "in": "path", "required": true, "description": "Indicator code from the indicators endpoint", "schema": { "type": "string", "example": "WHOSIS_000001" } }, { "name": "country", "in": "query", "required": false, "description": "ISO3 country code to restrict the rows to", "schema": { "type": "string", "example": "IDN" } }, { "name": "region", "in": "query", "required": false, "description": "WHO region code of the parent location", "schema": { "type": "string", "example": "SEAR" } }, { "name": "spatialDimType", "in": "query", "required": false, "description": "Level the rows are reported at", "schema": { "type": "string", "enum": [ "COUNTRY", "REGION", "WORLDBANKINCOMEGROUP" ], "example": "COUNTRY" } }, { "name": "year", "in": "query", "required": false, "description": "Single reporting year", "schema": { "type": "number", "example": "2019" } }, { "name": "yearFrom", "in": "query", "required": false, "description": "Earliest reporting year", "schema": { "type": "number", "example": "2010" } }, { "name": "yearTo", "in": "query", "required": false, "description": "Latest reporting year", "schema": { "type": "number", "example": "2020" } }, { "name": "dim1", "in": "query", "required": false, "description": "First disaggregation code, commonly sex", "schema": { "type": "string", "example": "SEX_BTSX" } }, { "name": "dim2", "in": "query", "required": false, "description": "Second disaggregation code", "schema": { "type": "string", "example": "AGEGROUP_YEARS15-19" } }, { "name": "dim3", "in": "query", "required": false, "description": "Third disaggregation code", "schema": { "type": "string", "example": "RESIDENCEAREATYPE_RUR" } }, { "name": "orderBy", "in": "query", "required": false, "description": "Sort field. Default year", "schema": { "type": "string", "enum": [ "year", "value", "country", "id" ], "example": "year" } }, { "name": "order", "in": "query", "required": false, "description": "Sort direction. Default desc", "schema": { "type": "string", "enum": [ "asc", "desc" ], "example": "desc" } }, { "name": "page", "in": "query", "required": false, "description": "Page number. Default 1", "schema": { "type": "number", "example": "1" } }, { "name": "limit", "in": "query", "required": false, "description": "Items per page. Default 20, max 200", "schema": { "type": "number", "example": "20" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "page": 1, "count": 0, "items": [], "limit": 3, "total": 0, "hasMore": false, "nextPage": null, "provider": "who", "indicator": "WHOSIS_000001" } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:who/indicators": { "get": { "operationId": "health_who_indicators", "summary": "Indicators", "description": "WHO Global Health Observatory — the indicator catalogue (3,095 rows), rung 1 (direct). OData v4 over an Azure CDN edge, no key. $filter is built here from named parameters only:", "tags": [ "WHO GHO" ], "externalDocs": { "url": "https://zapi.ink/api/health/who#reference-indicators" }, "parameters": [ { "name": "search", "in": "query", "required": false, "description": "Substring matched against the indicator name", "schema": { "type": "string", "example": "malaria" } }, { "name": "code", "in": "query", "required": false, "description": "Exact indicator code", "schema": { "type": "string", "example": "WHOSIS_000001" } }, { "name": "page", "in": "query", "required": false, "description": "Page number. Default 1", "schema": { "type": "number", "example": "1" } }, { "name": "limit", "in": "query", "required": false, "description": "Items per page. Default 20, max 200", "schema": { "type": "number", "example": "20" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "code": "WHOSIS_000001", "page": 1, "count": 0, "items": [], "limit": 3, "total": 0, "search": "malaria", "hasMore": false, "nextPage": null, "provider": "who" } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } }, "/v1/health:who/regions": { "get": { "operationId": "health_who_regions", "summary": "Regions", "description": "WHO Global Health Observatory — the REGION dimension pre-bound, rung 1 (direct). Region rows are top-level, so ParentCode/ParentTitle arrive null here rather than absent.", "tags": [ "WHO GHO" ], "externalDocs": { "url": "https://zapi.ink/api/health/who#reference-regions" }, "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" }, "example": { "status": "success", "message": "Success", "content": { "count": 43, "items": [ { "code": "AFR", "name": "Africa", "dimension": "REGION", "parentCode": null, "parentName": null }, { "code": "AMR", "name": "Americas", "dimension": "REGION", "parentCode": null, "parentName": null }, { "code": "EMR", "name": "Eastern Mediterranean", "dimension": "REGION", "parentCode": null, "parentName": null }, { "code": "EUR", "name": "Europe", "dimension": "REGION", "parentCode": null, "parentName": null }, { "code": "GBD_REG14_AFRD", "name": "Africa region, stratum D (AFR D)", "dimension": "REGION", "parentCode": null, "parentName": null }, { "code": "GBD_REG14_AFRE", "name": "Africa region, stratum E(AFR E)", "dimension": "REGION", "parentCode": null, "parentName": null }, { "code": "GBD_REG14_AMRA", "name": "Americas region, stratum A (AMR A)", "dimension": "REGION", "parentCode": null, "parentName": null }, { "code": "GBD_REG14_AMRB", "name": "Americas region, stratum B (AMR B)", "dimension": "REGION", "parentCode": null, "parentName": null } ], "provider": "who" } } } } }, "4XX": { "$ref": "#/components/responses/Error" }, "default": { "$ref": "#/components/responses/Error" } } } } } }