Klassifikation - organisations services

På denne side beskrives services der vedrører klassifikationer/organisationsoplysninger i region Syddanmark. De pågældende services med tilhørende metoder kan udstilles via regionens integrationsplatform og kan dermed tilgås af andre systemer. 

 I øjeblikket udstiller regionen følgende klassifikation/organisation services:

SOR Web service

Regionens SOR (=Sundhedsvæsenets OrganisationsRegister) web service - herefter kaldet SOR - skal opfattes som en organisationsservice der beskriver sygehusenes organisation i region Syddanmark. 

Generelt

SOR er en database, der indeholder oplysninger om, hvordan blandt andet sygehuse, praksisser og speciallægeklinikker er organiseret. Foruden selve organisationshierarkiet indeholder SOR en lang række stamoplysninger, der kan knyttes til hver enkelt "enhed" i organisationerne.
 
Region Syddanmark vedligeholder en lokal kopi af SOR, herefter kaldet RSD-SOR.

I dette afsnit beskrives den Web service, der er udviklet til at tilgå data i RSD-SOR. Læseren forudsættes at kende de grundlæggende termer og strukturer i SOR.

Overordnet består SOR-servicen af metoder, der giver mulighed for at søge i SOR-hierarkiet, hente oplysninger om en organisatorisk "enhed", og vedligeholde oplysninger om et eventuelt abonnement på ændringer af data i SOR/RSD-SOR.

Følgende metoder er tilgængelige:

  • getAvailableClassificationNames
  • getClassificationValues
  • getHealthInstitution
  • getInstitutionOwner
  • getOrganizationalUnit
  • getSubscriptionStatus
  • removeSubscription
  • searchRsdUniqueSorProvider
  • searchSorBasic
  • searchSorProvider
  • updateSubscription

Forbehold

For at få det fulde udbytte af dette dokument kræves et grundlæggende kendskab til SOR og SORs begrebsapparat.

Vedr. metoder til abonnement (pr. 01-09-2011)
Kald af abonnementsmetoderne kræver, at der er oprettet grundlæggende stamdata til abonnement. Stamdataoplysningerne oprettes af regionens strategi- og udviklingsafdeling.
Selv om det er muligt at benytte metoderne til abonnement, er den bagvedliggende funktionalitet til løbende propagering af ændringer i SOR, pt. ikke i stand til at benytte abonnementoplysningerne.

Historik

RSD-SOR indeholder historik for alle enheder, derfor er det nødvendigt at angive en dato i søgekriteriet på de metoder, der søger eller henter oplysninger om enheder.
Metoderne vil returnere data, der er gyldige på den angivne dato.

RSD-SOR indeholder også ændringer, der først vil træde i kraft efter dagsdato, så det er muligt at angive en fremtidig dato.

Sikkerhed

Det er nødvendigt, at man i alle kald af Web servicen benytter et brugernavn, password som kan rekvireres ved, at forespørge regionens strategi- og udviklingsafdeling.

WSDL

Servicen benytter følgende WSDL.

Metoder

getAvailableClassificationNames

SOR benytter en række klassifikationer (lookup data). Denne metode returnerer navnene på klassifikationerne.

Søgekriterier

XML navn Beskrivelse
authentification Brugernavn og Password

Udtræksfelter

XML navn Beskrivelse Eksempel
getAvailableClassificationNamesReturn Klassifikationsnavn ”InstitutionOwnerType”


getClassificationValues

Med navnet på en klassifikation (evt. hentet med getAvailableClassificationNames) kan værdisættet for klassifikationen hentes med denne metode.

Når servicens ’get’-metoder benyttes, vil klassifikationskoderne returneres i de relevante felter. Det er op til klientsystemet at ”oversætte” koden til et navn, hvis data evt. skal vises for brugere.

Søgekriterier

XML navn Beskrivelse
authentification Brugernavn og Password
classifikationName Navnet på klassifikationen. F.eks.: ”InstitutionOwnerType”

