Versions Compared

Old Version 48

changes.mady.by.user Lene Andersen

Saved on

compared with

New Version 49

changes.mady.by.user Lene Andersen

Saved on

Key

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

Table of Contents


Komponenter

Dette dokument dækker følgende komponenter på NSP:

  • Dokumentregistrerings- og oprettelsesservice

  • Type: Webservice

  • Filnavn: dros.war

  • Url: <serverurl>/dros

  • Servicecheckurl: <serverurl>/dros/status

  • Versionurl: <serverurl>/dros/health returnerer en json struktur med denne

  • DKS config: <serverurl>/dros/<iti-snitflade>/dks se detaljer nedenfor

...

Konfiguration

Servicekonfiguration

Grundlæggende konfiguration foregår ved redigering i filen dros.properties,  der placeres i følgende WildFly modul:

/pack/wildfly8/modules/sds/dros/configuration/main/

Moduldefinitionen er at finde i sourcekoden til dros under:

/dros-war/etc/modules/sds/dros/configuration/main/module.xml

I filen skal følgende properties være definerede:

Property

Beskrivelse

dros.url.prefix

URL prefix der indsættes i wsdl'er og bruges af dks-servlet.

dros.app.nameAnvendes af dks-servlet til at udfylde name elementet sammen med et suffix for ITI endpointet.
Eksempel: hvis dros.app.name er "DROSAFTALER" bliver det "<name>DROSAFTALERITI41</name>" ved iti-41.
dros.serviceidentifier

Anvendes af dks-servlet. Inkluderes i action som en serviceIdentifier attribut.

Eksempel: hvis dros.serviceidentifier er "aftaler" bliver det "<action name="urn:ihe:iti:2007:ProvideAndRegisterDocumentSet-b" serviceIdentifier="aftaler">" ved iti-41.

iti41.service.endpoint

Endpoint på ITI41-backend.
iti41.service.security.require.person

Angiver, om der skal anvendes personlige sikkerhedsbillet i.e UserIdCard eller det er nok med SystemIdCard (true/false)

Default: false

iti41.service.xds.validationlevel

Angiver hvordan requestet valideres inden der kaldes videre til det bagvedliggende registry. Skal have en af værdierne OFF, WARNING, LOG og REJECT. Se dokumentet 'Design og Arkitektur' for en beskrivelse af disse værdier.

iti42.service.endpointEndpoint på ITI42-backend.
iti42.service.security.require.person

Angiver, om der skal anvendes personlige sikkerhedsbillet i.e UserIdCard eller det er nok med SystemIdCard (true/false)

Default: false

iti42.service.xds.validationlevelAngiver hvordan requestet valideres inden der kaldes videre til det bagvedliggende registry. Skal have en af værdierne OFF, WARNING, LOG og REJECT. Se dokumentet 'Design og Arkitektur' for en beskrivelse af disse værdier.

iti57.service.endpoint

Endpoint på ITI57-backend.
iti57.service.security.require.person

Angiver, om der skal anvendes personlige sikkerhedsbillet i.e UserIdCard eller det er nok med SystemIdCard (true/false)

Default: false

iti57.service.xds.validationlevelAngiver hvordan requestet valideres inden der kaldes videre til det bagvedliggende registry. Skal have en af værdierne OFF, WARNING, LOG og REJECT. Se dokumentet 'Design og Arkitektur' for en beskrivelse af disse værdier.
iti61.service.endpointEndpoint på ITI61-backend.
iti61.service.security.require.person

Angiver, om der skal anvendes personlige sikkerhedsbillet i.e UserIdCard eller det er nok med SystemIdCard (true/false)

Default: false

iti61.service.xds.validationlevelAngiver hvordan requestet valideres inden der kaldes videre til det bagvedliggende registry. Skal have en af værdierne OFF, WARNING, LOG og REJECT. Se dokumentet 'Design og Arkitektur' for en beskrivelse af disse værdier.

dros.backend.failure.threshold

Tærskel for, hvor mange gang i træk et kald til en backend må fejle, før denne backend betragtes som 'død' af status-siden.

dros.backend.failure.interval.minutesAngiver antal minutter hvorefter fejlkald 'forældes'. Dermed er det kun fejlkald, der er nyere end dette, der medregnes, når det vurderes om backenden fejler. 


