Medpass Blog

Jeśli jestem właścicielem strony internetowej związanej z tematyką medyczną możesz bezpłatnie wykorzystać system Medpass. System pozwala na rejestrację oraz logowanie użytkowników do części lub całości portalu w zależności od profilu Medpass (lekarz, farmaceuta, student medycyny itd). Weryfikacja lekarzy odbywa się za pomocą analizy numeru prawa wykonania zawodu na podstawie algorytmu dostarczonego przez Naczelną Izbę Lekarską. System Medpass można zainstalować na każdej platformie w związku z standardem OpenID.

W celu zapoznania się ze szczegółami procesu instalacji oraz standardem OpenID zapraszamy na stronę: medpass.pl/article/medPassPublishing.

Poniższy zestaw funkcji Medpass API umożliwia bezpieczną wymianę informacji między zewnętrznymi aplikacjami lub stronami a systemem Medpass.

Profil

exportProfile

exportProfile(api_key, openid_url) : ExportedProfile Object

Metoda zwraca dane na temat profile uzyrkownika w postaci obiektu typu:

ExportedProfile{
:user_id, :integer //id usera w medpassie
:firstname, :string // imie
:lastname, :string //nazwisko
:email, :string // email
:phone, :string // telefon
:mobile_phone, :string // komórka
:speciality, :string // specjalizacja
:birthday, :date // data urodzin
:nameday, :date // data imienin
:city, :string // miasto
:province, :string // wojewodztwo
:gender, :integer // plec
:gadu, :string // nr gg
:skype, :string // login skype
}

Argumenty:

1.api_key : String → unika unikalny ciąg znaków służący do weryfikacji
2.openid_url : String → openid_url danego użytkownika medpass (login)

user_specialties

user_specialties(api_key, login): String

Metoda zwracająca specjalizaje danego usera odzielone przecinkami w postaci ciagu znaków

1.api_key :String → unikalny ciąg znaków służący do weryfikacji wywołującego metodę.
2.login :String -> login usera medpassu , dla którego będziemy wyszukiwać specjalizacji

search_user

search_user(api_key, phrase, page=nil, per_page=nil) MedpassUser Array[:Object]

Metoda zwracająca tablicę User-ów którzy odpowiadali podanej frazie wyszukiwania

Argumenty:

1.api_key :String → unikalny ciąg znaków służący do weryfikacji wywołującego metodę.
2.phrase :String -> zmienna identyfikująca po jakim ciągu znaków będziemy wyszukiwać user-ów
3.page :String -> zmienna informująca numer strony w paginacji
4.per_page :String -> zmienna przechowująca liczbę z wilkością tablicy jaka zostanie zwrócona

Pobieranie nazwy użytkownika

getDesiredName

getDesiredName(api_key, openid_url) : String

Zwraca nazwe użytkownika zgodnie z ustawieniami profilu użytkownika (login, imie nazwisko ,etc )

Argumenty:

1. api_key : String → unikalny ciąg znaków służący do weryfikacji wywołującego
2. openid_url : String → openid_url danego użytkownika medpass (login)

Wiadomości medpass

WebMessage

WebMessage {
:id,         :integer //id
:sender,     :string  // nadawca (login)
:recipient,  :string // odbiorca (login)
:subject,    :string // temat
:created_at, :date // data utworzenia
:read,       :integer // czy przeczytane 1- tak 0- nie
:answered,   :integer // czy odpowiedziane 1 tak 0 nie
:deleted,    :integer // czy skasowane 1 tak 0 nie
:type_id,    :integer // id typu wiadomości
:body,       :text // treść
:short,      :integer // ??
}

messageList

messageList(api_key, openid_url, start, count, app) : WebMessage Array[Objects]

Metoda zwraca tablicę wiadomości przychodzących danego użytkownika

Argumenty:

1. api_key : String → unikalny ciąg znaków służący do weryfikacji wywołującego
2. openid_url : String → openid_url danego użytkownika medpass (login)
3. start : Integer → index wiadomości od której zacząc pobieranie (przydatne do stronicowania)
4. count : Integer → ilość wiadomości do pobrania zaczynając od indenu start (przydatne do stronicowania – ilość wiadomości na strone)
5. app : String → nazwa portalu, z którego pobrać wiadomości, np. Science, Medpass, etc

Uwaga: argumenty start i count mogą pozostac puste – wtedy ściągane są wszystkie wiadomości
Argument app pozostawiony pusty powoduje ściągnięcie wiadomości medpass ze wszystkich portali.

sentMessageList

sentMessageList(api_key, openid_url, start, count) : WebMessage Array[Objects]

Zwraca tablice wiadomosci wysłanych przez użytkonika (reszta działania analogiczna do messageList)

Argumenty:

1. api_key : String → unikalny ciąg znaków służący do weryfikacji wywołującego
2. openid_url : String → openid_url danego użytkownika medpass (login)
3. start : Integer → index wiadomości od której zacząc pobieranie (przydatne do stronicowania)
4. count : Integer → ilość wiadomości do pobrania zaczynając od indenu start (przydatne do stronicowania – ilość wiadomości na strone)

