HSA FileService Användarhandledning. Version 1.2,

Transkript

1 HSA FileService Användarhandledning,

2 Innehåll 1. Inledning Anslutning till HSA FileService Filernas innehåll Tekniska grundförutsättningar Brandväggsöppning vid kommunikation över Sjunet Tillit till HSA-serverns SITHS-certifikat Klientautentisering Klientautentisering i Java Hämtning av filer URL Specifikation XML-filer publicunits.zip hsaunits.zip vpwpublicunits.zip vpwpublicpersons.zip psipublicunits.zip psipublicpersons.zip hsaunitsextended.zip systemspecificuser_[system_id].zip omvard.zip kommer att fasas ut publicunits_valbar kommer att fasas ut Referenser Appendix - Exempel på en xml-fil (publicunits.xml) Sid 2/28

3 Revisionshistorik Version, datum Författare Kommentar 1.0, Henrika Littorin Godkänd av tjänsteansvarig 1.1, Åsa Berggren Lagt till hsaunitsextended.zip och systemspecificuser_[system_id].zip Ändrat förutsättningarna teknisk specifikation , Henrika Littorin Språklig dokumentöversyn Sid 3/28

4 1. Inledning Via HSA FileService tillgängliggörs ett antal i förväg skapade filer med information från HSA. I detta dokument beskrivs förutsättningarna för att få ta del av dessa filer och vad de innehåller. 2. Anslutning till HSA FileService För att få hämta information från HSA krävs ett godkännande från informationsägarna, d.v.s. de organisationer som har information om sin verksamhet och sina medarbetare registrerad i HSA. I frågor om regelbunden hämtning av information som följer HSA-policyn [1] kan beslut fattas av sgrupp som representanter för samtliga informationsägare. Godkännande erhålls genom anslutningsprocessen för tjänster [2]. En anslutning kan ta allt mellan ett par månader och flera år beroende på komplexiteten i frågeställningen och de krav på funktionalitet och innehåll som finns. Den vanligaste användningen av FileService är hämtning av publik enhetsinformation, vilket är ett förenklat och standardiserat anslutningsförfarande. Notera att det också finns andra gränssnitt för anslutning av tjänster via tjänstekontrakt över Tjänsteplattformen, tjänstedomänerna infrastructure_directory_organisation, infrastructure:directory:employee och infrastructure:directory:authorizationmanagement. Befintliga anslutna tjänster kan också göra anrop direkt mot HSA via HSA WebService. Vilket gränssnitt som bäst fyller tjänstens behov avgörs tillsammans med under anslutningsprocessen [2]. För tjänster/organisationer som är intresserade av anslutning till HSA hänvisas till information och anmälan av intresse på /hsa under Anslutning och Anslutning av tjänst. 3. Filernas innehåll Filerna innehåller information från objekt i HSA-katalogen. Vilken typ av objekt (t.ex. enheter eller personer) och vilka av dessa objekts attribut som finns i den fil som användaren ges tillgång till avgörs tillsammans med på Inera i samband med anslutningsprocessen [2]. Den vanligaste användningen av FileService är hämtning av publik enhetsinformation. Objekt och attribut för filen publicunits.zip finns specificerat i [3]. En förteckning över samtliga attribut i HSA med uppgifter om t.ex. krav på innehållet, fältlängder och vilka tjänster som använder attributen finns i [4]. Värdemängder som styr vissa attribut finns i [5]. Samtliga nu tillgängliga filer finns beskrivna i avsnitt 6. Det är viktigt att vara medveten om att alla attribut som levereras i filen inte kommer att innehålla information för alla objekt. Ytterst få attribut är obligatoriska i HSA, och varje informationsägare ansvarar själv för vilken information som denne registrerar. Alla informationsägare ska följa HSA-policy med tillhörande schema, men avvikelser kan ändå förekomma. För det fall tjänsten vill kontakta informationsägaren hänvisas till den e-postadress som är registrerad i attributet hsadirectorycontact, eller till nationellkundservice@inera.se som kan hänvisa till HSA-ansvarig i berörd organisation. Sid 4/28

