Page History
...
| Table of Contents | ||
|---|---|---|
|
Releases
En oversigt over de forskellige releases, og eventuelle kommentare omkring disse:
...
Release af version 2 af WSDL
Version 1 af WSDL er stadig aktiv, men opgradering til version 2 er anbefalet
...
-------------------------------------------------------------------------------- DOKUMENTATION UNDER OPDATERING --------------------------------------------------------------------------------
Releases
En oversigt over de forskellige releases, og eventuelle kommentare omkring disse:
| Release | Kommentar |
|---|---|
| 1.1 | Release af version 3 af WSDL Version 1 og version 2 er fjernet |
| 1.0 | Release af version 1 af WSDL |
Neden for kan dokumentationen for de aktive WSDL versioner findes.
Version 3
Nyeste version af systemet.
Endpoint
Opdater servicen kan tilgås på adressen:
[miljø url]/sor-opdatering/v3/SOROpdateringService
For eksempel, på TEST1-miljøet vil det være:
http://test1-cnsp.ekstern-test.nspop.dk:8080/sor-opdatering/v3/SOROpdateringService
WSDL filen for servicen kan hentes ved at tilføje "?wsdl" til enden af URL'en.
Snitfladebeskrivelser
Fælles
Sikkerhed
Fælles for hele servicen, er at der bliver benyttet Den Gode Webservice (DGWS) til authentifikering, og der accepteres kun niveau 3 (VOCES og FOCES) eller 4 (MOCES) ID kort udstedt af SOSI-STS. Selvom at niveau 3 både indeholder FOCES og VOCES, så er det kun FOCES som er tilladt.
Namespaces
Alle kald til servicen vil benytte typer defineret under namespacet:
http://sundhedsdatastyrelsen.dk/SOROpdateringService/2019/10/08/
Alle typer benyttet i parametre og resultater i disse kald er defineret under namespacet:
Koder
Flere felter benytter koder frem for tekst strenge til at signalere over for servicen, hvilken type enhed der er ønsket at blive oprettet, eller hvor at enheden er placeret. Eksempel på sådan er SystemTypeIdentifier under EanLocationCodeEntityType. Koderne for disse kan findes her:
http://filer.nsi.dk/sor/lookupdata/
Gyldighed
I de kald hvor at SorEntityType bliver returneret, der er den returnerede version ikke den gyldige version af enheden. Den returnerede version er hvad der vil blive gyldigt i fremtiden (tidligst dagen efter).
AddressInformationType
| Element | Data type | Beskrivelse |
|---|---|---|
| AdditionalAddressInformationText | string | |
| AddressPostal | AddressPostalType | |
| InheritanceIndicator | boolean | |
| SkipAddressValidation | boolean | |
| MunicipalityCode | string | |
| StreetCode | string | |
| RegionName | string | |
| CoordETRS89z32NMeasure | decimal | |
| CoordETRS89z32EMeasure | decimal |
AddressPostalType
| Element | Data type | Beskrivelse |
|---|---|---|
| StreetName | string | |
| StreetBuildingIdentifier | string | |
| FloorIdentifier | string | |
| SuiteIdentifier | string | |
| PostOfficeBoxIdentifier | string | |
| PostCodeIdentifier | string | |
| DistrictName | string | |
| CountryIdentificationCode | CountryIdentificationCodeType |
ArrayOfLong
| Element | Data type | Beskrivelse |
|---|---|---|
| long | Liste af long |
ArrayOfPrioritizedEntitySpecialityType
| Element | Data type | Beskrivelse |
|---|---|---|
| PrioritizedEntitySpecialityType | Liste af PrioritizedEntitySpecialityType |
ArrayOfReplacingInfoType
| Element | Data type | Beskrivelse |
|---|---|---|
| ReplacingInfoType | Liste af ReplacingInfoType |
ArrayOfSorSecurityGroupExternalType
| Element | Data type | Beskrivelse |
|---|---|---|
| SorSecurityGroupExternalType | Liste af SorSecurityGroupExternalType |
CountryIdentificationCodeType
| Element | Data type | Beskrivelse |
|---|---|---|
| Scheme | CountryIdentificationSchemeType | |
| Value | string |
CountryIdentificationSchemeType
| Element | Data type | Beskrivelse |
|---|---|---|
| string | Enumeration af landekode identifikations systemer. Kan have en af følgende værdier:
|
EanLocationCodeEntityType
| Element | Data type | Beskrivelse |
|---|---|---|
| EanLocationCode | long | |
| OnlyInternalIndicator | boolean | |
| NonActiveIndicator | boolean | |
| SystemSupplierIdentifier | long | |
| CommunicationSupplierIdentifier | long | |
| SystemTypeIdentifier | long | |
| EdiAdministratorIdentifier | long | |
| SorNote | string | |
| SorStatus | SorStatusType | |
| RegionCode | string |
EanLocationCodeStateType
| Element | Data type | Beskrivelse |
|---|---|---|
| string | Enumeration af nedarving status for lokationsnumre. Kan have en af følgende værdier:
|
LocalAttributeCollectionType
| Element | Data type | Beskrivelse |
|---|---|---|
| LocalAttribute1 | string | |
| LocalAttribute2 | string | |
| LocalAttribute3 | string | |
| LocalAttribute4 | string | |
| LocalAttribute5 | string |
PrioritizedEntitySpecialityType
| Element | Data type | Beskrivelse |
|---|---|---|
| SpecialityIdentifier | long | |
| SpecialityPriorityIdentifier | long |
ReplacingInfoType
| Element | Data type | Beskrivelse |
|---|---|---|
| Name | string | |
| SorId | long | |
| Date | date |
SorEntityType
| Element | Data type | Beskrivelse |
|---|---|---|
| SorIdentifier | long | |
| SorType | SorTypeType | |
| SorStatus | SorStatusType | |
| GeographicalLocalisationIdentifier | long | |
| GeographicalLocalisationName | string | |
| HasGeographicalLocalisation | boolean | |
| ParentSorIdentifier | long | |
| ActivityAddressInformation | AddressInformationType | |
| VisitingAddressInformation | AddressInformationType | |
| PostalAddressInformation | AddressInformationType | |
| PharmacyIdentifier | string | |
| EntityName | string | |
| EntityTypeIdentifier | long | |
| VirtualAddressInformation | VirtualAddressInformationType | |
| ReportingLevelIndicator | boolean | |
| LocalAttributeCollection | LocalAttributeCollectionType | |
| LocalCode | string | |
| EanLocationCodeState | EanLocationCodeStateType | |
| EanLocationCodeEntity | EanLocationCodeEntityType | |
| PatientsAdmittedIndicator | boolean | |
| AmbulantActivityIndicator | boolean | |
| ShakIdentifier | string | |
| PrioritizedEntitySpecialityCollection | ArrayOfPrioritizedEntitySpecialityType | |
| ProviderIdentifier | string | |
| CvrNumberIdentifier | string | |
| ProductionUnitIdentifier | string | |
| ReplacedByEntityCollection | ArrayOfReplacingInfoType | |
| ReplacesEntityCollection | ArrayOfReplacingInfoType |
SorSecurityGroupExternalType
| Element | Data type | Beskrivelse |
|---|---|---|
| string | Enumeration af security groups. Kan have en af følgende værdier:
|
SorStatusType
| Element | Data type | Beskrivelse |
|---|---|---|
| FromDate | date | |
| ToDate | date | |
| UpdatedAt | date | |
| FirstFromDate | date |
SorTypeType
| Element | Date type | Beskrivelse |
|---|---|---|
| string | Enumeration af SOR typer. Kan have en af følgende værdier:
|
StatusType
| Element | Data type | Beskrivelse |
|---|---|---|
| ErrorCode | int | |
| ErrorMessage | string |
VirtualAddressInformationType
| Element | Data type | Beskrivelse |
|---|---|---|
| InheritanceIndicator | boolean | |
| EmailAddressIdentifier | string | |
| Website | string | |
| TelephoneNumber | string | |
| FaxNumberIdentifier | string |
...
Version 2
Nyeste version af systemet, og anbefalet for nye klienter at integrere med.
...
- Request og response bliver indpakket af et ekstra objekt, for at servicen behøver mindre operation specifik kode (quality of life ændring for fremtidig udvikling)
- Ryddet op i XSD filer, således at det muligt nu kun at udstille de som en klient af servicen skal bruge, uden også at udstille de typer som bruges mod interne SOR systemer
- MoveSorEntity returnerer nu ikke længere SorEntity
- Ændringer i nogle af de SDS producerede XSD filer, således at null værdier er tilladt
- Felterne CommunicationSupplierType og SystemSupplierType er blevet fjernet fra SorEntity
Endpoint
Opdater servicen kan tilgås på adressen:
[miljø url]/sor-opdatering/v2/SOROpdateringService
For eksempel, på TEST1-miljøet vil det være:
http://test1-cnsp.ekstern-test.nspop.dk:8080/sor-opdatering/v2/SOROpdateringService
...
Snitfladebeskrivelser
Fælles
Sikkerhed
Fælles for hele servicen, er at der bliver benyttet Den Gode Webservice (DGWS) til authentifikering, og der accepteres kun niveau 3 (VOCES og FOCES) eller 4 (MOCES) ID kort udstedt af SOSI-STS. Selvom at niveau 3 både indeholder FOCES og VOCES, så er det kun FOCES som er tilladt.
Namespaces
Alle kald til servicen vil benytte typer defineret under namespacet:
...
Alle typer hentet eksternt fra er ikke angivet i dette dokument, da listen så vil blive meget lang.
Koder
Flere felter benytter koder frem for tekst strenge til at signalere over for servicen, hvilken type enhed der er ønsket at blive oprettet, eller hvor at enheden er placeret. Eksempler på sådanne er SystemTypeIdentifier under EanLocationCodeEntityType, eller RegionCode under de forskellige adresse typer (aktivitet, post, of visitation). Koderne for disse kan findes her:
http://filer.nsi.dk/sor/lookupdata/
Gyldighed
I de kald hvor at SorEntity bliver returneret, der er den returnerede version ikke den gyldige version af enheden. Den returnerede version er hvad der vil blive gyldigt i fremtiden (tidligst dagen efter).
...
| Element | Data type | Beskrivelse |
|---|---|---|
| Roles | ArrayOfSorSecurityGroupsExternalType | Liste af sikkerheds grupper som skal bruges under autoriseringen af et kald. Hvert type af kald har sin type som er nødvendigt, for at kunne udføre operationen. Afsenders CVR nummer skal være knyttet til den afsendte gruppe. |
| Entities | SorIdentifierCollectionType | Liste af SOR-ID'er hvis træer som afsenderen har adgang til at redigere i. Indholdet bruges kun under autorisering af CreateSorEntity, EditSorEntity, MoveSorEntity, ReplaceSorEntities, og CloseSorEntity. |
StatusType
| Element | Data type | Beskrivelse |
|---|---|---|
| ErrorCode | int | Hvis kaldet var en succes, så vil denne have værdien 0. Ved validerings fejl, så vil denne have en positiv værdi. Ved Tekniske og praktiske fejl, så vil denne have en negativ værdi. |
| Message | string | Hvis ErrorCode er 0, er dette felt tomt. Ellers indeholder den en kort beskrivelse af, hvilken fejl der skete. |
...
| Element | Data type | Beskrivelse |
|---|---|---|
| SorSecurityGroupsExternal | En liste af SorSecurityGroupExternalType | Security groups |
SorSecurityGroupExternalType
| Element | Data type | Beskrivelse |
|---|---|---|
| string | Enumeration af security groups. Kan have en af følgende værdier:
|
...
| Element | Data type | Beskrivelse |
|---|---|---|
| EanLocationCode | Liste af long (EanLocationCode) | Lokationsnumre |
SorTypeType
| Element | Data type | Beskrivelse |
|---|---|---|
| string | Enumeration af SOR typer. Kan have en af følgende værdier:
|
SorEntityType
| Element | Data type | Beskrivelse |
|---|---|---|
| SorIdentifier | Long (SorIdentifierType) | Unik nøgle der identificerer en SOR enhed |
| SorType | SorTypeType | SOR-type |
| SorStatus | SorStatusType | Angiver SOR enhedens status |
| GeographicalLocalisationIdentifier | Long (GeographicalLocalisationIdentifierType) | Id på den geografiske lokation. Bruges kun til output. |
| GeographicalLocalisationName | String (GeographicalLocalisationNameType) | Navn på den geografiske lokation. Bruges kun til output. |
| HasGeographicalLocalisation | Boolean | Angiver om SOR enheden har en geografisk lokation, skal være false eller tom hvis SOR typen er IO. Vil altid returneres som false. |
| ParentSorIdentifier | Long (SorIdentifierType) | Forældre SOR-id, skal være 0 eller tom hvis SOR typen er IO |
| ActivityAddressInformation | AddressInformationType | Aktivitetsadressen, skal være tom hvis SOR typen er IO eller HI |
| VisitingAddressInformation | AddressInformationType | Besøgsadressen, skal være tom hvis SOR typen er IO |
| PostalAddressInformation | AddressInformationType | Postadressen |
| PharmacyIdentifier | String (PharmacyIdentifierType) | SOR-enhedens apoteksnummer, skal være tom hvis SOR typen er IO |
| EntityName | String (SorNameType) | SOR Enhedens navn |
| EntityTypeIdentifier | Long (EntityTypeIdentifier) | Teknisk nøgle for EntityType (SNOMED Concept Id) |
| VirtualAddressInformation | VirtualAddressInformationType | Angiver enhedens hjemmesideadresse, email, telefonnummer og faxnummer |
| ReportingLevelIndicator | Boolean (ReportingLevelIndicator) | Angiver om enheden er indberetningsniveau til Landspatientregisteret (LPR2), skal være false eller tom hvis SOR typen er IO eller HI |
| LocalAttributeCollection | LocalAttributeCollectionType | Der kan være op til 5 lokale attributter, skal være tom hvis SOR typen er IO eller HI |
| LocalCode | String (LocalCodeType) | SOR-enhedens lokale kode, skal være tom hvis SOR typen er IO eller HI. Attribut der frit kan benyttes af anvender organisationen. |
| EanLocationCodeState | EanLocationCodeStateType | Angiver om lokationsnummer er nedarvet fra den hierarkiske mor. Kan være 'own', 'inherited' eller 'none'. |
| EanLocationCodeEntity | EanLocationCodeEntityType | Angiver lokationsnummeret på SOR enheden |
| PatientsAdmittedIndicator | Boolean (PatientsAdmittedIndicator) | Angiver om enheden er et sengeafsnit, skal være false eller tom hvis SOR typen er IO eller HI |
| AmbulantActivityIndicator | Boolean (AmbulantActivityIndicator) | Angiver om enheden er et ambulatorie, skal være false eller tom hvis SOR typen er IO eller HI |
| ShakIdentifier | String (ShakIdentifierType) | Angiver hvilken sygehusafdelingskode, der er knyttet til SORenheden. Den samme sygehusafdelingskode kan være knyttet til mere end én SORenhed. Der kan kun registreres officielle sygehusafdelingskoder. Skal være tom hvis SOR typen er IO. |
| PrioritizedEntitySpecialityCollection | PrioritizedEntitySpecialityCollectionType | Liste af SOR enhedens kliniske specialer. Der kan angives op til 8, hvoraf nr. 1 er hovedspecialet. Skal være tom hvis SOR typen er IO eller HI. |
| ProviderIdentifier | String (ProviderIdentifierType) | SOR-enhedens ydernummer, skal være tom hvis SOR typen er IO eller HI |
| CVRnumberIdentifier | String (CVRnumberIdentifierType) | CVR nummer for SOR-enheden. Obligatorisk hvis SOR typen er IO. Skal være tom hvis SOR typen er HI eller OU. |
| ProductionUnitIdentifier | String (ProductionUnitIdentifierType) | P nummer for SOR-enheden, skal være tom hvis SOR typen er IO |
EanLocationCodeStateType
| Element | Data type | Beskrivelse |
|---|---|---|
| string | Enumeration af stadier. Kan have en af følgende værdier:
|
EanLocationCodeEntityType
| Element | Data type | Beskrivelse |
|---|---|---|
| EanLocationCode | Long (EanLocationCode) | Lokationsnummer |
| OnlyInternalIndicator | Boolean (OnlyInternalIndicator) | Angiver om lokationsnummeret er til internt brug |
| NonActiveIndicator | Boolean (NonActiveIndicator) | Angiver om lokationsnummeret er ikke-aktivt |
| SystemSupplierIdentifier | Long (SystemSupplierType) | Systemleverandør-id |
| CommunicationSupplierIdentifier | Long (CommunicationSupplierType) | Netoperatør-id |
| SystemTypeIdentifier | Long (SystemTypeIdentifier) | EDB-system-id |
| EdiAdministratorIdentifier | Long (EdiAdministratorIdentifier) | EDI-Administrator-id |
| SorNote | String (SorNoteType) | Angiver eventuelle bemærkninger til lokationsnummeret |
| SorStatus | SorStatusType | Angiver SOR enhedens status |
| RegionCode | String (AuthorityCodeType) | Regionens kode, f.eks. 1084 for RegionHovedstaden |
...
Disse ændringer er allerede udført i WSDL og XSD filerne leveret af projektet, og ingen ændringer er nødvendige fra anvenders side. Denne sektion er kun til information.
AddressInformationType
Namespace: urn:oio:nsi:2.0.0
...
WSDL filen for servicen kan hentes ved at tilføje "?wsdl" til enden af URL'en.
Snitfladebeskrivelser
Fælles
Sikkerhed
Fælles for hele servicen, er at der bliver benyttet Den Gode Webservice (DGWS) til authentifikering, og der accepteres kun niveau 3 (VOCES og FOCES) eller 4 (MOCES) ID kort udstedt af SOSI-STS. Selvom at niveau 3 både indeholder FOCES og VOCES, så er det kun FOCES som er tilladt.
Namespaces
Alle kald til servicen vil benytte typer defineret under namespacet:
...
Alle typer hentet eksternt fra er ikke angivet i dette dokument, da listen så vil blive meget lang.
Koder
Flere felter benytter koder frem for tekst strenge til at signalere over for servicen, hvilken type enhed der er ønsket at blive oprettet, eller hvor at enheden er placeret. Eksempler på sådanne er SystemTypeIdentifier under EanLocationCodeEntityType, eller RegionCode under de forskellige adresse typer (aktivitet, post, of visitation). Koderne for disse kan findes her:
http://filer.nsi.dk/sor/lookupdata/
Gyldighed
I de kald hvor at SorEntity bliver returneret, der er den returnerede version ikke den gyldige version af enheden. Den returnerede version er hvad der vil blive gyldigt i fremtiden (tidligst dagen efter).
...