personinformation.url

URL for PersonInformation service

Eksempel: http://test1-cnsp.ekstern-test.nspop.dk:8080/stamdata-personinformation/v1

personinformation.error.tolerance

Angiver hvor mange fejl, der må forekomme ved kald til personInformation

Default: 0

personinformation.error.interval.minutes

Angiver det tidsinterval det angivne antal fejl skal ligge indenfor ved kald til personInformation

Default: 10

sores.url

URL for Sores service

Eksempel: http://test1.ekstern-test.nspop.dk:8080/sores/v3

sores.cache.duration

Angiver en duration, hvor længe et Sores opslag skal gemmes i Sores cachen, inden man henter en ny værdi ved næste opslag på et givet Sor nummer

Eksempel: PT24 gemmer et Sores opslag 24 timer

sores.error.tolerance

Angiver hvor mange fejl, der må forekomme ved kald til Sores

Default: 0

sores.error.interval.minutes

Angiver det tidsinterval det angivne antal fejl skal ligge indenfor ved kald til Sores

Default: 10

httpclient.pooling.totalconnections

Konfiguration af client pool til kald af personInformation og Sores

Default: 200

httpclient.pooling.maxconnections.pr.route

Konfiguration af client pool til kald af PersonInformation og Sores

Default: 20

handled.type.codes

Angiver en liste af, hvilke type codes DROS håndterer. Er listen tom (property findes, men ingen værdi efter =) accepteres alle type codes.

Eksempel på liste: 39289-4,39290-2,53576-5,52460-3,81215-6

Default: tom liste

 

For alle nedenstående properties, som starter med validation. og slutter på .codes gælder følgende:

Disse properties anvendes til at konfigurerer XDS validerings biblioteket med.

En kode består af 3 elementer: value, system og displayname. Disse adskilles med $. Hver sæt af koder adskilles med #. 

Der er muligt at angive wildcards og det kan man gøre på to niveauer:

  • Indenfor et sæt kan man angive "null" hvis man tillader alle værdier for et specifikt element
    F.eks. fra class codes nedenfor: validation.class.codes=null$1.2.208.184.100.9$null#. Her er der kun krav til "system" værdien.
  • Hvis en kode tillader alle værdier, kan det angives med værdien "*", ved at lade listen være tom  eller ved slet ikke at angive propertien i property filen.
    F.eks. fra format codes nedenfor: validation.format.codes=*. Her kan alle format codes anvendes.
validation.class.codes

Angiv tilladte class koder

Eksempel: null$1.2.208.184.100.9$null#
Alle class koder fra systemet 1.2.208.184.100.9 er tilladste.

validation.confidentiality.codes

Angiv tilladte confidentiality codes. Typisk kun N

Eksempel: N$2.16.840.1.113883.5.25$null#
Classcode N fra systemet 2.16.840.1.113883.5.25 tilladt.

validation.organisation.codes

Angiv tilladte organizations koder. Her angives typisk kun skema.

Eksempel:  null$1.2.208.176.1.4$null#null$1.2.208.176.1.1$null#
Organizationskoder fra system 1.2.208.176.1.4 eller 1.2.208.176.1.1 er tilladte, som er Yder og SOR

validation.patientid.codes

Angiv tilladte patientid. Her angives typisk kun skema.

Eksempel: null$1.2.208.176.1.2$null#
Patientider fra systemet 1.2.208.176.1.2 er tilladte, som er CPR.

validation.format.codes

Angive tilladte format koder

Eksempel: *
Alle format koder er tilladte

validation.healthcarefacilitytype.codes

Angive tilladte healthcarefacilitytype koder

Eksempel: *
Alle healthcarefacilitytype koder er tilladate

validation.practicesetting.codes

Angiv tilladte practicesetting koder

Eksempel: *
Alle practicesetting koder er tilladte

validation.event.codes

Angiv tilladte event koder

Eksempel: null$1.2.208.176.2.4$null#
Alle event koder fra systemet 1.2.208.176.2.4 er tilladte

validation.type.codes

