MedlinePlus Connect: usługa internetowa
Zawartość
- Przegląd usług internetowych
- Parametry wyjściowe
- Żądania kodów diagnostycznych (problemów)
- Parametry opcjonalne
- Opis wybranych elementów Atom (lub obiektów JSON) w odpowiedzi na żądania kodu problemu
- Przykłady próśb o kody problemów
- Powiązane usługi i pliki
- Prośby o informacje o narkotykach
- Parametry opcjonalne
- Opis wybranych elementów atomowych (lub obiektów JSON) w odpowiedzi na wnioski o leki
- Przykłady próśb o kody leków
- Prośby o informacje o testach laboratoryjnych
- Parametry opcjonalne
- Opis wybranych elementów Atom (lub obiektów JSON) w odpowiedzi na żądania testów laboratoryjnych
- Przykłady wniosków o testy laboratoryjne
- Przyjęte zasady użytkowania
- Więcej informacji
MedlinePlus Connect jest dostępny jako aplikacja internetowa lub usługa sieciowa. Poniżej znajdują się szczegóły techniczne dotyczące wdrożenia usługi internetowej, która odpowiada na zapytania na podstawie:
Zapraszamy do łączenia się i wyświetlania danych zwróconych przez MedlinePlus Connect. Nie możesz kopiować stron MedlinePlus na swoją witrynę. W przypadku korzystania z danych z usługi internetowej MedlinePlus Connect należy wskazać, że informacje pochodzą z witryny MedlinePlus.gov, ale nie należy używać logo MedlinePlus ani w inny sposób sugerować, że MedlinePlus promuje dany produkt. Dalsze wskazówki można znaleźć na stronie interfejsu API NLM. Aby uzyskać więcej informacji na temat łączenia się z treścią MedlinePlus poza tą usługą, zapoznaj się z naszymi wytycznymi i instrukcjami dotyczącymi łączenia.
Jeśli zdecydujesz się korzystać z MedlinePlus Connect, zarejestruj się na listę e-mailową, aby być na bieżąco i wymieniać się pomysłami z kolegami. Poinformuj nas, czy wdrażasz MedlinePlus Connect, kontaktując się z nami.
Przegląd usług internetowych
Parametry dla żądań usług sieci Web są zgodne z Przewodnikiem implementacji opartym na adresie URL żądania wiedzy HL7 HL7 Context-Aware Knowledge Retrieval (Infobutton) Knowledge Request. Odpowiedź oparta na REST jest zgodna z Przewodnikiem implementacji architektury zorientowanej na usługi HL7 HL7 Context-Aware Knowledge Retrieval (Infobutton). Dane wyjściowe żądania może być w formacie XML w formacie kanału informacyjnego Atom, JSON lub JSONP.
Struktura żądania wskazuje, jakiego rodzaju kod wysyłasz. We wszystkich przypadkach podstawowy adres URL usługi internetowej to: https://connect.medlineplus.gov/service
MedlinePlus Connect korzysta z połączeń HTTPS. Żądania HTTP nie będą akceptowane, a istniejące implementacje korzystające z protokołu HTTP powinny zostać zaktualizowane do protokołu HTTPS.
Parametry wyjściowe
Te parametry są opcjonalne. Jeśli je pominiesz, domyślną odpowiedzią będą informacje w języku angielskim w formacie XML.
Język
Określ, czy chcesz, aby odpowiedź była w języku angielskim czy hiszpańskim. MedlinePlus Connect zakłada, że język angielski jest językiem, jeśli nie został określony.
Jeśli chcesz, aby odpowiedź na wyszukiwanie kodu problemu była w języku hiszpańskim, użyj: informationRecipient.languageCode.c=es
(=sp również akceptowane)
Aby określić język angielski, użyj następującego: informationRecipient.languageCode.c=en
Format
Określ, czy chcesz, aby format odpowiedzi był XML, JSON czy JSONP. Domyślny jest XML.
- Aby zażądać JSON, użyj:
- KnowledgeResponseType=aplikacja/json
- W przypadku JSONP użyj:
- KnowledgeResponseType=application/javascript&callback=CallbackFunction gdzie CallbackFunction to nazwa nadawana funkcji zwrotnej.
- Aby uzyskać odpowiedź w formacie XML, użyj:
- KnowledgeResponseType=text/xml lub pozostaw parametr knowledgeResponseType poza żądaniem.
Żądania kodów diagnostycznych (problemów)
W przypadku kodu problemu, MedlinePlus Connect zwróci linki i informacje ze stron tematycznych MedlinePlus, genetyki lub stron z innych instytutów NIH.
MedlinePlus Connect zwróci następujące informacje:
Nie zawsze może istnieć odpowiednik dla każdego kodu. W takich przypadkach MedlinePlus Connect zwróci odpowiedź pustą.
Podstawowy adres URL usługi to: https://connect.medlineplus.gov/service
Dla każdego zapytania do tej usługi wymagane są dwa parametry:
- System kodów
Zidentyfikuj system kodów problemów, którego będziesz używać.- Dla ICD-10-CM użyj:
- mainSearchCriteria.v.cs=2.16.840.1.113883.6.90
- Do użytku z ICD-9-CM:
- główne KryteriaWyszukiwania.v.cs=2.16.840.1.113883.6.103
- Dla SNOMED CT użyj:
- mainSearchCriteria.v.cs=2.16.840.1.113883.6.96
- Kod
Zidentyfikuj rzeczywisty kod, który próbujesz wyszukać:
główne KryteriaWyszukiwania.v.c=250,33
Parametry opcjonalne
Tytuł kodu
Możesz również zidentyfikować nazwę/tytuł kodu problemu. Informacje te nie mają jednak wpływu na odpowiedź (w przeciwieństwie do aplikacji internetowej MedlinePlus Connect, w której można użyć informacji o nazwisku/tytule). mainSearchCriteria.v.dn=Cukrzyca z innym niekontrolowanym typem śpiączki 1 Zobacz powyższą sekcję dotyczącą parametrów wyjściowych, aby uzyskać szczegółowe informacje na temat języka i formatów wyjściowych.
Opis wybranych elementów Atom (lub obiektów JSON) w odpowiedzi na żądania kodu problemu
Element | Węzeł klasy | Opis |
---|---|---|
tytuł | Tytuł dopasowanej strony tematycznej MedlinePlus lub strony GHR | |
połączyć | Adres URL dopasowanej strony z tematem zdrowia MedlinePlus lub strony GHR | |
streszczenie | Pełne podsumowanie tematu zdrowia. Obejmuje to osadzone łącza do innych istotnych tematów dotyczących zdrowia oraz całe formatowanie, w tym punktory i odstępy między akapitami. Podsumowanie jest w formacie HTML. W przypadku stron GHR dostępna jest pierwsza sekcja całej strony. | |
streszczenie | Synonimy tematu. Są one określane jako „nazywane również” na stronie tematycznej dotyczącej zdrowia. Nie wszystkie tematy zawierają terminy „również nazywane”. | |
streszczenie | Potwierdzenie uznania autorstwa dla tekstu streszczenia, jeśli większość streszczenia pochodzi z innej agencji federalnej. Nie wszystkie podsumowania mają atrybucję. Tekst nieprzypisany jest oryginalny dla MedlinePlus. | |
streszczenie | Wybrane linki powiązane z tematem. Obejmuje to nazwę strony, adres URL i powiązaną organizację (jeśli dotyczy). Łącza są sformatowane w formie listy punktowanej. Nie wszystkie tematy zawierają te linki. Liczba linków może wynosić od zera do kilkudziesięciu. |
Przykłady próśb o kody problemów
Kompletna prośba o Diabetes Mellitus z inną niekontrolowaną śpiączką typu 1, kod ICD-9 250.33, dla pacjenta hiszpańskojęzycznego będzie miała następujący adres URL: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16 .840.1.113883.6.103&mainSearchCriteria.vc=250.33&mainSearchCriteria.v.dn=Cukrzyca%20mellitus%20with%20other%20coma%20type%201%20niekontrolowane&informacjeRecipient.languageCode.c=es
Pacjent z tą samą diagnozą, ale wymaganym formatem jest JSON, a językiem jest angielski: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.103&mainSearchCriteria.vc=250.33&knowledgeResponseType=application /json
Pacjent ze zdiagnozowanym „zapaleniem płuc wywołanym przez Pseudomonas” przy użyciu kodu SNOMED CT 41381004: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.96&mainSearchCriteria.vc=41381004&mainSearchCriteria.v.dn= Zapalenie płuc%20należy%20to%20Pseudomonas%20%28zaburzenie%29&informacjeOdbiorca.languageCode.c=en
Pacjent z tą samą diagnozą, ale żądanym formatem to 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
Powiązane usługi i pliki
Aby otrzymywać tematy dotyczące zdrowia MedlinePlus w odpowiedzi na prośby tekstowe, a nie kody problemów, zapoznaj się z usługą MedlinePlus Web. Ponadto, jeśli potrzebujesz pełnego zestawu tematów medycznych MedlinePlus w formacie XML, zobacz naszą stronę z plikami XML.
Prośby o informacje o narkotykach
MedlinePlus Connect zapewnia najlepsze dopasowanie informacji o leku podczas odbierania RXCUI. Zapewnia również dobre wyniki podczas odbierania kodu NDC. MedlinePlus Connect może udzielać odpowiedzi w języku angielskim lub hiszpańskim.
W przypadku próśb o informacje o lekach w języku angielskim, jeśli nie wyślesz NDC lub RXCUI lub jeśli nie znajdziemy dopasowania na podstawie kodu, aplikacja użyje wysłanego ciągu tekstowego, aby wyświetlić najlepsze dopasowanie informacji o leku. W przypadku próśb o hiszpańskie informacje o lekach, MedlinePlus Connect odpowiada tylko na NDC lub RXCUI i nie używa ciągów tekstowych. Możliwe jest otrzymanie odpowiedzi w języku angielskim, ale brak odpowiedzi w języku hiszpańskim.
Usługa internetowa MedlinePlus Connect zwróci następujące informacje:
Na jedno żądanie leku może być wiele odpowiedzi. Nie zawsze może być dopasowanie do każdego żądania. W takich przypadkach MedlinePlus Connect zwróci odpowiedź pustą.
W przypadku próśb o informacje o narkotykach, podstawowy adres URL to: https://connect.medlineplus.gov/service
Aby wysłać zapytanie, dołącz następujące informacje:
- System kodów
Określ rodzaj wysyłanego kodu leku. (Wymagane dla języka angielskiego i hiszpańskiego)- Do użytku RXCUI:
- mainSearchCriteria.v.cs=2.16.840.1.113883.6.88
- Do użytku NDC:
- mainSearchCriteria.v.cs=2.16.840.1.113883.6.69
- Kod
Zidentyfikuj rzeczywisty kod, który próbujesz wyszukać. (Preferowany w języku angielskim, wymagany w przypadku hiszpańskiego)
główne KryteriaWyszukiwania.v.c=637188 - Nazwa leku
Zidentyfikuj nazwę leku za pomocą ciągu tekstowego. (Opcjonalne dla języka angielskiego, nie używane dla hiszpańskiego)
mainSearchCriteria.v.dn=Chantix 0,5 MG tabletka doustna
Parametry opcjonalne
Tytuł koduWysyłając prośbę o informacje w języku angielskim, możesz dołączyć opcjonalny parametr nazwy leku. Jest to szczegółowo opisane w powyższej sekcji. mainSearchCriteria.v.dn=Chantix 0,5 MG tabletka doustna
Zobacz powyższą sekcję Parametry wyjściowe, aby uzyskać szczegółowe informacje na temat języka i formatów wyjściowych.
Opis wybranych elementów atomowych (lub obiektów JSON) w odpowiedzi na wnioski o leki
Element | Opis |
---|---|
tytuł | Tytuł dopasowanej strony dotyczącej leków MedlinePlus |
połączyć | Adres URL strony z dopasowanymi lekami MedlinePlus |
autor | Atrybucja źródła informacji o lekach |
Przykłady próśb o kody leków
Twoja prośba o podanie informacji o lekach powinna wyglądać jak jedna z poniższych.
Aby zażądać informacji przez RXCUI, Twoje żądanie powinno wyglądać tak: 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
Aby poprosić NDC o informacje dla osoby mówiącej po hiszpańsku, Twoja prośba powinna wyglądać tak: https://connect.medlineplus.gov/service?mainSearchCriteria.v.cs=2.16.840.1.113883.6.69&mainSearchCriteria.vc=00310-0751- 39&informacjeRecipient.languageCode.c=es
Aby wysłać ciąg tekstowy bez kodu leku, należy zidentyfikować zapytanie jako żądanie typu NDC, aby MedlinePlus Connect wiedział, że szukasz informacji o lekach. Będzie to działać tylko w przypadku żądań w języku angielskim. Twoje żądanie może wyglądać tak: 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
Prośby o informacje o testach laboratoryjnych
MedlinePlus Connect zapewnia dopasowanie do informacji z badań laboratoryjnych po otrzymaniu żądania LOINC. Serwis może udzielić odpowiedzi w języku angielskim lub hiszpańskim.
Usługa internetowa MedlinePlus Connect zwróci następujące informacje:
Nie zawsze może istnieć odpowiednik dla każdego kodu. W takich przypadkach MedlinePlus Connect zwróci odpowiedź pustą.
Podstawowy adres URL usługi to: https://connect.medlineplus.gov/service
Oto dwa wymagane parametry dla każdego zapytania dotyczącego testu laboratoryjnego do tej usługi:
- System kodów
- Zidentyfikuj, że używasz systemu kodów LOINC. Posługiwać się:
- mainSearchCriteria.v.cs=2.16.840.1.113883.6.1
- MedlinePlus Connect akceptuje również:
- główne KryteriaWyszukiwania.v.cs=2.16.840.1.113883.11.79
- Kod
zidentyfikuj rzeczywisty kod, który próbujesz wyszukać:
główne KryteriaWyszukiwania.v.c=3187-2
Parametry opcjonalne
Tytuł koduMożesz również zidentyfikować nazwę testu laboratoryjnego. Jednak ta informacja nie ma wpływu na odpowiedź. mainSearchCriteria.v.dn=Test czynnika IX
Zobacz powyższą sekcję Parametry wyjściowe, aby uzyskać szczegółowe informacje na temat języka i formatów wyjściowych.
Opis wybranych elementów Atom (lub obiektów JSON) w odpowiedzi na żądania testów laboratoryjnych
Element | Opis |
---|---|
tytuł | Tytuł dopasowanej strony testowej laboratorium MedlinePlus |
połączyć | Adres URL dopasowanej strony testowej laboratorium MedlinePlus |
streszczenie | Fragment z treści strony |
autor | Atrybucja źródła treści testu laboratoryjnego |
Przykłady wniosków o testy laboratoryjne
Aby poprosić o informacje dla osoby mówiącej po angielsku, Twoja prośba może wyglądać następująco: 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
Aby poprosić o informacje dla osoby mówiącej po hiszpańsku, Twoja prośba może wyglądać następująco: 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
Przyjęte zasady użytkowania
Aby uniknąć przeciążenia serwerów MedlinePlus, NLM wymaga, aby użytkownicy MedlinePlus Connect wysyłali nie więcej niż 100 żądań na minutę na adres IP. Żądania przekraczające ten limit nie będą obsługiwane, a usługa nie zostanie przywrócona przez 300 sekund lub do czasu, gdy częstotliwość żądań spadnie poniżej limitu, w zależności od tego, co nastąpi później. Aby ograniczyć liczbę żądań wysyłanych do Connect, NLM zaleca buforowanie wyników przez okres 12-24 godzin.
Ta polityka ma na celu zapewnienie, że usługa pozostanie dostępna i dostępna dla wszystkich użytkowników. Jeśli masz konkretny przypadek użycia, który wymaga wysłania dużej liczby żądań do MedlinePlus Connect, a tym samym przekroczenia limitu liczby żądań określonego w niniejszych zasadach, skontaktuj się z nami. Personel NLM oceni Twoją prośbę i określi, czy można przyznać wyjątek. Prosimy również o zapoznanie się z dokumentacją plików XML MedlinePlus. Te pliki XML zawierają pełne rekordy tematów zdrowotnych i mogą służyć jako alternatywna metoda dostępu do danych MedlinePlus.