MedlinePlus Connect: Layanan Web
Isi
- Ikhtisar Layanan Web
- Parameter Keluaran
- Permintaan Kode Diagnosis (Masalah)
- Parameter Opsional
- Deskripsi Elemen Atom Terpilih (atau objek JSON) dalam Menanggapi Permintaan Kode Masalah
- Contoh Permintaan Kode Masalah
- Layanan dan File Terkait
- Permintaan Informasi Obat
- Parameter Opsional
- Deskripsi Elemen Atom Terpilih (atau objek JSON) dalam Menanggapi Permintaan Obat
- Contoh Permintaan Kode Obat
- Permintaan Informasi Uji Lab
- Parameter Opsional
- Deskripsi Elemen Atom Terpilih (atau objek JSON) sebagai Tanggapan atas Permintaan Uji Lab
- Contoh Permintaan Tes Lab
- Kebijakan Penggunaan yang Dapat Diterima
- Informasi Lebih Lanjut
MedlinePlus Connect tersedia sebagai aplikasi Web atau layanan Web. Di bawah ini adalah detail teknis untuk menerapkan layanan Web, yang menanggapi permintaan berdasarkan:
Anda dipersilakan untuk menautkan dan menampilkan data yang dikembalikan oleh MedlinePlus Connect. Anda tidak boleh menyalin halaman MedlinePlus ke situs Anda. Jika Anda menggunakan data dari Layanan Web MedlinePlus Connect, harap tunjukkan bahwa informasi tersebut berasal dari MedlinePlus.gov tetapi jangan menggunakan logo MedlinePlus atau menyiratkan bahwa MedlinePlus mendukung produk khusus Anda. Silakan lihat halaman API NLM untuk panduan lebih lanjut. Untuk informasi lebih lanjut tentang cara menautkan ke konten MedlinePlus di luar layanan ini, silakan lihat pedoman dan instruksi kami tentang menautkan.
Jika Anda memutuskan untuk menggunakan MedlinePlus Connect, daftar ke daftar email untuk mengikuti perkembangan dan bertukar ide dengan kolega Anda. Harap beri tahu kami jika Anda menerapkan MedlinePlus Connect dengan menghubungi kami.
Ikhtisar Layanan Web
Parameter untuk permintaan layanan Web sesuai dengan HL7 Context-Aware Knowledge Retrieval (Infobutton) Panduan Implementasi Berbasis URL Permintaan Pengetahuan. Respons berbasis REST sesuai dengan HL7 Context-Aware Knowledge Retrieval (Infobutton) Panduan Implementasi Arsitektur Berorientasi Layanan. Output dari permintaan dapat berupa XML dalam format feed Atom, JSON, atau JSONP.
Struktur permintaan menunjukkan jenis kode yang Anda kirim. Dalam semua kasus, URL dasar untuk layanan Web adalah: https://connect.medlineplus.gov/service
MedlinePlus Connect menggunakan koneksi HTTPS. Permintaan HTTP tidak akan diterima dan implementasi yang ada menggunakan HTTP harus diperbarui ke HTTPS.
Parameter Keluaran
Parameter ini opsional. Jika Anda mengabaikannya, respons default adalah informasi bahasa Inggris dalam format XML.
Bahasa
Identifikasi apakah Anda ingin jawaban dalam bahasa Inggris atau Spanyol. MedlinePlus Connect akan menganggap bahasa Inggris adalah bahasa jika tidak ditentukan.
Jika Anda ingin jawaban untuk pencarian kode masalah dalam bahasa Spanyol, gunakan : informationRecipient.languageCode.c=es
(=sp juga diterima)
Untuk menentukan bahasa Inggris, gunakan yang berikut ini: informationRecipient.languageCode.c=en
Format
Identifikasi apakah Anda ingin format respons menjadi XML, JSON, atau JSONP. XML adalah defaultnya.
- Untuk meminta JSON, gunakan:
- knowledgeResponseType=aplikasi/json
- Untuk JSONP, gunakan:
- knowledgeResponseType=application/javascript&callback=CallbackFunction di mana CallbackFunction adalah nama yang Anda berikan fungsi panggilan balik.
- Untuk respons dalam XML, gunakan:
- knowledgeResponseType=text/xml atau biarkan parameter knowledgeResponseType keluar dari permintaan.
Permintaan Kode Diagnosis (Masalah)
Untuk kode masalah, MedlinePlus Connect akan mengembalikan tautan dan informasi dari halaman topik kesehatan MedlinePlus, halaman genetika, atau halaman dari NIH Institutes lainnya.
MedlinePlus Connect akan mengembalikan yang berikut:
Mungkin tidak selalu ada kecocokan untuk setiap kode. Dalam kasus tersebut, MedlinePlus Connect akan mengembalikan respons nol.
URL dasar layanan ini adalah: https://connect.medlineplus.gov/service
Ada dua parameter yang diperlukan untuk setiap kueri ke layanan ini:
- Sistem Kode
Identifikasi sistem kode masalah yang akan Anda gunakan.- Untuk penggunaan ICD-10-CM:
- mainSearchCriteria.v.cs=2.16.840.1.113883.6.90
- Untuk penggunaan ICD-9-CM:
- mainSearchCriteria.v.cs=2.16.840.1.113883.6.103
- Untuk penggunaan CT SNOMED:
- mainSearchCriteria.v.cs=2.16.840.1.113883.6.96
- Kode
Identifikasi kode aktual yang Anda coba cari:
mainSearchCriteria.v.c=250.33
Parameter Opsional
Judul Kode
Anda juga dapat mengidentifikasi nama/judul kode masalah. Namun, informasi ini tidak memengaruhi respons (tidak seperti aplikasi Web MedlinePlus Connect di mana informasi nama/judul dapat digunakan). mainSearchCriteria.v.dn=Diabetes mellitus dengan koma tipe 1 lainnya tidak terkontrol Lihat bagian di atas pada Parameter Output untuk detail tentang bahasa dan format output.
Deskripsi Elemen Atom Terpilih (atau objek JSON) dalam Menanggapi Permintaan Kode Masalah
Elemen | simpul kelas | Deskripsi |
---|---|---|
judul | Judul halaman topik kesehatan MedlinePlus yang cocok atau halaman GHR | |
tautan | URL untuk halaman topik kesehatan MedlinePlus yang cocok atau halaman GHR | |
ringkasan | Rangkuman lengkap untuk topik kesehatan. Ini termasuk tautan yang disematkan ke topik kesehatan lain yang relevan, dan semua pemformatan, termasuk poin dan spasi paragraf. Ringkasan dalam HTML. Untuk halaman GHR, bagian pertama dari halaman penuh disediakan. | |
ringkasan | Sinonim untuk topik. Ini disebut sebagai "Juga disebut" pada halaman topik kesehatan. Tidak semua topik memiliki istilah "Juga disebut". | |
ringkasan | Pengakuan atribusi untuk teks ringkasan, jika sebagian besar ringkasan berasal dari agen federal lain. Tidak semua ringkasan memiliki atribusi. Teks tanpa atribut adalah asli dari MedlinePlus. | |
ringkasan | Tautan yang dipilih terkait dengan topik. Ini termasuk nama halaman, URL, dan organisasi terkait (bila berlaku). Tautan diformat dalam daftar berpoin. Tidak semua topik memiliki tautan ini. Jumlah tautan dapat berkisar dari nol hingga puluhan. |
Contoh Permintaan Kode Masalah
Permintaan lengkap untuk Diabetes Mellitus dengan koma tipe 1 lain yang tidak terkontrol, kode ICD-9 250.33, untuk pasien berbahasa Spanyol akan memiliki alamat URL berikut: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16 .840.1.113883.6.103&mainSearchCriteria.vc=250.33&mainSearchCriteria.v.dn=Diabetes%20mellitus%20with%20other%20coma%20type%201%20uncontrolled&informationRecipient.languageCode.c=es
Seorang pasien dengan diagnosis yang sama tetapi format yang diminta adalah JSON dan bahasanya adalah bahasa Inggris: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.103&mainSearchCriteria.vc=250.33&knowledgeResponseType=application /json
Seorang pasien yang didiagnosis dengan "Pneumonia karena Pseudomonas" menggunakan kode SNOMED CT 41381004: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.96&mainSearchCriteria.vc=41381004&mainSearchCriteria.v.dn= Pneumonia%20due%20to%20Pseudomonas%20%28disorder%29&informationRecipient.languageCode.c=en
Seorang pasien dengan diagnosis yang sama tetapi format yang diminta adalah JSONP: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.96&mainSearchCriteria.v.c=41381004&knowledgeResponseType=application/javascript&callback=CallbackFunction
Layanan dan File Terkait
Untuk menerima topik kesehatan MedlinePlus sebagai tanggapan atas permintaan teks, sebagai lawan dari kode masalah, selidiki layanan Web MedlinePlus. Juga, jika Anda memerlukan set lengkap topik kesehatan MedlinePlus dalam format XML, lihat halaman file XML kami.
Permintaan Informasi Obat
MedlinePlus Connect memberikan kecocokan informasi obat terbaik saat menerima RXCUI. Ini juga memberikan hasil yang baik saat menerima kode NDC. MedlinePlus Connect dapat memberikan tanggapan dalam bahasa Inggris atau Spanyol.
Untuk permintaan informasi pengobatan bahasa Inggris, jika Anda tidak mengirim NDC atau RXCUI atau jika kami tidak menemukan kecocokan berdasarkan kode, aplikasi akan menggunakan string teks yang Anda kirim untuk menampilkan kecocokan informasi obat terbaik. Untuk permintaan informasi pengobatan Spanyol, MedlinePlus Connect hanya merespons NDC atau RXCUI dan tidak menggunakan string teks. Dimungkinkan untuk memiliki tanggapan dalam bahasa Inggris tetapi tidak ada tanggapan dalam bahasa Spanyol.
Layanan MedlinePlus Connect Web akan mengembalikan yang berikut ini:
Mungkin ada beberapa tanggapan untuk satu permintaan obat. Mungkin tidak selalu ada kecocokan untuk setiap permintaan. Dalam kasus tersebut, MedlinePlus Connect akan mengembalikan respons nol.
Untuk permintaan informasi obat, URL dasarnya adalah: https://connect.medlineplus.gov/service
Untuk mengirim permintaan, sertakan informasi berikut:
- Sistem Kode
Identifikasi jenis kode obat yang Anda kirimkan. (Diperlukan untuk bahasa Inggris dan Spanyol)- Untuk penggunaan RXCUI:
- mainSearchCriteria.v.cs=2.16.840.1.113883.6.88
- Untuk penggunaan NDC:
- mainSearchCriteria.v.cs=2.16.840.1.113883.6.69
- Kode
Identifikasi kode aktual yang Anda coba cari. (Diutamakan untuk Bahasa Inggris, Diperlukan untuk Bahasa Spanyol)
mainSearchCriteria.v.c=637188 - Nama Obat
Identifikasi nama obat dengan string teks. (Opsional untuk bahasa Inggris, Tidak digunakan untuk bahasa Spanyol)
mainSearchCriteria.v.dn=Chantix 0.5 MG Oral Tablet
Parameter Opsional
Judul KodeSaat mengirim permintaan informasi bahasa Inggris, Anda dapat menyertakan parameter opsional dari nama obat. Ini dirinci dalam bagian di atas. mainSearchCriteria.v.dn=Chantix 0.5 MG Oral Tablet
Lihat bagian di atas pada Parameter Output untuk detail tentang bahasa dan format output.
Deskripsi Elemen Atom Terpilih (atau objek JSON) dalam Menanggapi Permintaan Obat
Elemen | Deskripsi |
---|---|
judul | Judul untuk halaman obat MedlinePlus yang cocok |
tautan | URL untuk halaman obat MedlinePlus yang cocok |
penulis | Atribusi sumber untuk informasi obat |
Contoh Permintaan Kode Obat
Permintaan informasi obat Anda akan terlihat seperti salah satu dari berikut ini.
Untuk meminta informasi oleh RXCUI, permintaan Anda akan terlihat seperti ini: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.88&mainSearchCriteria.vc=637188&mainSearchCriteria.v.dn=Chantix% 200.5%20MG%20Oral%20Tablet&informationRecipient.languageCode.c=en
Untuk meminta informasi oleh NDC untuk penutur bahasa Spanyol, permintaan Anda akan terlihat seperti ini: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.69&mainSearchCriteria.vc=00310-0751- 39&informationRecipient.languageCode.c=es
Untuk mengirim string teks tanpa kode obat, Anda harus mengidentifikasi kueri Anda sebagai permintaan tipe NDC sehingga MedlinePlus Connect mengetahui bahwa Anda sedang mencari informasi obat. Ini hanya akan berfungsi untuk permintaan bahasa Inggris. Permintaan Anda dapat terlihat seperti ini: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.69&mainSearchCriteria.v.dn=Chantix%200.5%20MG%20Oral%20Tablet&informationRecipient.languageCode.c =en
Permintaan Informasi Uji Lab
MedlinePlus Connect menyediakan informasi uji laboratorium yang cocok saat menerima permintaan LOINC. Layanan ini dapat memberikan tanggapan dalam bahasa Inggris atau Spanyol.
Layanan MedlinePlus Connect Web akan mengembalikan yang berikut ini:
Mungkin tidak selalu ada kecocokan untuk setiap kode. Dalam kasus tersebut, MedlinePlus Connect akan mengembalikan respons nol.
URL dasar layanan ini adalah: https://connect.medlineplus.gov/service
Ini adalah dua parameter yang diperlukan untuk setiap kueri uji lab untuk layanan ini:
- Sistem Kode
- Identifikasi bahwa Anda menggunakan sistem kode LOINC. Menggunakan:
- mainSearchCriteria.v.cs=2.16.840.1.113883.6.1
- MedlinePlus Connect juga akan menerima:
- mainSearchCriteria.v.cs=2.16.840.1.113883.11.79
- Kode
mengidentifikasi kode aktual yang Anda coba cari:
mainSearchCriteria.v.c=3187-2
Parameter Opsional
Judul KodeAnda juga dapat mengidentifikasi nama tes lab. Namun, informasi ini tidak memengaruhi respons. mainSearchCriteria.v.dn=Pengujian Faktor IX
Lihat bagian di atas pada Parameter Output untuk detail tentang bahasa dan format output.
Deskripsi Elemen Atom Terpilih (atau objek JSON) sebagai Tanggapan atas Permintaan Uji Lab
Elemen | Deskripsi |
---|---|
judul | Judul halaman uji lab MedlinePlus yang cocok |
tautan | URL untuk halaman uji lab MedlinePlus yang cocok |
ringkasan | Cuplikan dari konten halaman |
penulis | Atribusi sumber untuk konten uji lab |
Contoh Permintaan Tes Lab
Untuk meminta informasi bagi penutur bahasa Inggris, permintaan Anda mungkin terlihat seperti berikut ini: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.1&mainSearchCriteria.vc=3187-2&mainSearchCriteria. v.dn=Factor%20IX%20assay&informationRecipient.languageCode.c=en https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.1&mainSearchCriteria.vc=3187-2&informationRecipient.languageCode.c =en
Untuk meminta informasi bagi penutur bahasa Spanyol, permintaan Anda mungkin terlihat seperti berikut: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.1&mainSearchCriteria.vc=3187-2&mainSearchCriteria. v.dn=Factor%20IX%20assay&informationRecipient.languageCode.c=es https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.1&mainSearchCriteria.vc=3187-2&informationRecipient.languageCode.c =es
Kebijakan Penggunaan yang Dapat Diterima
Untuk menghindari kelebihan server MedlinePlus, NLM mengharuskan pengguna MedlinePlus Connect mengirim tidak lebih dari 100 permintaan per menit per alamat IP. Permintaan yang melebihi batas ini tidak akan dilayani, dan layanan tidak akan dipulihkan selama 300 detik atau hingga tingkat permintaan turun di bawah batas, mana saja yang lebih lambat. Untuk membatasi jumlah permintaan yang Anda kirim ke Connect, NLM merekomendasikan hasil caching untuk jangka waktu 12-24 jam.
Kebijakan ini diterapkan untuk memastikan bahwa layanan tetap tersedia dan dapat diakses oleh semua pengguna. Jika Anda memiliki kasus penggunaan khusus yang mengharuskan Anda mengirim sejumlah besar permintaan ke MedlinePlus Connect, dan dengan demikian melebihi batas tingkat permintaan yang diuraikan dalam kebijakan ini, silakan hubungi kami. Staf NLM akan mengevaluasi permintaan Anda dan menentukan apakah pengecualian dapat diberikan. Harap tinjau juga dokumentasi file MedlinePlus XML. File XML ini berisi catatan topik kesehatan lengkap dan dapat berfungsi sebagai metode alternatif untuk mengakses data MedlinePlus.