Angiv tilladte type koder. Valideringsbiblioteket anvender denne til at tjekke om typecode i metadata (i documententry og cda dokument hvis parset) er en gyldig værdi

Eksempel: 39289-4$2.16.840.1.113883.6.1$null#
Type koden 39289-4 fra systemet 2.16.840.1.113883.6.1 er tilladt.

validation.cda.type.codes

Angiv de type koder, som er af typen CDA.
Dette har betydning for validering af et ITI-41 kald. Hvis et dokuments har en af disse type koder angivet i metadata vil det tilhørenende dokument blive parset som CDA og valideret tilsvarende.

Eksempel: 39289-4$2.16.840.1.113883.6.1$null#

validation.personinformation.enabled

Angiver om DocumentEntryPatientIdExistsValidator skal kalde PatientInformation for at validere at Cpr nummer findes.

Default: true

validation.sores.enabled

Angiver om DocumentEntryAuthorInstitutionSorEnricher skal kalde Sores for at validere at Sor koder findes.

Default: true

log4j konfiguration

Log4j konfiguration findes i samme wildfly modul som servicekonfigurationen

Se yderligere opsætning i installationsvejledningen.

DKS snitflader

DROS har en DKS snitflade per iti kald:

  • <serverurl>/dros/iti41/dks 
  • <serverurl>/dros/iti42/dks
  • <serverurl>/dros/iti42noDgws/dks
  • <serverurl>/dros/iti57/dks
  • <serverurl>/dros/iti61/dks

...

Code Block
titleMed serviceIdentifier
collapsetrue
<?xml version="1.0" encoding="UTF-8"?>
<root xmlns="http://nspop.dk/2014/04" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://nspop.dk/2014/04 dks.xsd">
  <dksVersion>1</dksVersion>
  <timestamp>2025-04-01T13:34:15+0200</timestamp>
  <name>DROSAFTALERITI41</name>
  <endpoint>http://localhost:8060/dros_aftaler/iti41</endpoint>
  <operations>
    <action name="DocumentRepository_ProvideAndRegisterDocumentSet" serviceIdentifier="aftaler">
      <model>synchronous_timeout</model>
      <timeoutMillis>120000</timeoutMillis>
      <idCardLevel>VOCES</idCardLevel>
    </action>
  </operations>
</root>


Overvågning

DROS udstiller en overvågningsside, som findes i listen af komponenter i afsnit 2.

Fortolkning af HTML overvågningsside

DROS-overvågningssiden returnerer enten:

  • HTTP 200, hvis servicen i øjeblikket kører fint.
  • HTTP 203, hvis der er opstået en fejl der kræver indgriben.
  • HTTP 500, hvis der er opstået en fejl der kræver indgriben.

Overvågningstyper

Det overvåges for hver backend, om kaldene til backenden går galt. Det kan konfigureres, hvor mange kald i træk der må gå galt, før en backend betragtes som 'død'.

Eksempler på status-sider

200 OK

200 OK
---------------------------------------
STATUS

...

Hvis kaldene til personInformation eller Sores backend ikke kan udføres, så returneres statuskode 203 (indenfor failure threshold (tolerance og minutter), som kan sættes op som en konfigurationsparameter, se ovenfor).

500 Internal Server Error

...

Ved CPR validering af ugyldige (ifølge PersonInformation service) CPR numre vil dette give anledning til en linje i auditloggen. Logninger af denne type ser således ud:

...

Hvis servicesvaret indeholder fejl, logges de på følgende måde. Hvis et RequestId mangler, genereres et nyt RequestId.

Følgende er et eksempel på et ITI-42 kald med, fejl. 