Udtræksfelter

XML navn Beskrivelse Eksempel
code Kode ”547211000005108”
value Værdi ”kommunal”
classifikationName Navnet på klassifikationen ”InstitutionOwnerType”


getHealthInstitution

Metoden returnerer udvalgte data for en SOR-sundhedsinstitution.

Søgekriterier

XML navn Beskrivelse
authentification Brugernavn og Password
sorCode Den officielle SOR-code (fra SST)
validityDate Gyldighedsdatotid på formen ’ yyyy-mm-ddThh:mi:ss.nnnZ’

Udtræksfelter

XML navn Beskrivelse Eksempel
sorCode Enhedens SOR code 8061000016004
name Enhedens navn ”Sygehus Lillebælt”
type Enhedstype 22232009 (En HealthInstitutionType i dette tilfælde)
fromDate Den dato de følgende data er gyldige fra ”2011-03-03T23:00:00.000Z”
toDate Den dato de følgende data er gyldige til og med. NULL hvis der ikke er nogen ’gyldig til dato’ ”2500-01-01T22:59:59.099Z”
parentSorCode SOR code på enhedens parent 6101000016001
parentName Navnet på enhedens parent ”Region Syddanmark”
shakIdentifier SHAK kode ”1234”
pharmacyIdentifier Apotekskode ”123AB”
rsdUniqueProviderIdentifier Ydernummer Region Syddanmark har valgt at placere på denne enhed, så det garanteres at ydernummeret er unikt ”123456”
rsdUniqueShakIdentifier SHAK kode Region Syddanmark har valgt at placere på denne enhed, så det garanteres at SHAK koden er unik ”1234”
postalAddress Postadresse  
visitingAddress Besøgsadresse  
virtualAddress Virtuel adresse  
eanAddress EAN adresse  
ediTypes EDI typer  
localAttributes Lokale attributter  


getInstitutionOwner

Metoden returnerer udvalgte data for en SOR-institutionsejer.

Søgekriterier

XML navn Beskrivelse
authentification Brugernavn og Password
sorCode Den officielle SOR-code (fra SST)
validityDate Gyldighedsdatotid på formen ’ yyyy-mm-ddThh:mi:ss.nnnZ’

Udtræksfelter

XML navn Beskrivelse Eksempel
sorCode Enhedens SOR code 6101000016001
name Enhedens navn ”Region Syddanmark”
type Enhedstype 550881000005103 (InstitutionOwnerType i dette tilfælde)
fromDate Den dato de følgende data er gyldige fra ”2011-03-03T23:00:00.000Z”
toDate Den dato de følgende data er gyldige til og med. NULL hvis der ikke er nogen ’gyldig til dato’ ”2500-01-01T22:59:59.099Z”
rsdUniqueProviderIdentifier Ydernummer Region Syddanmark har valgt at placere på denne enhed, så det garanteres at ydernummeret er unikt ”123456”
rsdUniqueShakIdentifier SHAK kode Region Syddanmark har valgt at placere på denne enhed, så det garanteres at SHAK koden er unik ”1234”
postalAddress Postadresse  
eanAddress EAN adresse  
ediTypes EDI typer  
localAttributes Lokale attributter  


getOrganizationalUnit

Metoden returnerer udvalgte data for en SOR-organisatorisk enhed.

Søgekriterier

XML navn Beskrivelse
authentification Brugernavn og Password
sorCode Den officielle SOR-code (fra SST)
validityDate Gyldighedsdatotid på formen ’ yyyy-mm-ddThh:mi:ss.nnnZ’

Udtræksfelter

