Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents
excludeIndholdsfortegnelse

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:

ReleaseKommentar
1.1

Release af version 3 af WSDL

Version 1 og version 2 er fjernet

1.0Release 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:

SOR.Services.SOAPServices.V3

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

ElementData typeBeskrivelse
AdditionalAddressInformationTextstring
AddressPostalAddressPostalType
InheritanceIndicatorboolean
SkipAddressValidationboolean
MunicipalityCodestring
StreetCodestring
RegionNamestring
CoordETRS89z32NMeasuredecimal
CoordETRS89z32EMeasuredecimal

AddressPostalType

ElementData typeBeskrivelse
StreetNamestring
StreetBuildingIdentifierstring
FloorIdentifierstring
SuiteIdentifierstring
PostOfficeBoxIdentifierstring
PostCodeIdentifierstring
DistrictNamestring
CountryIdentificationCodeCountryIdentificationCodeType

ArrayOfLong

ElementData typeBeskrivelse
longListe af long

ArrayOfPrioritizedEntitySpecialityType

ElementData typeBeskrivelse
PrioritizedEntitySpecialityTypeListe af PrioritizedEntitySpecialityType

ArrayOfReplacingInfoType

ElementData typeBeskrivelse
ReplacingInfoTypeListe af ReplacingInfoType

ArrayOfSorSecurityGroupExternalType

ElementData typeBeskrivelse
SorSecurityGroupExternalTypeListe af SorSecurityGroupExternalType

CountryIdentificationCodeType

ElementData typeBeskrivelse
SchemeCountryIdentificationSchemeType
Valuestring

CountryIdentificationSchemeType

ElementData typeBeskrivelse

string

Enumeration af landekode identifikations systemer. Kan have en af følgende værdier:

  • iso3166-alpha2
  • iso3166-alpha3
  • un-numeric3
  • imk

EanLocationCodeEntityType

ElementData typeBeskrivelse
EanLocationCodelong
OnlyInternalIndicatorboolean
NonActiveIndicatorboolean
SystemSupplierIdentifierlong
CommunicationSupplierIdentifierlong
SystemTypeIdentifierlong
EdiAdministratorIdentifierlong
SorNotestring
SorStatusSorStatusType
RegionCodestring

EanLocationCodeStateType

ElementData typeBeskrivelse

string

Enumeration af nedarving status for lokationsnumre. Kan have en af følgende værdier:

  • Undefined
  • None
  • Inherited
  • Own

LocalAttributeCollectionType

ElementData typeBeskrivelse
LocalAttribute1string
LocalAttribute2string
LocalAttribute3string
LocalAttribute4string
LocalAttribute5string

PrioritizedEntitySpecialityType

ElementData typeBeskrivelse
SpecialityIdentifierlong
SpecialityPriorityIdentifierlong

ReplacingInfoType

ElementData typeBeskrivelse
Namestring
SorIdlong
Datedate

SorEntityType

ElementData typeBeskrivelse
SorIdentifierlong
SorTypeSorTypeType
SorStatusSorStatusType
GeographicalLocalisationIdentifierlong
GeographicalLocalisationNamestring
HasGeographicalLocalisationboolean
ParentSorIdentifierlong
ActivityAddressInformationAddressInformationType
VisitingAddressInformationAddressInformationType
PostalAddressInformationAddressInformationType
PharmacyIdentifierstring
EntityNamestring
EntityTypeIdentifierlong
VirtualAddressInformationVirtualAddressInformationType
ReportingLevelIndicatorboolean
LocalAttributeCollectionLocalAttributeCollectionType
LocalCodestring
EanLocationCodeStateEanLocationCodeStateType
EanLocationCodeEntityEanLocationCodeEntityType
PatientsAdmittedIndicatorboolean
AmbulantActivityIndicatorboolean
ShakIdentifierstring
PrioritizedEntitySpecialityCollectionArrayOfPrioritizedEntitySpecialityType
ProviderIdentifierstring
CvrNumberIdentifierstring
ProductionUnitIdentifierstring
ReplacedByEntityCollectionArrayOfReplacingInfoType
ReplacesEntityCollectionArrayOfReplacingInfoType

SorSecurityGroupExternalType

ElementData typeBeskrivelse

string

Enumeration af security groups. Kan have en af følgende værdier:

  • SorCentralRole
  • SorDecentralRole
  • SorEditorRole
  • SorGeoRole
  • SorShakRole
  • SorEdiCentralRole
  • SorEdiAdminRole
  • SorMoveEanRole

SorStatusType

ElementData typeBeskrivelse
FromDatedate
ToDatedate
UpdatedAtdate
FirstFromDatedate

SorTypeType

ElementDate typeBeskrivelse

string

Enumeration af SOR typer. Kan have en af følgende værdier:

  • IO
  • HI
  • OU

StatusType

ElementData typeBeskrivelse
ErrorCodeint
ErrorMessagestring

VirtualAddressInformationType

ElementData typeBeskrivelse
InheritanceIndicatorboolean
EmailAddressIdentifierstring
Websitestring
TelephoneNumberstring
FaxNumberIdentifierstring

...


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).

...

ElementData typeBeskrivelse
RolesArrayOfSorSecurityGroupsExternalTypeListe 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.
EntitiesSorIdentifierCollectionTypeListe 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

ElementData typeBeskrivelse
ErrorCodeintHvis 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.
MessagestringHvis ErrorCode er 0, er dette felt tomt. Ellers indeholder den en kort beskrivelse af, hvilken fejl der skete.