Code Block
titleAuditlog for Registry Error
collapsetrue
{
  "time": "2022-12-13T07:28:59.135Z",
  "category": "dk.sds.nsp.audit.log.dros/provideandregisterdocumentsetb",
  "audit": {
    "timestamp": "2022-12-13T08:28:58.815+01:00",
    "components": [
      {
        "component": "DROS/ProvideAndRegisterDocumentSetB",
        "contexts": [
          {
            "context": "8808456705936797445.7367161746361332136.1670916538706",
            "information": [
              {
                "key": "Warning",
                "type": "RPI",
                "value": "ErrorInfo[errorCode=REGISTRY_METADATA_ERROR,codeContext=Source patient id i det leverede CDA dokument matcher ikke souce patient id i document entry,severity=WARNING,location=,customErrorCode=]"
              },
              {
                "key": "Warning",
                "type": "RPI",
                "value": "ErrorInfo[errorCode=REGISTRY_METADATA_ERROR,codeContext=Patient id i det leverede CDA dokument matcher ikke patient id i document entry,severity=WARNING,location=,customErrorCode=]"
              },
              {
                "key": "Warning",
                "type": "RPI",
                "value": "ErrorInfo[errorCode=REGISTRY_METADATA_ERROR,codeContext=Service stop time i det leverede CDA dokument matcher ikke service stop time i document entry,severity=WARNING,location=,customErrorCode=]"
              },
              {
                "key": "Warning",
                "type": "RPI",
                "value": "ErrorInfo[errorCode=REGISTRY_METADATA_ERROR,codeContext=Author institution i det leverede CDA dokument matcher ikke author institution i document entry,severity=WARNING,location=,customErrorCode=]"
              },
              {
                "key": "Warning",
                "type": "RPI",
                "value": "ErrorInfo[errorCode=REGISTRY_METADATA_ERROR,codeContext=Cda dokumentet har ikke lovlig type,severity=WARNING,location=,customErrorCode=]"
              },
              {
                "key": "Warning",
                "type": "RPI",
                "value": "ErrorInfo[errorCode=REGISTRY_METADATA_ERROR,codeContext=Creationtime i det leverede CDA dokument matcher ikke creationtime i document entry,severity=WARNING,location=,customErrorCode=]"
              },
              {
                "key": "Warning",
                "type": "RPI",
                "value": "ErrorInfo[errorCode=REGISTRY_METADATA_ERROR,codeContext=Title i det leverede CDA dokument matcher ikke title i document entry,severity=WARNING,location=,customErrorCode=]"
              },
              {
                "key": "Warning",
                "type": "RPI",
                "value": "ErrorInfo[errorCode=REGISTRY_METADATA_ERROR,codeContext=Confidentiality code i det leverede CDA dokument matcher ikke code i document entry,severity=WARNING,location=,customErrorCode=]"
              },
              {
                "key": "Warning",
                "type": "RPI",
                "value": "ErrorInfo[errorCode=REGISTRY_METADATA_ERROR,codeContext=Coded value i det leverede CDA dokument matcher ikke type code i document entry,severity=WARNING,location=,customErrorCode=]"
              },
              {
                "key": "Warning",
                "type": "RPI",
                "value": "ErrorInfo[errorCode=REGISTRY_METADATA_ERROR,codeContext=Source patient birth i det leverede CDA dokument matcher ikke source patient birth i document entry,severity=WARNING,location=,customErrorCode=]"
              },
              {
                "key": "Warning",
                "type": "RPI",
                "value": "ErrorInfo[errorCode=REGISTRY_METADATA_ERROR,codeContext=Service start time i det leverede CDA dokument matcher ikke service start time i document entry,severity=WARNING,location=,customErrorCode=]"
              },
              {
                "key": "Warning",
                "type": "RPI",
                "value": "ErrorInfo[errorCode=REGISTRY_METADATA_ERROR,codeContext=Author person i det leverede CDA dokument matcher ikke author institution i document entry,severity=WARNING,location=,customErrorCode=]"
              },
              {
                "key": "Warning",
                "type": "RPI",
                "value": "ErrorInfo[errorCode=REGISTRY_METADATA_ERROR,codeContext=Author.Person skal være angivet i documententry,severity=WARNING,location=,customErrorCode=]"
              },
              {
                "key": "StatusCode",
                "type": "RPI",
                "value": "urn:oasis:names:tc:ebxml-regrep:ResponseStatusType:Success"
              },
              {
                "key": "ResponseError",
                "type": "RPI",
                "value": "RegistryError[value=<null>,codeContext=Source patient id i det leverede CDA dokument matcher ikke souce patient id i document entry,errorCode=XDSRegistryMetadataError,severity=urn:oasis:names:tc:ebxml-regrep:ErrorSeverityType:Warning,location=]"
              },
              {
                "key": "ResponseError",
                "type": "RPI",
                "value": "RegistryError[value=<null>,codeContext=Patient id i det leverede CDA dokument matcher ikke patient id i document entry,errorCode=XDSRegistryMetadataError,severity=urn:oasis:names:tc:ebxml-regrep:ErrorSeverityType:Warning,location=]"
              },
              {
                "key": "ResponseError",
                "type": "RPI",
                "value": "RegistryError[value=<null>,codeContext=Service stop time i det leverede CDA dokument matcher ikke service stop time i document entry,errorCode=XDSRegistryMetadataError,severity=urn:oasis:names:tc:ebxml-regrep:ErrorSeverityType:Warning,location=]"
              },
              {
                "key": "ResponseError",
                "type": "RPI",
                "value": "RegistryError[value=<null>,codeContext=Author institution i det leverede CDA dokument matcher ikke author institution i document entry,errorCode=XDSRegistryMetadataError,severity=urn:oasis:names:tc:ebxml-regrep:ErrorSeverityType:Warning,location=]"
              },
              {
                "key": "ResponseError",
                "type": "RPI",
                "value": "RegistryError[value=<null>,codeContext=Cda dokumentet har ikke lovlig type,errorCode=XDSRegistryMetadataError,severity=urn:oasis:names:tc:ebxml-regrep:ErrorSeverityType:Warning,location=]"
              },
              {
                "key": "ResponseError",
                "type": "RPI",
                "value": "RegistryError[value=<null>,codeContext=Creationtime i det leverede CDA dokument matcher ikke creationtime i document entry,errorCode=XDSRegistryMetadataError,severity=urn:oasis:names:tc:ebxml-regrep:ErrorSeverityType:Warning,location=]"
              },
              {
                "key": "ResponseError",
                "type": "RPI",
                "value": "RegistryError[value=<null>,codeContext=Title i det leverede CDA dokument matcher ikke title i document entry,errorCode=XDSRegistryMetadataError,severity=urn:oasis:names:tc:ebxml-regrep:ErrorSeverityType:Warning,location=]"
              },
              {
                "key": "ResponseError",
                "type": "RPI",
                "value": "RegistryError[value=<null>,codeContext=Confidentiality code i det leverede CDA dokument matcher ikke code i document entry,errorCode=XDSRegistryMetadataError,severity=urn:oasis:names:tc:ebxml-regrep:ErrorSeverityType:Warning,location=]"
              },
              {
                "key": "ResponseError",
                "type": "RPI",
                "value": "RegistryError[value=<null>,codeContext=Coded value i det leverede CDA dokument matcher ikke type code i document entry,errorCode=XDSRegistryMetadataError,severity=urn:oasis:names:tc:ebxml-regrep:ErrorSeverityType:Warning,location=]"
              },
              {
                "key": "ResponseError",
                "type": "RPI",
                "value": "RegistryError[value=<null>,codeContext=Source patient birth i det leverede CDA dokument matcher ikke source patient birth i document entry,errorCode=XDSRegistryMetadataError,severity=urn:oasis:names:tc:ebxml-regrep:ErrorSeverityType:Warning,location=]"
              },
              {
                "key": "ResponseError",
                "type": "RPI",
                "value": "RegistryError[value=<null>,codeContext=Service start time i det leverede CDA dokument matcher ikke service start time i document entry,errorCode=XDSRegistryMetadataError,severity=urn:oasis:names:tc:ebxml-regrep:ErrorSeverityType:Warning,location=]"
              },
              {
                "key": "ResponseError",
                "type": "RPI",
                "value": "RegistryError[value=<null>,codeContext=Author person i det leverede CDA dokument matcher ikke author institution i document entry,errorCode=XDSRegistryMetadataError,severity=urn:oasis:names:tc:ebxml-regrep:ErrorSeverityType:Warning,location=]"
              },
              {
                "key": "ResponseError",
                "type": "RPI",
                "value": "RegistryError[value=<null>,codeContext=Author.Person skal være angivet i documententry,errorCode=XDSRegistryMetadataError,severity=urn:oasis:names:tc:ebxml-regrep:ErrorSeverityType:Warning,location=]"
              }
            ]
          },
          {
            "context": "urn:uuid:dfae887b-d846-4f2d-88b0-fd11a603e03e",
            "information": [
              {
                "key": "DocumentId",
                "type": "RPI",
                "value": "5345652789622024422.1649135652318592037.1670916538701"
              },
              {
                "key": "DocumentType",
                "type": "RPI",
                "value": "39289-4"
              },
              {
                "key": "CitizenId",
                "type": "RPI",
                "value": "ABCDE"
              },
              {
                "key": "FormatCode",
                "type": "RPI",
                "value": "urn:ad:dk:medcom:appointmentsummary:full"
              },
              {
                "key": "SubmissionSetId",
                "type": "RPI",
                "value": "8808456705936797445.7367161746361332136.1670916538706"
              },
              {
                "key": "AuthorInstitutionAssigningAuthority",
                "type": "RPI",
                "value": "1.2.208.176.1.1"
              },
              {
                "key": "AuthorInstitutionId",
                "type": "RPI",
                "value": "12345679999"
              }
            ]
          }
        ]
      }
    ]
  },
  "access": {
    "code": 200,
    "duration": 289,
    "httpHeaders": {
      "Content-Type": "multipart/related; type=\"application/xop+xml\"; boundary=\"uuid:c16b15ce-c994-4ac7-8ed0-d949fa6099d5\"; start=\"<root.message@cxf.apache.org>\"; start-info=\"application/soap+xml\""
    },
    "httpHost": "localhost",
    "idCardAttributes": {
      "medcom:CareProviderID": "46837428",
      "medcom:CareProviderName": "Statens Serum Institut",
      "medcom:ITSystemName": "Test",
      "sosi:AuthenticationLevel": "3",
      "sosi:IDCardID": "91WKulz0p7X1tHDPo1MqAA==",
      "sosi:IDCardType": "system",
      "sosi:IDCardVersion": "1.0.1"
    },
    "method": "POST",
    "path": "/dros/iti41",
    "query": "",
    "port": 8060,
    "protocol": "http",
    "reqSize": 25133,
    "resSize": 4268,
    "soapHeaders": {
      "Issuer": "TEST2-NSP-STS",
      "MessageID": "AAABhQpjAVUdbZI6x+gtGFNPU0k=",
      "NameID": "SubjectDN={SERIALNUMBER=CVR:46837428-UID:27910135 + CN=Statens Serum Institut - Test VOCES, O=Statens Serum Institut // CVR:46837428, C=DK},IssuerDN={CN=TRUST2408 Systemtest XXXIV CA, O=TRUST2408, C=DK},CertSerial={1604144225}",
      "w3Action": "urn:ihe:iti:2007:ProvideAndRegisterDocumentSet-b",
      "w3MessageID": "urn:uuid:d8bf3c51-b16a-42af-b4ef-023dbc52051f",
      "w3To": "http://localhost:8060/dros/iti41"
    },
    "threadId": "default task-9",
    "time": "2022-12-13T08:28:58.815+01:00",
    "stats": {
      "handlerDuration": 28,
      "RequestContentDuration": 2,
      "ResponseContentDuration": 0,
      "SecurityProtocolRequestDuration": 22,
      "SecurityProtocolResponseDuration": 0,
      "bufferAllocated": false,
      "usedBuffers": 4,
      "activeBuffersInPool": 4,
      "idleBuffersInPool": 4
    }
  }
}

Whitelisting af anvendere

De enkelte anvendere skal whitelistes til at bruge DROS. Der findes en tabel whitelist til dette formål. 

Det er heri muligt at angive enten et CVR nummer eller oces3 UUID. Sidstnævnte whitelister et specifikt certifikat.

Organisationens CVR nummer whitelistes ved følgende SQL:

INSERT INTO whitelist (whitelistkey, whitelisttype, note) VALUES ('46837428', 'cvr', 'Oprettet fra supportsag ASCP00155779');

Certifikatets UUID id whitelistes ved følgende SQL:

INSERT INTO whitelist (whitelistkey, whitelisttype, note) VALUES ('UI:DK-O:G:8d3fa047-c77e-47e4-bdd2-e91488610ce6', 'cert', 'Oprettet fra supportsag ASCP00155779');

...