XML navn Beskrivelse Eksempel
sorCode Enhedens SOR code 247531000016003
name Enhedens navn ”SLB Akutafdelingen (Kolding)”
type Enhedstype 550871000005101 (OrganizationalUnitType i dette tilfælde)
fromDate Den dato de følgende data er gyldige fra ”2011-03-03T23:00:00.000Z”
toDate Den dato de følgende data er gyldige til og med. NULL hvis der ikke er nogen ’gyldig til dato’ ”2500-01-01T22:59:59.099Z”
parentSorCode SOR code på enhedens parent 247441000016006
parentName Navnet på enhedens parent ”SLB Medicinsk Afdeling (Kolding)”
shakIdentifier SHAK kode ”6007210”
providerIdentifier Ydernummer ”123456”
pharmacyIdentifier Apotekskode ”123AB”
localCode Lokal kode ”XYZ”
patientsAdmitted Stationære patienter på enheden 1:Ja, 0: Nej
ambulantActivity Ambulant aktivitet på enheden 1:Ja, 0: Nej
reportinglevel Indberetningsniveau til LPR 1:Ja, 0: Nej
rsdUniqueProviderIdentifier Ydernummer Region Syddanmark har valgt at placere på denne enhed, så det garanteres at ydernummeret er unikt ”123456”
rsdUniqueShakIdentifier SHAK kode Region Syddanmark har valgt at placere på denne enhed, så det garanteres at SHAK koden er unik ”6007210”
postalAddress Postadresse  
visitingAddress Besøgsadresse  
activityAddress Akitivitesadresse  
virtualAddress Virtuel adresse  
eanAddress EAN adresse  
ediTypes EDI typer  
localAttributes Lokale attributter  
specialities Specialer  


getSubscriptionStatus

Metoden returnerer en liste med de enheder, der pt. findes i brugerens abonnement.

Input

XML navn Beskrivelse
authentification Brugernavn og Password

Output

XML navn Beskrivelse Eksempel
sorCode Enhedens SOR code 247531000016003
withAllUnderlying Der abonneres på alle underliggende enheder 1:Ja, 0: Nej


removeSubscription

Metoden fjerner en enhed fra brugerens abonnement.

Input

XML navn Beskrivelse
authentification Brugernavn og Password
sorCode Den officielle SOR-code (fra SST)

Output
Metoden returnerer ingen felter.


searchRsdUniqueSorProvider

Metoden returnerer basale oplysninger om den enhed, Region Syddanmark har valgt at identificere unikt med det pågældende ydernummer.

Med udgangspunkt i den returnerede sorCode og sorBasicType, kan den relevante ’get-metode’ efterfølgende kaldes for at hente yderligere oplysninger om enheden.

Søgekriterier

XML navn Beskrivelse
authentification Brugernavn og Password
validityDate Gyldighedsdatotid på formen ’ yyyy-mm-ddThh:mi:ss.nnnZ’
providerIdentifier Ydernummer

Udtræksfelter

XML navn Beskrivelse Eksempel
sorCode Enhedens SOR code 16871000016001
sorName Enhedens navn Adam Pedersen
sorType Enhedstypen 0
sorBasicType Den basale enhedstype i RSD-SOR. ”IE” for institutionsejer, ”SI” for sundhedsinstitution, ”OE” for organisatorisk enhed ”OE”
ownerCode SOR code på parent/owner 16851000016008
ownerName Navn på parent/owner Adam Pedersen
ownerType Enhedstype på owner/parent 550891000005100
postalAddress Postadresse  


searchSorBasic

Metoden returnerer basale oplysninger om enheder, der opfylder søgekriteriet.

Med udgangspunkt i en returneret sorCode og sorBasicType, kan den relevante ’get-metode’ efterfølgende kaldes for at hente yderligere oplysninger om den pågældende enhed.

Søgekriterier

XML navn Obligatorisk Beskrivelse
authentification Ja Brugernavn og Password
validityDate Ja Gyldighedsdatotid på formen ’ yyyy-mm-ddThh:mi:ss.nnnZ’
basicType Ja Den basale enhedstype i RSD-SOR. ”IE” for institutionsejer, ”SI” for sundhedsinstitution, ”OE” for organisatorisk enhed
unitType Ja EnhedsTypen. Enten en InstitutionOwnerType, en HealtInstitutionType, eller en OrganizationalUnitType, alt efter hvilken ’basicType’ der angives
EanLocationCode Nej* EAN lokationsnummer
Shak1Code Nej* SHAK1 kode (også kaldet SKS kode)
name Nej* Navn
postCodeId Nej* Postnummer. Der søges i enhedernes ’postalAddress’
phoneNumber Nej* Telefonummer