...

ElementData typeBeskrivelse
SorSecurityGroupsExternal

En liste af SorSecurityGroupExternalType

Security groups

SorSecurityGroupExternalType

ElementData typeBeskrivelse

string

Enumeration af security groups. Kan have en af følgende værdier:

  • SorCentralRole
  • SorDecentralRole
  • SorEditorRole
  • SorGeoRole
  • SorShakRole
  • SorEdiCentralRole
  • SorEdiAdminRole
  • SorMoveEanRole

...

ElementData typeBeskrivelse
EanLocationCodeListe af long (EanLocationCode)Lokationsnumre

SorTypeType

ElementData typeBeskrivelse

string

Enumeration af SOR typer. Kan have en af følgende værdier:

  • IO
  • HI
  • OU

SorEntityType

ElementData typeBeskrivelse
SorIdentifierLong (SorIdentifierType)Unik nøgle der identificerer en SOR enhed
SorTypeSorTypeTypeSOR-type
SorStatusSorStatusTypeAngiver SOR enhedens status
GeographicalLocalisationIdentifierLong (GeographicalLocalisationIdentifierType)Id på den geografiske lokation. Bruges kun til output.
GeographicalLocalisationNameString (GeographicalLocalisationNameType)Navn på den geografiske lokation. Bruges kun til output.
HasGeographicalLocalisationBooleanAngiver om SOR enheden har en geografisk lokation, skal være false eller tom hvis SOR typen er IO. Vil altid returneres som false.
ParentSorIdentifierLong (SorIdentifierType)Forældre SOR-id, skal være 0 eller tom hvis SOR typen er IO
ActivityAddressInformationAddressInformationTypeAktivitetsadressen, skal være tom hvis SOR typen er IO eller HI
VisitingAddressInformationAddressInformationTypeBesøgsadressen, skal være tom hvis SOR typen er IO
PostalAddressInformationAddressInformationTypePostadressen
PharmacyIdentifierString (PharmacyIdentifierType)SOR-enhedens apoteksnummer, skal være tom hvis SOR typen er IO
EntityNameString (SorNameType)SOR Enhedens navn
EntityTypeIdentifierLong (EntityTypeIdentifier)Teknisk nøgle for EntityType (SNOMED Concept Id)
VirtualAddressInformationVirtualAddressInformationTypeAngiver enhedens hjemmesideadresse, email, telefonnummer og faxnummer
ReportingLevelIndicatorBoolean (ReportingLevelIndicator)Angiver om enheden er indberetningsniveau til Landspatientregisteret (LPR2), skal være false eller tom hvis SOR typen er IO eller HI
LocalAttributeCollectionLocalAttributeCollectionTypeDer kan være op til 5 lokale attributter, skal være tom hvis SOR typen er IO eller HI
LocalCodeString (LocalCodeType)SOR-enhedens lokale kode, skal være tom hvis SOR typen er IO eller HI. Attribut der frit kan benyttes af anvender organisationen.
EanLocationCodeStateEanLocationCodeStateTypeAngiver om lokationsnummer er nedarvet fra den hierarkiske mor. Kan være 'own', 'inherited' eller 'none'.
EanLocationCodeEntityEanLocationCodeEntityTypeAngiver lokationsnummeret på SOR enheden
PatientsAdmittedIndicatorBoolean (PatientsAdmittedIndicator)Angiver om enheden er et sengeafsnit, skal være false eller tom hvis SOR typen er IO eller HI
AmbulantActivityIndicatorBoolean (AmbulantActivityIndicator)Angiver om enheden er et ambulatorie, skal være false eller tom hvis SOR typen er IO eller HI
ShakIdentifierString (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.
PrioritizedEntitySpecialityCollectionPrioritizedEntitySpecialityCollectionTypeListe 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.
ProviderIdentifierString (ProviderIdentifierType)SOR-enhedens ydernummer, skal være tom hvis SOR typen er IO eller HI
CVRnumberIdentifierString (CVRnumberIdentifierType)CVR nummer for SOR-enheden. Obligatorisk hvis SOR typen er IO. Skal være tom hvis SOR typen er HI eller OU.
ProductionUnitIdentifierString (ProductionUnitIdentifierType)P nummer for SOR-enheden, skal være tom hvis SOR typen er IO

EanLocationCodeStateType

ElementData typeBeskrivelse

string

Enumeration af stadier. Kan have en af følgende værdier:

  • Undefined
  • None
  • Inherited
  • Own

EanLocationCodeEntityType

ElementData typeBeskrivelse
EanLocationCodeLong (EanLocationCode)Lokationsnummer
OnlyInternalIndicatorBoolean (OnlyInternalIndicator)Angiver om lokationsnummeret er til internt brug
NonActiveIndicatorBoolean (NonActiveIndicator)Angiver om lokationsnummeret er ikke-aktivt
SystemSupplierIdentifierLong (SystemSupplierType)Systemleverandør-id
CommunicationSupplierIdentifierLong (CommunicationSupplierType)Netoperatør-id
SystemTypeIdentifierLong (SystemTypeIdentifier)EDB-system-id
EdiAdministratorIdentifierLong (EdiAdministratorIdentifier)EDI-Administrator-id
SorNoteString (SorNoteType)Angiver eventuelle bemærkninger til lokationsnummeret
SorStatusSorStatusTypeAngiver SOR enhedens status
RegionCodeString (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).

...