5 4. Tekniska grundförutsättningar 4.1 Brandväggsöppning vid kommunikation över Sjunet HSA FileService finns tillgänglig över både Internet och Sjunet. Över Internet kan man hämta alla Fileservicefilerna, dock är det bara de som kan identifiera sig med klientcertifikat som får behörighet och access till de filer med personuppgifter. I de fall kommunikation ska gå över Sjunet behövs brandväggöppning, dels på användarens sida och dels på HSA:s sida. För brandväggsöppning på HSA:s sida behöver kontaktpersonen för anslutande tjänst fylla i ett formulär [6]. För kommunikation över Internet behövs ingen brandväggsöppning. 4.2 Tillit till HSA-serverns SITHS-certifikat Användarens system behöver också konfigureras upp att lita på HSA-serverns certifikat som också är utgivet med ett SITHS rot-certifikat. För närvarande används certifikat utgivna med följande rot-certifikat: HSA-Test2 Sjunet: SITHS Type2 CA v1 PP HSA-Test2 Internet: SITHS CA v1 PP HSA Prod Sjunet: SITHS Type2 CA v1 HSA Prod Internet: SITHS CA v1 Rotcertifikaten finns publicerade på /siths under Dokument och CA certifikat. Vid utveckling i Java läser man normalt in rot-certifikaten i en truststore som sedan används i koden. Java-kommandot keytool -import kan t.ex. användas för det. För beskrivning googla t.ex. på truststore keytool -import. Vid utveckling i.net används Windows inbyggda truststore som hanteras via Windows certmgr.msc. 4.3 Klientautentisering För att användarens system ska kunna identifiera sig mot HSA behövs ett klientcertifikat av typen SITHS Funktionscertifikat. Mot HSA:s testmiljö (HSA Test 2) behövs ett testcertifikat (utgivet med rot-certifikat SITHS Type 2 CA v1 PP). För kommunikation med HSA:s produktionsmiljö behövs ett skarpt certifikat (utgivet med rot-certifikat SITHS Type 2 CA v1). Om användarens organisation redan är ansluten till SITHS är det den egna RA-organisationen som utfärdar dessa funktionscertifikat. I annat fall hanteras avtal kring SITHS och beställning av funktionscertifikaten av Ineras kundservice. Se /siths under Anslutning & Beställning. Sid 5/28

6 4.3.1 Klientautentisering i Java Exemplet nedan är hämtat från och använder Apaches bibliotek för klientautentisering. import org.apache.http.conn.scheme.scheme; import org.apache.http.conn.scheme.schemeregistry; import org.apache.http.conn.ssl.sslsocketfactory; import org.apache.http.impl.client.defaulthttpclient; import org.apache.http.impl.conn.tsccm.threadsafeclientconnmanager; import org.apache.http.params.basichttpparams; import org.apache.http.params.httpparams;... final HttpParams httpparams = new BasicHttpParams(); // load the keystore containing the client certificate - keystore type is probably jks or pkcs12 final KeyStore keystore = KeyStore.getInstance("pkcs12"); InputStream keystoreinput = null; // TODO get the keystore as an InputStream from somewhere keystore.load(keystoreinput, "keystorepassword".tochararray()); // load the trustore, leave it null to rely on cacerts distributed with the JVM - truststore type is probably jks or pkcs12 KeyStore truststore = KeyStore.getInstance("pkcs12"); InputStream truststoreinput = null; // TODO get the trustore as an InputStream from somewhere truststore.load(truststoreinput, "truststorepassword".tochararray()); final SchemeRegistry schemeregistry = new SchemeRegistry(); schemeregistry.register(new Scheme("https", new SSLSocketFactory(keystore, keystorepassword, truststore), 443)); final DefaultHttpClient httpclient = new DefaultHttpClient(new ThreadSafeClientConnManager(httpParams, schemeregistry), httpparams); Här är ett exempel på hur filen sedan hämtas med det skapade DefaultHttpClient-objektet. HttpClient httpclient = new DefaultHttpClient(); HttpGet httpget = new HttpGet(" HttpResponse response = httpclient.execute(httpget); HttpEntity entity = response.getentity(); if (entity!= null) { InputStream instream = entity.getcontent(); try { // do something useful } finally { instream.close(); } } Sid 6/28

7 Vad man gör med InputStream instream är sen upp till klientutvecklaren att bestämma om man vill spara den i en fil eller använda streamen till något annat. Kodexemplet kommer från Apachedokumentationen Man kan även skripta ned filen via kommandot curl. Exempel: curl -E <SITHS klientcertifikat>.pem:<lösen> -k -o publicunits.zip 5. Hämtning av filer Olika filer skapas varje kväll, normalt mellan kl , utifrån olika i förväg konfigurerade sökkriterier. Filerna publiceras på HSA-servrar och är sedan, för till tjänsten anslutna användare, åtkomlig för nedladdning via en vanlig webbläsare eller programmatiskt. Filerna ska hämtas varje dygn och användas för att uppdatera eventuell egen databas. HSA-information ska vara uppdaterad mot källan och får inte ändras manuellt. 5.1 URL URL:en är till exempel där: <domänadress> är adressen till HSA:s server. Följande domänadresser finns: o HSA Integrationsmiljö över Sjunet: wstest.hsa.sjunet.org o HSA Integrationsmiljö över Internet: hsatest.inera.se o HSA Produktionsmiljö över Sjunet: ws.hsa.sjunet.org o HSA Produktionsmiljö över Internet: hsa.inera.se <fil> är en komprimerad xml-fil med den information som ska hämtas. Se namn på och beskrivning av respektive fil i avsnitt 6. Observera att det är viktigt att ange filens namn korrekt även med avseende på gemener och versaler. Vilken fil som blir aktuell för hämtning i det enskilda fallet avgörs tillsammans med på Inera i samband med anslutningsprocessen [2]. Åtkomst till filer i Schema för aktuell XML-fil kan fås på begäran av på Inera i samband med anslutningsprocessen [2]. Sid 7/28