messageGet

messageGet(api_key, message_id) :WebMessage Object

Zwraca pojedyncza wiadomość o podanym id

Argumenty:

1. api_key : String → unikalny ciąg znaków służący do weryfikacji
2. message_id : Integer → id wiadomości

messageDelete

messageDelete(api_key, message_id) : Boolean

Usuwa dana wiadomość (zwraca true gdy sukces, w przeciwnym razie false)

Argumenty:

1. api_key : String → unikalny ciąg znaków służący do weryfikacji
2. message_id : Integer → id wiadomości

messageSentDelete

messageSentDelete(api_key, message_id) :Boolean

Ustawia wiadomość jako wysłaną i skasowaną

Argumenty

1. api_key : String → unikalny ciąg znaków służący do weryfikacji
2. message_id : Integer → id wiadomości

messageSend

messageSend(api_key, from, to, subject, body, app) : Boolean

Wysyła wiadomość do użytkownika (zwraca true jesli sukces , w przeciwnym razie false)

Argumenty
1. api_key : String → unikalny ciąg znaków służący do weryfikacji
2. from : String → login nadawcy
3. to : String → login odbiorcy
4. subject : String → temat wiadomości
5. body : String →treść wiadomości
6. app : String →nazwa portalu np Science

messageReply

messageReply(api_key, :from, :to, :subject, :body, app) : Boolean

Analogiczne do messsageSend

messageCount

messageCount(api_key, openid_url, type_id) : integer

Zwraca liczbe wiadomosci podanego typu. Jesli nie podano typu zwraca liczbe wszystkich wiadomosci.

Argumenty:

1. api_key : String → unika unikalny ciąg znaków służący do weryfikacji
2. openid_url : String → openid_url danego użytkownika medpass (login)
3. type_id : Integer → id typu wiadomości

messageCountUnread

messageCountUnread(api_key, imei, type_id) : Integer

Zwraca liczbe nieprzeczytanych wiadomości (analogicznei do messageCount)

Argumenty:

1. api_key : String → unika unikalny ciąg znaków służący do weryfikacji
2. openid_url : String → openid_url danego użytkownika medpass (login)
3. type_id : Integer → id typu wiadomości

contacts_list

contacts_list( api_key, openid_url ): Array[:String]

Metoda zwracająca tablicę kontaktów danego użytwkonika w postaci ich loginów.

1.api_key :String → unikalny ciąg znaków służący do weryfikacji wywołującego metodę.
2.openid_url :String -> open id usera medpassu lub jego login

contacts_add

contacts_add( api_key, openid_url, target_openid_url ): Boolean

Metoda dodająca nowego uzytwkonika do listy kontaktów danego uzytkownika.

1.api_key :String → unikalny ciąg znaków służący do weryfikacji wywołującego metodę.
2.openid_url :String -> open id usera medpassu lub jego login
3.target_openid_url :String -> open id usera medpassu lub jego login, którego chcemy dodać do kontaktu

user_exists

user_exists( api_key, openid_url ) : Boolean

Metoda sprawdzająca czy dany użytkownik istnieje w medpasie.

1.api_key :String → unikalny ciąg znaków służący do weryfikacji wywołującego metodę.
2.openid_url :String -> open id usera medpassu lub jego login

Miejsca pracy

getUserCompanies

getUserCompanies(api_key, openid_url) : UserCompanySoap Array[Objects]

Metoda zwraca tablicę obiektów typu

UserCompanySoap {
medpass_id : Integer
place_id, : Integer
name : String
position : String
}

Gdzie:

medpass_id – id rekordu w baize medpass oznaczającego wpis w tabeli user_companies dla danego zakładu pracy i usera (tabela łącząca)
place_id – id miejscowości w jakiej znajduje sie zakład pracy (tabela places)
name – nazwa zakładu pracy
position – nazwa zajmowanego stanowiska

Argumenty:

1. api_key : String → unikalny ciąg znaków służący do weryfikacji wywołującego metodę.
2. openid_url : String → openid_url danego użytkownika medpass (login)

field_get

field_get( api_key, user, field ): String

Metoda zwracająca wartość atrybutu danego użytkownika

1.api_key :String → unikalny ciąg znaków służący do weryfikacji wywołującego metodę.
2.user :String -> open id usera medpassu lub jego login
3.field :String -> zmienna identyfikująca pobieraną wartość danego atrybutu użytkownika.

user_is_doctor

user_is_doctor( api_key, user ): Boolean

Metoda sprawdzająca czy dany użytkownik jest doktorem. Zwraca true jeżel jest w przeciwnym razie false

1.api_key :String → unikalny ciąg znaków służący do weryfikacji wywołującego metodę.
2.user :String -> open id usera medpassu lub jego login

userGetGroup

userGetGroup( api_key, user ): Integer

Metoda zwracająca id grupy do której należy dany użytkownik .

1.api_key :String -> unikalny ciąg znaków służący do weryfikacji wywołującego metodę.
2.user :String -> open id usera medpassu lub jego login