*) foruden de obligatorisk felter skal mindst ét af de øvrige felter udfyldes for at begrænse antallet af enheder, der matcher kriterierne.

Udtræksfelter

XML navn Beskrivelse Eksempel
sorCode Enhedens SOR code 16871000016001
sorName Enhedens navn Adam Pedersen
sorType Enhedstypen 0
sorBasicType Den basale enhedstype i RSD-SOR. ”IE” for institutionsejer, ”SI” for sundhedsinstitution, ”OE” for organisatorisk enhed ”OE”
ownerCode SOR code på parent/owner 16851000016008
ownerName Navn på parent/owner Adam Pedersen
ownerType Enhedstype på owner/parent 550891000005100
postalAddress Postadresse  


searchSorProvider

Metoden returnerer basale oplysninger om enheder, der har det ydernummer, der angives i søgekriteriet.

Med udgangspunkt i en returneret sorCode og sorBasicType, kan den relevante ’get-metode’ efterfølgende kaldes for at hente yderligere oplysninger om den pågældende enhed.

Søgekriterier

XML navn Beskrivelse
authentification Brugernavn og Password
validityDate Gyldighedsdatotid på formen ’ yyyy-mm-ddThh:mi:ss.nnnZ’
providerIdentifier Ydernummer

Udtræksfelter

XML navn Beskrivelse Eksempel
sorCode Enhedens SOR code 16871000016001
sorName Enhedens navn Adam Pedersen
sorType Enhedstypen 0
sorBasicType Den basale enhedstype i RSD-SOR. ”IE” for institutionsejer, ”SI” for sundhedsinstitution, ”OE” for organisatorisk enhed ”OE”
ownerCode SOR code på parent/owner 16851000016008
ownerName Navn på parent/owner Adam Pedersen
ownerType Enhedstype på owner/parent 550891000005100
postalAddress Postadresse  


updateSubscription

Metoden opretter eller opdaterer en enhed i brugerens abonnement. Hvis den pågældende ’sorCode’ ikke findes i abonnementet, tilføjes den, ellers opdateres værdien af ’withAllUnderlying’.

’withAllUnderlying’ indikerer om man ønsker at abonnere på alle enhedens ”børn” (nuværende og evt. fremtidlige).
Hvis man f.eks. angiver, at man vil abonnere på Sygehus Lillebælt (SOR code: 8061000016004) og alle underliggende enheder, vil man modtage opdateringer på alle Sygehus Lillebælts enheder (afdelinger, ambulatorier, afsnit, oa.).

Input

XML navn Beskrivelse
Authentification Brugernavn og Password
sorCode Den officielle SOR-code (fra SST)
withAllUnderlying Der abonneres på alle underliggende enheder. 1: Ja, 0: Nej

Output
Metoden returnerer ingen felter.

Returkoder

Metoderne kan returnere følgende koder:
0: ”OK”
1: "An internal error occurred."
2: "Unknown error."
3: "Unkown method call."
4: "Method not implemented yet."

20: "Authentification failed."
21: "Authentification not found."

30: "Unit (IE, SI, OE) not found."
31: "Too much data, please narrow search."

40: "The supplied 'Date' is invalid."
41: "The supplied 'BasicType' is invalid."
42: "The supplied 'UnitType' is invalid."
43: "The supplied 'ProviderId' is invalid."
44: "The supplied 'SorCode' is invalid."

60: "Subscription already exists."
61: "Subscription already exists through the units parent."
62: "Subscription does not exist."
63: "Subscription could not be updated."
64: "Subscriber could not be found."
65: "Subscriber have no subscriptions."

70: "Classification not found."

Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.