8 6. Specifikation XML-filer De xml-filer som används hämtas hem som en zip-fil. Nedan beskrivs vad filerna heter och vilka attribut de levererar från HSA. Det är viktigt att vara medveten om att alla attribut som levereras i filen inte kommer att innehålla information för alla objekt. 6.1 publicunits.zip Innehåller alla organisationer, enheter och funktioner i hela HSA som är markerade som publika (hsadestinationindicator=03 Internettjänster med godkänd HPTB eller hsadestinationindicator=04 Alla som vill använda informationen, d.v.s. informationen blir publicerad i samlad form för fri användning av vem som helst (s.k. öppen data)) utom de enheter som är dolda eller arkiverade. Filen är av typen HsaInformationList (se HsaInformationListType i schematfil HSAInformationList_v.vv.xsd). Filen inleds med tidpunkt när den började genereras, och avslutas med tidpunkt med när den var klar och hur många objekt (i detta fall enheter) som finns med i den. För varje enhet tas följande attribut med, i de fall det finns ett attributvärde inskrivet. Ytterligare beskrivning av attributen, inklusive syntax och användning i andra tjänster, finns i HSAschemat [3] samt i HSA värdemängder [4]. Parameter Datatyp Antal Beskrivning TotalHsaObjects startdate enddate Distinguished Name HSA: - LDAP: - createtimestamp HSA: Skapandetidpunkt LDAP: createtimestamp modifytimestamp HSA: Senaste förändringstidpunkt LDAP: modifytimestamp Antal objekt filen innehåller datetime 0-1 Start och sluttid då filen genererats String 1-1 Katalogsökvägen enhetens placering i katalogträdet. Generalized Time Ex ou=aleris Äldreboende,o=Aleris Holding AB,c=SE 1-1 Tidpunkt för skapandet av objektet. String 1-1 Tidpunkt för senaste uppdatering av objektet. Sid 8/28

9 businessclassificationcode HSA: Verksamhetskod LDAP: businessclassificationcode businessclassificationname HSA: Verksamhet LDAP: businessclassificationname c (countryname) HSA: Land LDAP: c (countryname) caretype HSA: Vårdform LDAP: caretype cn HSA: Objektnamn LDAP: cn countycode HSA: Länskod LDAP: countycode countyname HSA: Länsnamn LDAP: countyname description HSA: Beskrivning LDAP: Description dropinhours HSA: Tid för dropin-besök utan tidsbokning LDAP: dropinhours enddate HSA: Slutdatum LDAP: enddate facsimiletelephonenumber String 0 - n Typ av verksamhet (kod) som enheten bedriver. Värdemängd. String 0-1 Typ av verksamhet (klartext) som enheten bedriver. Värdemängd. String Landets beteckning. String 0 - n Vårdform. Värdemängd. 1 1 Enhetsfunktionens namn (se ovanstående lista). String 1-1 Namn för funktionsobjekt. String 0-1 Kod för län där verksamheten bedrivs. String 0-1 Namn på län där verksamheten bedrivs. String 0-1 Allmän beskrivning för enheten. TimeSpan 0 n Tider för så dropin-besök (utan tidbokning). String 0 1 Slutdatum för enhetens verksamhet. String 0 - n Faxnummer till enheten. HSA: Fax Sid 9/28

10 LDAP: facsimiletelephone Number hsadirectorycontact HSA: Innehållsansvarig LDAP: hsadirectorycontact (hämtad från överliggande o eller ou-objekt) geographicalcoordinates HSA: Geografiska koordinater LDAP: geographicalcoordinates geographicalcoordinatesswe ref99tm HSA: Geografiska koordinater SWEREF 99 TM LDAP: geographicalcoordinatesswe ref99tm hsaalttext HSA: alt-text LDAP: hsaalttext hsabusinesstype HSA: Enhetstyp LDAP: hsabusinesstype hsahealthcarearea HSA: Områdesansvar LDAP: hsahealthcarearea hsaidentity HSA: HSA-id LDAP: hsaidentity hsajpeglogotype HSA: Logotyp LDAP: hsajpeglogotype String 0-1 Ansvarig för informationen om enheten (epostadress). Coordinate 0-1 Geografiska koordinater för enhetens huvudsakliga fysiska placering. - String 0 1 Geografiska koordinater för enhetens huvudsakliga fysiska placering. Koordinaterna anges enligt SWEREF 99 TM. String 0-1 Beskrivande text till bild på enhet (jfr jpegphoto). String 0 n Klassificering av enhet (t.ex. sjukhus). Värdemängd. String 0-1 Geografiskt område för någon typ av administrativt område. String 1-1 Unikt ID för enheten. Base Logotype för enheten. Logotypen är en binär bild i JPEG-format. Bildinformationen returneras Base64-kodat. Sid 10/28

