Teknisk grensesnittdokumentasjon
Transcription
Teknisk grensesnittdokumentasjon
Grensesnittdokumentasjon for FEST - Webservice FEST for internett og Norsk Helsenett (NHN) 17.06.2015 Antall sider: 8 Ref.: Grensesnittdokumentasjon FEST Side 2 av 7 Innhold 1 Innledning Formål 3 3 Omfang 3 2 FEST sin rolle i eResept 3 3 FEST (WCF) 4 Nedlasting av FEST 4 GetM30 5 Parametre 5 m30Response 5 FEST (asmx) 6 Kode-eksempel på konsumering av tjeneste 6 m30Response 6 5 Kommunikasjon 7 6 Sikkerhet 7 7 Melding av feil 7 4 Ref.: Grensesnittdokumentasjon FEST Side 3 av 7 1 Innledning Formål Hensikten med dokumentet er å gjøre aktuelle aktører i stand til å utvikle grensesnitt og kommunisere med Legemiddelverket i henhold til gjeldende spesifikasjoner. Omfang Dette dokumentet dekker grensesnittet til webservice for FEST på internett og på Norsk Helsenett (NHN) 2 FEST sin rolle i eResept Kort om FEST sin rolle i eResept M30 er FEST-meldingen (overføring av informasjon fra Legemiddelverkets FEST-grunnlag) Apotek Forskriver - allmenn Farmapro Journalsyste m Forskriver - sykehus Kurvesystem/ FEST Ardis Bandasjist journalsystem mineresepter.no interaksjoner.no mobile løsninger, apper Pasient Ref.: Grensesnittdokumentasjon FEST Helfo Side 4 av 7 3 FEST (WCF) FEST er implementert som en standard, synkron web service som følger «Envelope Request-Response Message Exchange Pattern». Tjenesten er selvbeskrivende i den forstand at man for eksempel kan åpne internett adressen i en nettleser og se hvilke operasjoner som er tilgjengelige samt formatet på «request» og «response». Tjenesten har en metode GetM30 med to parametre og svarer med en m30Response. Vær obs på at tjenesten bruker WS-adressering. Følgende må være med i headeren på SOAP-requesten: <soap:Header xmlns:wsa="http://www.w3.org/2005/08/addressing"> <wsa:Action>http://www.slv.no/20131008/FestService250/GetM30</wsa:Action> <wsa:To>https://fest.legemiddelverket.no/Fest/FestService250.svc</wsa:To> </soap:Header> Versjonering av tjenesten ligger i navnet på tjenesten: ”FestService240” vil si versjon 0 av M30 versjon 2.4. For M30 versjon 2.5 vil det komme en ny tjeneste ”FestService250” og etterfølgende eventuelt ”FestService251” ved endringer i M30 XSD skjemaet. Nedlasting av FEST Fest er tilgjengelig som en web-service som følger protokollen SOAP. (Både SOAP 1.1 og SOAP 1.2 støttes). Miljø Versjon Domene (DNS) Web-service Filtre NHN produksjon 2.4 frontend-fest.nhn.no Fest/FestService240.svc NHN produksjon 2.5.0 frontend-fest.nhn.no Fest/FestService250.svc NHN – produksjon Internett produksjon 2.5.1 frontend-fest.nhn.no Fest/FestService251.svc Farmalogg, Rekvirent inkl. inkrementelt, Bandasjist, Veterinær, NAV Farmalogg, Rekvirent inkl. inkrementelt, Bandasjist, Veterinær, NAV Institusjon 2.4 fest.legemiddelverket.no Fest/FestService240.svc Internett produksjon 2.5.0 fest.legemiddelverket.no Fest/FestService250.svc Internett – produksjon NHN – staging* 2.5.1 fest.legemiddelverket.no Fest/FestService251.svc 2.4 frontend-fest.nhn.no FestStaging/FestService240.svc NHN – staging* 2.5.0 frontend-fest.nhn.no FestStaging/FestService250.svc NHN - test 2.4 frontend-fest-test.nhn.no TestFest/FestService240.svc Ref.: Grensesnittdokumentasjon FEST Farmalogg, Rekvirent inkl. inkrementelt, Bandasjist, Veterinær, NAV Farmalogg, Rekvirent inkl. inkrementelt, Bandasjist, Veterinær, NAV Institusjon Rekvirent inkl. inkrementelt, Veterinær, NAV Rekvirent inkl. inkrementelt, Veterinær, NAV Farmalogg, Rekvirent Side 5 av 7 Miljø Versjon Domene (DNS) Web-service NHN - test 2.5.0 frontend-fest-test.nhn.no TestFest/FestService250.svc NHN – test Internett test 2.5.1 2.4 frontend-fest-test.nhn.no festtest.legemiddelverket.no TestFest/FestService251.svc TestFest/FestService240.svc Internett test 2.5.0 festtest.legemiddelverket.no TestFest/FestService250.svc Internett – test 2.5.1 festtest.legemiddelverket.no TestFest/FestService251.svc Filtre inkl. inkrementelt, Bandasjist, Veterinær, NAV Farmalogg, Rekvirent inkl. inkrementelt, Bandasjist, Veterinær, NAV Institusjon Farmalogg, Rekvirent inkl. inkrementelt, Bandasjist, Veterinær, NAV Farmalogg, Rekvirent inkl. inkrementelt, Bandasjist, Veterinær, NAV Institusjon *Staging betyr at den eksponerer data før den offisielle versjon blir publisert. GetM30 Parametre Element Beskrivelse Filter En enum med den «varianten» av FEST-meldingen man ønsker: Farmalogg, Rekvirent, Bandasjist, Veterinær, NAV, Institusjon SistOppdatert Brukes for å få et inkrementelt uttrekk av data. Kan kun brukes sammen med filteret Rekvirent. Angir at man ønsker en inkrementell FEST-melding som inneholder en serie med endringer. Hvis den mottatte FEST-meldingens ”HentetDato” <> SistOppdatert så må man gjenta kallet, nå med ”HentetDato” som parameter for å få neste serie med inkrementelle endringer. Slik må kallet gjentas inntil ”HentetDato” = SistOppdatert. Vær obs på at navnet «HentetDato» på det første elementet i FEST-meldingen er noe misvisende. Det denne datoen sier noe om er hvor gamle data meldingen er basert på, ikke når den ble lastet ned. m30Response <xs:complexType name="m30Response"> <xs:sequence> <xs:element name="M30Message" type="SLV.Fest.Data.M30.V250.FEST"/> <xs:element name="Returkode" type="kith:CS"/> </xs:sequence> </xs:complexType> Element Beskrivelse M30Message Returkode FEST-meldingen. Hvorvidt M30-anmodningen var vellykket, se tabellen under. Selv om V=1 så kan M30Message være tom. Mulige returkoder: V (verdi) DN (beskrivelse) Ref.: Grensesnittdokumentasjon FEST Side 6 av 7 V (verdi) 1 8 4 DN (beskrivelse) OK Uventet feil FEST (asmx) Vil bli støttet frem til 1. juli 2014. Hos driftsleverandøren Ikomm (på Norsk helsenett): Miljø Nett IP Domene (DNS) Web-service FEST v2 FEST v2 test NHN NHN 91.186.93.37 91.186.93.38 frontend-fest.nhn.no frontend-fest-test.nhn.no Festv20Service/FestWS.asmx FESTv20ServiceTest/FestWS.asm x Kode-eksempel på konsumering av tjeneste FestService.FestService240Client service = new FestService.FestService240Client(); FestService.M30Response response = service.GetM30(FestService.FilterEnum.Rekvirent, null); string returkode = response.Returkode.dnField; FestService.FEST m30 = response.M30Message; <xs:complexType name="m30Request"> <xs:sequence> <xs:element name="SistOppdatert" type="xs:dateTime" minOccurs="0"/> <xs:element name="Filter" type="kith:CS"/> <xs:element name="M30Versjon" type="xs:string"/> </xs:sequence> Element Beskrivelse M30Versjon Den versjonen av M30-skjemaet man ønsker at FEST-meldingen skal følge. Følgende versjoner støttes i produksjon: Versjon 2.4: http://www.kith.no/xmlstds/eresept/m30/2011-01-01 Den «varianten» av FEST-meldingen man ønsker. Per september 2009 har V-attributtet tre mulige verdier: RekvirentNAV, BNU og VRS (men VRS er kun tilgjengelig for VRS). DN-attributtet har ingen betydning. Kan kun brukes sammen med filteret RekvirentNAV. Angir at man ønsker en inkrementell FEST-melding som inneholder alle endringer siden en FEST-melding med den angitte datoen som HentetDato. Filter SistOppdatert Vær obs på at navnet «HentetDato» på det første elementet i FEST-meldingen er noe misvisende. Det denne datoen sier noe om er hvor gamle data meldingen er basert på, ikke når den ble lastet ned. m30Response <xs:complexType name="m30Response"> <xs:sequence> <xs:element name="M30Message" type="xs:string"/> <xs:element name="M30Versjon" type="xs:string"/> <xs:element name="Returkode" type="kith:CS"/> </xs:sequence> </xs:complexType> Ref.: Grensesnittdokumentasjon FEST Side 7 av 7 Element Beskrivelse M30Message M30Versjon Returkode FEST-meldingen. Skjemaet som denne FEST-meldingen følger. Hvorvidt M30-anmodningen var vellykket, se tabellen under. Mulige returkoder: V (verdi) 1 2 3 4 5 6 7 8 DN (beskrivelse) OK Et gyldig filter må angis som innparameter Et gyldig namespace må angis som versjonsnummer. GetAvailableVersions returnerer de versjoner som er støttet av tjenesten Ugyldig filter spesifisert Ugyldig innkommende dato Kan ikke opprette kontakt med FEST-databasen Angitt M30 versjon tilbys ikke av tjenesten Uventet feil Det benyttes ikke AppRec i forbindelse med FEST. 5 Kommunikasjon Legemiddelverket støtter kun UTF-8. Signerte dokumenter må være «base 64»-kodet. 6 Sikkerhet Webservice som WCF er sikret med https. Forbindelsen til FEST (asmx) er ukryptert http. 7 Melding av feil Feil meldes til [email protected]. Ref.: Grensesnittdokumentasjon FEST