11 hsaswitchboardnumber HSA: Växeltelefon LDAP: hsaswitchboardnumber hsatexttelephonenumber HSA: Texttelefon LDAP: hsatexttelephone Number hsavisitingruleage HSA: Åldersregler för vårdkontakt LDAP: hsavisitingruleage HSAvisitingRuleReferral HSA: Remisskrav LDAP: hsavisitingrulereferral hsavisitingrules HSA: Besöksregler LDAP: hsavisitingrules jpegphoto HSA: Bild LDAP: jpegphoto I (location) HSA: Geografisk plats LDAP: l labeleduri HSA: Webbadress LDAP: labeleduri management HSA: Ägarform LDAP: management Mobile String 0-1 Telefonnummer till växel. String 0-1 Texttelefonnummer för personer med tal- eller hörselhandikapp. AgeSpan 0-1 Åldersintervall på patienter som tas emot. String 0-1 Beskrivning av remisskrav. String 0-1 Besöksregler för anhöriga. Base Bild/foto för enheten. Bilden är en binär bild i JPEG-format. Bildinformationen returneras Base64-kodat. String 0 1 Namn på geografiskt område där enheten i huvudsak är placerad. String 0-1 Fullständig webbadress (inklusive eller String 0-1 Ägarform i klartext. String 0 - n Mobiltelefonnummer. HSA: mobiltelefon Sid 11/28

12 LDAP: mobile municipalitycode HSA: Kommunkod LDAP: municipalitycode municipalityname HSA: Kommunnamn LDAP: municipalityname orgno HSA: organisationsnummer LDAP: orgno oushort HSA: Alternativt namn LDAP: oushort postaladdress HSA: Postadress LDAP: postaladdress postalcode HSA: Postnummer LDAP: postalcode route HSA: Vägbeskrivning LDAP: route startdate HSA: Start datum LDAP: startdate street HSA: Besöksadress LDAP: street surgeryhour String 0-1 Kod för kommun där verksamheten bedrivs. String 0-1 Namn på kommun där verksamheten bedrivs. String 0-1 för enheten. String 0 - n Alternativt namn på enheten som används vid sidan av det officiella namnet (publicname). Adress 0 1 Postadress Består av ett antal adressrader. String 0-1 Postnummer där verksamheten bedrivs (inte alltid samma som i postadressen). String 0-1 Vägbeskrivning. String 0-1 Startdatum för enhetens verksamhet. String 0-1 Besöksadress (gatuadress). TimeSpan 0 - n Öppettider HSA: Öppettider LDAP: surgeryhours Sid 12/28

13 telephonehour HSA: Telefontid LDAP: telephonehours telephonenumber HSA: Telefonnummer LDAP: telephonenumber visitinghour HSA: Besökstider för anhöriga LDAP: visitinghours hsavpwwebpage HSA: 1177-kontaktkortslänk LDAP: hsavpwwebpage TimeSpan 0 - n Telefontider för telefonnummer i parametern telephonenumber. String 0 - n Publikt direkttelefonnummer. TimeSpan 0 - n Besökstider för anhöriga. String 0-1 Länk till enhetens kontaktkort på 1177.se. AgeSpan Åldersintervall Parameter Datatyp Antal Beskrivning From String 1 1 Från ålder. 00 för nyfödd To String 1-1 Till ålder. 99 för övre åldergräns Comment String 0-1 Kommentar i fri text TimeSpan Tidsintervall Parameter Datatyp Antal Beskrivning fromday String 1-1 Från dag. Måndag (1) Söndag (7). fromtime Time (XML) 1-1 Från tid. today String 1-1 Till dag. Måndag (1) Söndag (7). totime Time (XML) 1-1 Till tid. Comment String 0 1 Information om aktuellt tidsintervall. Coordinate Geografiska koordinater Parameter Datatyp Antal Beskrivning Type String 1-1 Typ av geografisk koordinat. Idag används enbart RT90. Sid 13/28

14 X String 1-1 X-koordinat. Y String 1-1 Y-koordinat. Telefon Telefonnummer anges med XML-typen string. Telefonnummer kodas i nationellt format utan bindestreck och mellanslag (t.ex ). 6.2 hsaunits.zip Innehåller alla enheter i hela HSA utom de som är dolda eller arkiverade och beskriver PDLorganisationen (vårdgivare, vårdenheter och kopplade enheter). För utökad beskrivning av attribut och värdemängder, se [4] och [6]. För varje enhet tas följande attribut med, i de fall det finns ett attributvärde inskrivet. Parameter Datatyp Antal Beskrivning startdate enddate startdate HSA: Startdatum LDAP: startdate enddate HSA: Slutdatum LDAP: enddate hsaidentity datetime 0-1 Start och sluttid då filen genererats datetime 0-1 Startdatum för enhetens verksamhet datetime 0-1 Slutdatum för enhetens verksamhet String 1-1 HSA-id för enheten. HSA: HSA-id LDAP: hsaidentity name HSA: Organisationsnamn, Enhetsnamn eller Objektnamn, LDAP: o, ou eller cn (beroende på objekttyp) Distinguished Name HSA: - LDAP: - String 1-1 Namn Namn i detta sammanhang definieras som värdet i LDAP-attributet o (organization), ou (organisationsenhet) eller cn (organisationsroll). String 1-1 Katalogsökvägen för enhetens placering i katalogträdet. Ex ou=aleris Äldreboende,o=Aleris Sid 14/28

15 orgno HSA: organisationsnummer LDAP: orgno Holding AB,c=SE String 0-1 för den vårdgivare som enheten tillhör. ishsahealthcareprovider Boolean 0 1 Flagga för att enheten är en vårdgivare ishsahealthcareunit Boolean 0-1 Flagga för att enheten är en vårdenhet HSA: - LDAP: ishsahealthcareunit hsaresponsiblehealthcarepro vider HSA: vårdgivartillhörighet LDAP: hsaresponsiblehealthcarepro vider hsahealthcareunitmembers HSA: - LDAP: hsahealthcareunitmembers String 0-1 HSA-id för den vårdgivare som enheten tillhör. Saknas om enhet inte är en vårdenhet. Type 0-1 Attributet sätts på vårdenhet och pekar ut HSA-id för enheter och funktioner som ingår i denna vårdenhet. Varje enhet/funktion får bara tillhöra en vårdenhet... hsahealthcareunitmember String 1-1 HSA-id för till vårdenheten kopplade enheter 6.3 vpwpublicunits.zip Innehåller kortfattad information om publika organisationer, enheter och funktioner. Kompletteras med ett WS- eller tjänstekontraktsanrop för att hämta fullständig information om objekt som uppdaterats sedan senaste hämtningen. För varje enhet tas följande attribut med, i de fall det finns ett attributvärde inskrivet. Parameter Datatyp Antal Beskrivning startdate enddate hsaidentity HSA: HSA-id LDAP: hsaidentity datetime 0-1 Start och sluttid då filen genererats Sting 1-1 HSA-id för enheten. Sid 15/28

16 name HSA: Enhetsnamn eller Objektnamn LDAP: ou, o eller cn Location HSA: - LDAP: - searchbase HSA: - LDAP: - modifytimestamp HSA: Senaste förändringstidpunkt LDAP: modifytimestamp String 1-1 Enhetsnamn eller funktionsnamn String 1-1 Under vilket län som enheten finns katalogtekniskt 1 - ska inte förväxlas med attributet countycode/countyname String 1-1 Sökbas för användning vid utsökning av information för aktuell enhet med hjälp av metoden GetHsaUnit datetime 1-1 Tidpunkt för senaste uppdatering av enhetsobjekt. 6.4 vpwpublicpersons.zip Innehåller alla personer i hela HSA som är markerade som publika (hsadestinationindicator=03 eller hsadestinationindicator=04) utom de personer som är dolda eller har skyddade personuppgifter. Lämnas endast ut till 1177.se. För varje enhet tas följande attribut med, i de fall det finns ett attributvärde inskrivet. Parameter Datatyp Antal Beskrivning startdate enddate hsaidentity HSA: HSA-id LDAP: hsaidentity datetime 0-1 Start och sluttid då filen genererats String 1-1 HSA-id för personen. GivenName string 1-1 Tilltalsnamn 1 var aktuellt förut när vissa locations låg i externkataloger som inte alltid var tillgängliga vid utsökningen kopplat till den information som kommer sist i filen kring vilka locations som varit tillgängliga och inte under utsökningen Sid 16/28

17 HSA: förnamn LDAP: gn, givenname middlename String 0-1 Mellannamn HSA: mellannamn LDAP: middlename Sn HSA: Efternamn LDAP: sn nickname HSA: smeknamn LDAP: nickname Title HSA: Titel LDAP: title Distinguished Name (DN) HSA: - LDAP: DN parentpublicunit HSA: - LDAP: - String 1-1 Efternamn String 0-1 Smeknamn String 0-1 Titel (fritextfält). String 1-1 Katalogsökvägen för personens placering i katalogträdet. Ex cn=anna Andersson,ou=Aleris Äldreboende,o=Aleris Holding AB,c=SE String 1-1 Katalogsökvägen för ovanliggande publik enhet i katalogträdet. Ex ou=aleris Äldreboende,o=Aleris Holding AB,c=SE 6.5 psipublicunits.zip Innehåller alla enheter i hela HSA som är markerade med Visas för angiven till Alla som vill använda informationen, d.v.s. informationen blir publicerad i samlad form för fri användning av vem som helst (s.k. öppen data), hsadestinationindicator=04. Attributen som hämtas är samma som publicunits.zip (se avsnitt 6.1). Sid 17/28

18 6.6 psipublicpersons.zip Innehåller alla personer i hela HSA som är markerade med Visas för angiven till Alla som vill använda informationen, d.v.s. informationen blir publicerad i samlad form för fri användning av vem som helst (s.k. öppen data), hsadestinationindicator=04. Attributen som hämtas är samma som vpwpublicpersons.zip (se avsnitt 6.4). 6.7 hsaunitsextended.zip hsaunitsextended.zip innehåller alla enheter i hela HSA utom de som är dolda eller arkiverade och beskriver PDL-organisationen (vårdgivare, vårdenheter och kopplade enheter) samt kontaktuppgifter och geografisk plats. Parameter Datatyp An tal startdate Beskrivning datetime 0..1 Starttid då filen genererats HSA: starttid LDAP: startdate hsaunits..hsaunit....startdate HSA: Startdatum LDAP: startdate.... enddate HSA: Slutdatum LDAP: enddate....hsaidentity HSA: HSA-id LDAP: hsaidentity....distinguished Name HSA: DN LDAP: Distinguished Name Collection ListHsaU nittype datetime 0..1 Startdatum för enhetens verksamhet datetime 0..1 Slutdatum för enhetens verksamhet String 1..1 HSA-id för enheten. String 1..1 Katalogsökvägen för enhetens placering i katalogträdet. Ex ou=aleris Äldreboende,o=Aleris Holding AB,c=SE Sid 18/28

19 ....name HSA: Organisationsnamn, Enhetsnamn eller Objektnamn, LDAP: o, ou eller cn (beroende på objekttyp) String 1..1 Namn Namn i detta sammanhang definieras som värdet i LDAP-attributet o (organisation), ou (enhet) eller cn (funktion).....orgno String 0..1 Organisationsnumret angivet för aktuell HSA: organisationsnummer organisation/enhet/funktion (oftast registrerat endast för LDAP: orgno vårdgivare)....ishsahealthcareprovider Boolean 0..1 Flagga för att enheten är en vårdgivare....ishsahealthcareunit HSA: - LDAP:....hsaResponsibleHealthCareProvider HSA: vårdgivartillhörighet LDAP: hsaresponsiblehealthcareprovider....hsahealthcareunitmember HSA:vårdenhetens ingående enheter LDAP: hsahealthcareunitmember....businessclassification Business Classifica tiontype......businessclassificationname HSA: Verksamhet LDAP: businessclassification Name Boolean 0..1 Flagga för att enheten är en vårdenhet String 0..1 HSA-id för den vårdgivare som enheten tillhör. Saknas om enhet inte är en vårdenhet. string 0..n Attributet sätts på vårdenhet och pekar ut HSA-id för enheter och funktioner som ingår i denna vårdenhet. Varje enhet/funktion får bara tillhöra en vårdenhet Verksamhetskod String 1..1 Typ av verksamhet (klartext) som enheten bedriver. Värdemängd. Verksamhetskod(-er) i klartext......businessclassificationcode String 1..1 Verksamhetskod(-er) kod....businesstype HSA: Enhetstyp LDAP: businesstype String 0..n Klassificering av enhet (t.ex. sjukhus). Värdemängd. Sid 19/28

20 ....caretype HSA: Vård- och verksamhetsform LDAP: caretype....countycode HSA: Länskod LDAP: countycode....countyname HSA: Länsnamn LDAP: countyname....directorycontact HSA: Innehållsansvarigs e-postadress LDAP: directorycontact.... geographicalcoordinates HSA: Geografiska koordinater LDAP: geographicalcoordinates String 0..n Vård- och omsorgsform String 0..1 Kod för län där verksamheten bedrivs. String 0..1 Namn på län där verksamheten bedrivs. String 0..1 Ansvarig för informationen om enheten (epostadress). Coordinat e 0..1 Geografiska koordinater för enhetens huvudsakliga fysiska placering. Koordinaterna anges enligt Geografiska koordinater RT xCoordinate String 1..1 X-koordinat yCoordinate String 1..1 Y-koordinat.....geografiska koordinater SWEREF 99 TM HSA: geografiska koordinater SWEREF 99 TM LDAP: geographicalcoordinatessweref99 String 0..1 Geografiska koordinater för enhetens huvudsakliga fysiska placering. Koordinaterna anges enligt SWEREF 99 TM nCoordinate String 1..1 N-koordinat eCoordinate String 1..1 E-koordinat.....I (localityname) HSA: Geografiska plats LDAP: I (localityname)....street HSA: Besöksadress String 0..1 Namn på geografiskt område där enheten i huvudsak är placerad. String 0..1 Besöksadress (gatuadress). Sid 20/28

21 LDAP: Street....municipalityCode HSA: Kommunkod LDAP: municipalitycode....municipalityname HSA: Kommunnamn LDAP: municipalityname....telephonenumber HSA: Direkttelefonnummer LDAP:telephoneNumber....switchboardNumber HSA: Växeltelefonnummer LDAP: switchboardnumber....nonpublictelephonenumber HSA: Tjänstetelefon LDAP: nonpublictelephonenumber....facsimiletelephonenumber HSA: Fax LDAP: facsimiletelephonenumber....postaladdress HSA: Postadress LDAP: postaladdress String 0..1 Kod för kommun där verksamheten bedrivs. String 0..1 Namn på kommun där verksamheten bedrivs. Telefon 0..n Publikt direktnummer Telefon 0..1 Telefonnummer till växel. Telefon 0..n Tjänstetelefonnummer, d.v.s icke-publikt telefonnummer som inte får lämnas ut till invånare/patienter. Telefon 0..n Faxnummer AddressT ype 0..1 Postadress, hela postadressen inkl. gata+gatunummer/box, postnummer och postort.....adressline String 1..n Adressrad....mail HSA: E-post LDAP: mail....hsavpwwebpage HSA:1177-kontaktkortslänk LDAP: hsavpwwebpage....management HSA: Ägarform string 0..1 E-postadress till enheten String 0..1 Länk till enhetens kontaktkort på 1177.se. String 0..1 Ägarform i klartext. Sid 21/28

22 LDAP: management enddate HSA: Sluttid LDAP:endDate datetime 0..1 Sluttid då filen genererats 6.8 systemspecificuser_[system_id].zip Filen listar alla användare som har behörighet till ett specifikt system, det vill säga de användare som har en individuell behörighetsegenskap för it-tjänster (hsasystemrole) med det aktuella systemets prefix. Exempel: systemspecificusers_ ichem.zip Parameter Datatyp Antal Beskrivning startdate datetime 1..1 Starttid då filen genererats HSA: Startdatum LDAP: startdate personinformation..hsaidentity HSA: HSA-id LDAP: hsaidentity..distinguishedname (DN) HSA: - LDAP: DN hsasystemrole HSA: Individuell behörighetsegenskap för ittjänster LDAP: hsasystemrole PersonInfor mationtype 0..n Om personen har flera person-objekt som har aktuell hsasystemrole returneras en instans per objekt. String 1..1 HSA-id för personen. String 1..1 Katalogsökvägen för personens placering i katalogträdet. HsaSystemR oletype 0..n Ex cn=anna Andersson,ou=Aleris Äldreboende,o=Aleris Holding AB,c=SE Beskriver behörighet för person i ett visst system. Endast hsasystemrole för aktuellt system returneras Sid 22/28

23 ..givenname string 1..1 Tilltalsnamn HSA: förnamn LDAP: gn, givenname..middleandsurname HSA: mellannamn /efternamn LDAP: middleandsurname..hsatitle HSA: Legitimerad Yrkesgrupp LDAP:hsaTitle String 1..1 Eventuellt mellannamn samt efternamn String 0..n Legitimerad yrkesgrupp enligt definierad värdemängd..patitle PaTitleType 0..n Personens befattning enligt definierad värdemängd....patitlename HSA: Befattning LDAP: patitlename....patitlecode HSA: Befattningskod LDAP:paTitleCode..Title String 0..1 Befattning String 0..1 Befattningskod String 0..n Titel (fritextfält). HSA: Titel LDAP: title..mail HSA: E-postadress LDAP: mail..telephonenumber HSA: Direkttelefon LDAP: telephonenumber String 0..1 E-postadress Telefon 0..n Publikt direkttelefonnummer..mobilenumber Telefon 0..n Mobiltelefonnummer HSA: Mobiltelefonnummer LDAP: mobilenumber enddate datetime 1..1 Sluttid då filen genererats Sid 23/28

24 HSA:Slutdatum LDAP: enddate 6.9 omvard.zip kommer att fasas ut Innehåller samma information som publicunits.zip (se avsnitt 6.1) och hämtas av omvård.se (men via HSAWS-metoden GetInformationList) publicunits_valbar kommer att fasas ut Den gamla versionen av öppen data, levererar enheter med hsadestionationindicator= 03 och 04 endast för de organisationer som skriftligen godkänt utlämnande av enhetsinformation som öppen data. Innehåller samma information som publicunits.zip (se avsnitt 6.1) och hämtas av SDK Mina vårdkontakter (men via HSAWS-metoden GetInformationList). 7. Referenser Ref nr. Dokumentnamn Länk [1] HSA-policy /hsa, under Dokument och Avtal [2] HSA Tjänsteanslutningsprocess [3] Specifikation utlämning av publik enhetsinformation [4] HSA-schema organisationsträdet (Excel) [5] HSA värdemängder [6] Formulär för ändring av anslutning /hsa, under Anslutning och Anslutning av tjänst /hsa under Dokument och Avtal /hsa under Dokument och HSAschema /hsa under Dokument och HSAinnehåll /hsa, under Anslutning och Ändra anslutning Sid 24/28

25 Appendix - Exempel på en xml-fil (publicunits.xml) Filens StartDate resp. EndDate anger tidpunkterna för när sökningen påbörjades resp. avslutades. Någon eller några minuter efter EndDate finns filen publicerad och därmed tillgänglig för nedladdning. <?xml version="1.0" encoding="utf-8"?> <HsaInformationList xmlns="urn:riv:hsa:hsainformationlist:1" xmlns:hwr="urn:riv:hsa:hsawsresponder:3"> <StartDate> T21:00: :00</StartDate> <HsaObjects> <HsaObject> <DN>ou=Specialisttandläkarna,o=Bra Tandvård AB,c=SE</DN> <Attribute name="l"> <S>Norrort</S> <Attribute name="street"> <S>Norra gatan 1, 2 tr, STOCKHOLM</S> <Attribute name="description"> <S>Specialisttandläkare bettfysiologi.</s> <Attribute name="postaladdress"> <Address> <hwr:addressline>box 111</hwr:addressLine> <hwr:addressline> STOCKHOLM</hwr:addressLine> </Address> <Attribute name="postalcode"> <S>11222</S> <Attribute name="telephonenumber"> <S> </S> <Attribute name="facsimiletelephonenumber"> <S> </S> <Attribute name="createtimestamp"> <S> Z</S> <Attribute name="modifytimestamp"> <S> Z</S> Sid 25/28

26 <Attribute name="labeleduri"> <S> <Attribute name="jpegphoto"> <Base64>QQEBQbHxcXFxcXHx 4XGhoaGhceHiMlJy</Base64> <Attribute name="businessclassificationcode"> <S>1802</S> <Attribute name="businessclassificationname"> <S>Allmäntandvård</S> <Attribute name="hsajpeglogotype"> <Base64>/9j/ABAAAAHhUA ABsBBQABAAAAJhAABoHwAA<base64> <Attribute name="orgno"> <S> </S> <Attribute name="countycode"> <S>01</S> <Attribute name="countyname"> <S>Stockholms län</s> <Attribute name="municipalitycode"> <S>0180</S> <Attribute name="municipalityname"> <S>Stockholm</S> <Attribute name="startdate"> <S> Z</S> <Attribute name="management"> <S>Privat</S> <Attribute name="caretype"> <S>01</S> <Attribute name="hsaidentity"> <S>SE QC</S> <Attribute name="hsavisitingruleage"> Sid 26/28

27 <AgeSpan> <hwr:from>0</hwr:from> <hwr:to>18</hwr:to> <hwr:comment>barn och ungdomstandvård</hwr:comment> </AgeSpan> <Attribute name="hsatexttelephonenumber"> <S> </S> <Attribute name="hsavisitingrules"> <S>Ungdomsmottagningen för alla under 18 år</s> <Attribute name="hsavisitingrulereferral"> <S>Läkare eller sköterska</s> <Attribute name="geographicalcoordinates"> <Coordinate> <hwr:type>rt90</hwr:type> <hwr:x> </hwr:x> <hwr:y> </hwr:y> </Coordinate> <Attribute name="dropinhours"> <TimeSpan> <hwr:fromday>1</hwr:fromday> <hwr:fromtime2>00:00</hwr:fromtime2> <hwr:today>7</hwr:today> <hwr:totime2>23:59</hwr:totime2> <hwr:comment/> </TimeSpan> <Attribute name="telephonehours"> <TimeSpan> <hwr:fromday>1</hwr:fromday> <hwr:fromtime2>08:00</hwr:fromtime2> <hwr:today>3</hwr:today> <hwr:totime2>17:00</hwr:totime2> <hwr:comment/> </TimeSpan> <Attribute name="oushort"> <S>Tandl. Elsie Ells</S> <Attribute name="hsahealthcarearea"> Sid 27/28

28 <S>Norrort</S> <Attribute name="route"> <S>Mitt emot Medborgarplatsen. </S> <Attribute name="surgeryhours"> <TimeSpan> <hwr:fromday>1</hwr:fromday> <hwr:fromtime2>08:00</hwr:fromtime2> <hwr:today>3</hwr:today> <hwr:totime2>17:00</hwr:totime2> <hwr:comment/> </TimeSpan> <Attribute name="hsaswitchboardnumber"> <S> </S> <Attribute name="enddate"> <S> Z</S> <Attribute name="hsabusinesstype"> <S>02</S> <Attribute name="hsaalttext"> <S>Vårdcentralen Katten</S> <Attribute name="hsadirectorycontact"> <Attribute name="hsavpwwebpage"> <S> </HsaObject> <HsaObject> </HsaObject> </HsaObjects> <EndDate> T21:54: :00</EndDate> <TotalHsaObjects>19163</TotalHsaObjects> </HsaInformationList> Sid 28/28