Page History
Tjek relevant overordnede dele er til stede i input (så validatorer ikke behøver blive negative, hvis de ikke er)
Indhold:
Table of Contents |
---|
...
På NSP deles i dag CDA dokumenter vha. en XDS infrastruktur. Et CDA dokumenter dokument er et struktureret XML dokument, som følger en bestemt standard for kliniske dokumenter. Der findes forskellige typer af CDA dokumenter. Medcom har lavet de , hvor der er lavet danske profileringer (Udgivelser), som dækker typernefølgende:
- Appointment Document (APD) til aftaler
- Careplan (CPD)
- Personal Data Card/Stamkort (PDC)
- Personal Health Monitoring Report (PHMR) til hjemmemonitorering
- Questionnaire Form Definition Document (QFDD) og Questionnaire Response Document (QRD) til patientrapporterede oplysninger (PRO)
Fælles for alle dokumenterne er en et fælles CDA header format, der indeholder metadata om dokumentet. Denne skal overholde Medcoms standard standarden for den danske profilering af metadata (XDS Metadata for Document Sharing. Danish profile). Ligesom data i headeren skal findes i Medcoms den fælles liste over tilladet værdisæt (DK-IHE_Metadata-Common_Code_systems-Value_sets).
Dokumenter, som gemmes i XDS infrasktrukturen, registreres under deres metadata - herunder dokumentid, og kan fremsøges ud fra disse igen. Det registerede metadata er underlagt samme standarder, som CDA dokumenterne selv er, dvs. de skal overholde Medcoms de danske standarder.
For at gemme eller hente et dokument, anvendet et ITI kald. ITI kald er standardiserede SOAP services, der overholder IHE XDS specifikationen. Et ITI kald opererer med begreberne SubmissionSet, DocumentEntry og Association, hvis indhold lægger sig op af dokumentets metadata. Disse skal derfor også overholde standarderne.
For yderligere Yderligere detaljer og introduktion til dokumentdeling læskan læses i Dokumentdeling på NSP.
For at lette arbejdet med at overholde/validerere for standarderne, findes XdsValidation biblioteket. DROS komponenten gør kan gøre brug af denne validering, for at sikre, at der ikke komme ugyldige data ind i XDS infrastrukturen. Anvendere af DROS kan selv implementere validering vha. af XdsValidation biblioteket, hvis man ønsker at finde " fejl" , inden det faktisk faktiske kald udføres. Alle, der er koblet på NSP XDS infrastrukturen med enten registry eller repository eller som har sit eget affinitetsdomæne, kan med fordel anvende XdsValiderings biblioteket. Også som supplement til eventuel egen validering.
XdsValiderings biblioteket er under fortsat udvikling. Se afsnittet "Understøttede valideringsreglerXdsValiderings biblioteket er under fortsat udvikling. Se afsnittet "Understøttede valideringsregler" for den nuværende implementering.
For at anvende XdsValidation biblioteket, skal man gøre brug af tredjepartsproduktet IPF Open eHealth Integration Platform, da interaktionen foregår vha. dette.
Da DROS, som nævnt gør brug af XdsValidation, kan man her finde yderligere inspiration for implementering , hvis man som ekstern anvender ønsker at gøre brug af XDS valideringder. Dette dokument beskriver overordnet tilgængelighed funktionalitet af modulet samt anvendelsebiblioteket.
API Beskrivelse og anvendelse
...
En almindelig validering. Den består af en validering, samt mulighed for at angive " under-validatorerer" validatorer samt indikation af, om disse " under-validatorer " skal køresudføres, hvis dens validatorens egen validering fejler.
Man kan altså med denne validator gruppere en række valideringer, som man ønskes ønsker udført efter hinanden, baseret på validatorens eget udfald. Den almindelige validatorer validator returner så, den fulde mængde af resultater/fejl fundet.
Et eksempel på sådan en validering er Apd2StartStopTimeValidator. Den tjekker på om ServiceStartTime på et aftaledokument er udfyldt, Den har ikke nogen " under-validatorer " i default opsætningen for ITI41 kaldet. Men på sigt kunne disse tilføjes, hvis der opstår behov for specifikke regler omkring StartTime valideringen, når den er udfyldt. Se følgende eksempel:
...
AtLeastOneValidator
Denne validator har lidt mere logik end en almindelig validator: Den kræver, at mindst een af dens under-validatorer vil kendes ved det input, den får, for at AtLeastOneValidatoren selv validerer noget ok.
Man kan altså med denne validator gruppere en række valideringer, og forvente, at mindst een af dem vil kendes ved det input, den får. Den/de " under-validering" validatorer, som kendes ved input, forventes så at udføre relevant validering.
Et eksempel på sådan en validering er CdaDocumentTypeValidator. Den er default konfigureret med en række " under-validatorer" , der hver især kan håndtere en dokument type. Aktiveres CdaDocumentTypeValidator på et dokument, vil den " under-validator" , der kendes ved dokumenttypen, sørge for at validere specifikke regler for denne type. Kendes ingen af " under-validatorne" validatorerne ved dokumentindholdet/typen, vil AtLeastOneValidatoren melde en fejl retur. Se følgende eksempel:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
//validering hvor CdaDocumentTypeValidator forventer at ens af dens under-validatorer vil kendes ved input (dokumentet) CdaDocumentTypeValidator cdaDocumentTypeValidator = new CdaDocumentTypeValidator(); CdaDocumentApdV2ModelEnricher cdaDocumentApdV2ModelEnricher = new CdaDocumentApdV2ModelEnricher(); cdaDocumentTypeValidator.appendValidator(cdaDocumentApdV2ModelEnricher); CdaDocumentPhmrModelEnricher cdaDocumentPhmrModelEnricher = new CdaDocumentPhmrModelEnricher(); cdaDocumentTypeValidator.appendValidator(cdaDocumentPhmrModelEnricher); CdaDocumentQrdModelEnricher cdaDocumentQrdModelEnricher = new CdaDocumentQrdModelEnricher(); cdaDocumentTypeValidator.appendValidator(cdaDocumentQrdModelEnricher); |
Det som kendetegner en almindelig AtLeastOne validator er extension af klassen AbstractAtLeastOneValidatorImpl.
...
Dette er ikke en egentlig validator. "Valideringen" består af udpakning af noget input.
Så Man kan se, det er en indirekte validering af, at input forståes forstås og forbedring/berigelse af det data, der arbejdes på. Denne " berigelse " sættes på det indkomne objekt (deraf ModelEnricher) og senere validatorer, kan så arbejde herpåvidere med dette.
Man kan på denne en ModelEnricher også sættes "sætte under-validatorer " på, ligesom på en almindelig validator.
Et eksempel på sådan en ModelEnricher er CdaDocumentApdV2ModelEnricher. Den er default konfigureret på CdaDocumentTypeValidator (se ovenfor for en AtLeastOneValidator) og modtager et CDA dokument, som den forsøger at pakke ud til et aftaledokument. Lykkedes dette, kalder den sine " under-validatorer " som validerer aftale specikke regler.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
//validering, hvor CdaDocumentApdV2ModelEnricher forventes at pakke input ud og forstå at det er et aftale dokument. CdaDocumentApdV2ModelEnricher cdaDocumentApdV2ModelEnricher = new CdaDocumentApdV2ModelEnricher(); Apd2StartStopTimeValidator apd2StartStopTimeValidator = new Apd2StartStopTimeValidator(); cdaDocumentApdV2ModelEnricher.appendValidator(apd2StartStopTimeValidator); Apd2AppointmentIdValidator apd2AppointmentIdValidator = new Apd2AppointmentIdValidator(); cdaDocumentApdV2ModelEnricher.appendValidator(apd2AppointmentIdValidator); Apd2CustodianIdValidator apd2CustodianIdValidator = new Apd2CustodianIdValidator(organisationCodeValidation); cdaDocumentApdV2ModelEnricher.appendValidator(apd2CustodianIdValidator); |
Det som kendetegner en almindelig validator ModelEnricher er extension af klassen AbstractModelEnricherImpl.
...
Denne minder om en ModelEnricher, men adskiller sig ved, at den ikke modtager det fælles objekt XDSDocument, som de andre validatorer arbejder med. Den modtager derimod en request type, som pakkes ud i et eller flere XDSDocument objekter, og Starter kører så sine under-validatorer på hver af disse objekter.
Alle valideringer starter derfor med en Starter validering, og al anden validering bygges herpå. Se eksempelvis ProvideAndRegisterDocumentSetStarter for et fuldt eksempel.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
//validering, hvor det hele initiers med en Starter validering til et iti 41 kald ProvideAndRegisterDocumentSetStarter provideAndRegisterDocumentSetStarter = new ProvideAndRegisterDocumentSetStarter(); |
Det som kendetegner en almindelig validator Starter er extension af klassen AbstractStarterImpl.
...
Principperne for oprettelse af validerings regler valideringsregler og sammensætning af disse i struktur er, kan skitseres ved:
- Start med en Starter, som forstår input
- Berig input efterhånden som behovet opstår
- Valider kun data, som er relevant. Dvs. anvend træstrukturer
- Tjek relevante overordnede dele er til stede i input (sådan at øvrige senere validatorer kan tillade sig at ignorere dette)
- Er input "uforståligt" så returner ingen ting
- Er input "forståligt" men forkert så returner fejl
Alle ITI kalds default valideringer, som er konfigureret i XdsValidation biblioteket, er sat op efter følgende struktur:
- Den tilhørende starter vælges (Starter)
- En struktur validator tilknyttes (Validator), som sikrer at et kald indeholder de komponenter, det skal (eksempel for ITI 41 documententry, assocation og selve dokumentet)
- Alle andre relevante validatorer tilføjes, for . For ITI 41 drejer det sig om følgende træstruktur:
- XDSDocumentContentModelEnricher (ModelEnricher), der pakker input ud som UTF8 bytes hvis muligt
- XDSDocumentValidator (AtLeastOneValidator) og CdaDocumentHeaderModelEnricher, som forventer at kunne pakke input ud som et CDA dokument ved at finde en CDA header
- CdaDocumentTypeValidator (AtLeastOneValidator) og CdaDocumentApdV2ModelEnricher, CdaDocumentPhmrModelEnricher samt CdaDocumentQrdModelEnricher, der forventer, at dokumentet er af en af typerne APD, PHMR eller QRD
- Felt specifikke validatorer (Validator) for hver af de 3 dokument typer
- CdaDocumentTypeValidator (AtLeastOneValidator) og CdaDocumentApdV2ModelEnricher, CdaDocumentPhmrModelEnricher samt CdaDocumentQrdModelEnricher, der forventer, at dokumentet er af en af typerne APD, PHMR eller QRD
- XDSDocumentValidator (AtLeastOneValidator) og CdaDocumentHeaderModelEnricher, som forventer at kunne pakke input ud som et CDA dokument ved at finde en CDA header
- Felt specifikke validatorer (Validator) for documentEntry
- Felt specifikke validatorer (Validator) for SubmissionSet
- Sammenlignings validatorer per felt (Validator), der sikrer DocumentEntry og SubmissionSet indeholder samme værdier
- Sammenlignings validatorer per felt (Validator), der sikrer DocumentEntry og dokumentets CDA header indeholder samme værdier
- XDSDocumentContentModelEnricher (ModelEnricher), der pakker input ud som UTF8 bytes hvis muligt
Hver ITI kald har sin kombination, da ikke alle elementer er til stede, i de forskellige kald. F.eks, har er et ITI 41 kald det eneste kald, som har et faktisk dokument, der kan valideres.
En grafisk præsentation af denne konfiguration af default validering kan ses i Design og arkitektur dokumentet.
Eksempel fra DROS
For at gøre brug af xdsValidation skal følgende dependencies tilføjes til maven pom fil:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<dependency>
<groupId>dk.nsp</groupId>
<artifactId>validation-xds</artifactId>
</dependency> |
Hvis man ikke allerede anvender IPF Open eHealth Integration Platform skal følgende dependency tilføjes
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<dependency>
<groupId>org.openehealth.ipf.commons</groupId>
<artifactId>ipf-commons-ihe-xds</artifactId>
<version>${openehealth.version}</version>
</dependency>
<!-- openehealth.version bør være samme version som XDSValidation anvender --> |
Følgende kode er taget fra DROS's validerings logik for ITI 41 kald.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
// Fra klassen Iti41ValidationImpl metode validateAndTransform
List<ErrorInfo> xdsValidationErrors = getXdsValidationErrors(provideAndRegisterDocumentSet, xdsValidatorFactory.buildIti41Validator(), xdsValidationLevel);
// Fra klassen RegistryItiValidationImpl
protected List<ErrorInfo> getXdsValidationErrors(ProvideAndRegisterDocumentSet request, ProvideAndRegisterDocumentSetStarter starter, XdsValidationLevel xdsValidationLevel) {
return getXdsValidationErrors(() -> starter.validate(request), xdsValidationLevel);
}
private List<ErrorInfo> getXdsValidationErrors(Supplier<ValidationResultSet> validator, XdsValidationLevel xdsValidationLevel) {
if(xdsValidationLevel == XdsValidationLevel.OFF) {
return new ArrayList<>();
}
List<ErrorInfo> errors = new ArrayList<>();
// Perform the validation
ValidationResultSet resultSet = validator.get();
// Construct the result
if(resultSet.hasErrors()) {
// Based on the validation level, either return a warning or an error.
Severity severity = getSeverity(xdsValidationLevel);
for(ValidationError ve : resultSet.getErrors()) {
ErrorInfo errorInfo = new ErrorInfo(ErrorCode.REGISTRY_METADATA_ERROR, ve.getErrorMessage(), severity, "", "");
errors.add(errorInfo);
}
}
return errors;
}
|
Dvs ønsker man benytte default valideringen for ITI 41 kaldet gøres det ved at:
- Oprette en instans af ProvideAndRegisterDocumentSetStarter (linie 2)
- Kalde metoden validate på denne med ITI 41 requested (ProvideAndRegisterDocumentSet) (linie 6)
- Retur får man en liste over de fejl XdsValidation fandt (linie 15)
På samme måde kan man få valideret de øvrige kald, ved at vælge den rette Starter og sende requsted ind til den.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
// Fra klassen Iti42ValidationImpl metode validateAndTransform
List<ErrorInfo> xdsValidationErrors = getXdsValidationErrors(registerDocumentSet, xdsValidatorFactory.buildIti42Validator(), xdsValidationLevel);
// Fra klassen RegistryItiValidationImpl
protected List<ErrorInfo> getXdsValidationErrors(RegisterDocumentSet request, RegisterDocumentSetStarter starter, XdsValidationLevel xdsValidationLevel) {
return getXdsValidationErrors(() -> starter.validate(request), xdsValidationLevel); //for getXdsValidationErrors se ovenfor
}
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
// Fra klassen Iti57ValidationImpl metode validateAndTransform
List<ErrorInfo> xdsValidationErrors = getXdsValidationErrors(registerDocumentSet, xdsValidatorFactory.buildIti61Validator(), xdsValidationLevel);
// Fra klassen RegistryItiValidationImpl
protected List<ErrorInfo> getXdsValidationErrors(RegisterDocumentSet request, RegisterDocumentSetStarter starter, XdsValidationLevel xdsValidationLevel) {
return getXdsValidationErrors(() -> starter.validate(request), xdsValidationLevel); //for getXdsValidationErrors se ovenfor
}
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
// Fra klassen Iti41ValidationImpl metode validateAndTransform
List<ErrorInfo> xdsValidationErrors = getXdsValidationErrors(registerDocumentSet, xdsValidatorFactory.buildIti57Validator(), xdsValidationLevel);
// Fra klassen RegistryItiValidationImpl
protected List<ErrorInfo> getXdsValidationErrors(RegisterDocumentSet request, RegisterDocumentSetStarter starter, XdsValidationLevel xdsValidationLevel) {
return getXdsValidationErrors(() -> starter.validate(request), xdsValidationLevel); //for getXdsValidationErrors se ovenfor
} |
Se iøvrigt praktisk anvendelse i bibliotekets egne unit test. F.eks. CdaHeaderValidatorTest der viser CDA dokument validering og ProvideAndRegisterDocumentSetValidatorTest, der viser en række kald for iti-41.
Understøttede valideringsregler
De implementerede valideringsregler er lavet med udgangspunkt i Medcoms standarder og IHE XDS specifikationen.
De refereres som følger:
- (IHE 4.2.3.1.2 Creating Coded Attributes): IHE XDS specfikiationen afsnit 4.2.3.1.2
- (DK_IHE_ClassCode_DE): Medcoms fælles liste over tilladet værdisæt faneblad ClassCode_DE
- (Metadata-v096 2.2.3 classCode): Medsoms danske CDA profil afsnit 2.2.3
- (DK-APD-v2.0: 2.1.10.1 Appointment Date and Time): Medcoms Appointment Document (APD) til aftaler afsnit 2.1.10.1
For nu er følgende valideringer implementeret:
(nedenstående beskrivelse stammer fra javadoc i mvn modul validation-xds og validation-codes. Teksten skal vedligeholdes der. Anvend "mvn javadoc:javadoc -pl \!validation-cda-dependencies " for at generere i target/site folderne)
Default validering konfiguration
Der kan med fordel tages udgangspunkt i disse konfigurerede valideringer
...
Validering af struktur
Dette er validering, som har med struktur at gøre. F.eks. udpakning af information og forventninger til del elementer.
Afkrydningen i tabellens 5 sidste søjler indikerer, om en given validering er inkluderet i default valideringer, som er konfigureret i XdsValidation biblioteket.
...
- submissionSet pakkes ud
- dokumenter pakkes ud
- der skal som minimum være eet dokument
...
- der findes dokumenter
- der findes et doucmentEntry
- der findes et fysisk dokument
- der findes et submissionSet
...
- tjek det er et aftale dokument: CodeCodedValue har Codesystem "2.16.840.1.113883.6.1" og code "39289-4"
- tjek det er Cda Header Version 2: FormatCode har Codesystem "1.2.208.184.100.10" og code "urn:ad:dk:medcom:apd-v2.0.1:full"
- CDA dokumentet parses som et APD dokument
...
Hvordan ændrer man default valideringen
Hvis man ønsker, at ændre i den måde, default valideringen er sat op i XdsValidation biblioteket, enten ved at fjerne valideringsregler eller udvide med sine egne, kan det gøres ved at kopiere den default validering, man ønsker ændret og lave sine justeringer (fjerne eller tilføje regler). Alternativt, hvis man ønsker at lave "strengere" regler på udvalgte områder, kan man udføre default valideringen, og så yderligere have en validering, som alene består af egne valideringsregler (med relevante Starter og ModelEnricher).
Et konkret eksempel kan være ændring af en ITI 41 kaldets validering, sådan at startTime for aftaler bliver mere specifik (F.eks at tiden skal være i "fremtiden"). Dette kunne gøres som følger:
- Udvikling af egen udvidede validering i klassen Apd2StartStopTimeSpecifikValueValidator (en almindelig validator vil her være passende som skabelon)
- Lave en kopi af klassen Iti41ValidationFactory som Iti41ValidationFactoryExtended
- Tilføj egen validering (se eksemplet ovenfor i afsnit 2.1 for "fremtidigt eksempel med yderligere validering"
- Der, hvor man normalt ville bruge Iti41ValidationFactory.createIti41Validator anvender man istedet Iti41ValidationFactoryExtended.createIti41Validator.
Har man brug for at kunne lave sin egen enricher, og tilhørende opbevaring til en validator senere i flowet kan man gøre følgende
- Opret en klasse, som beskriver det objekt man gerne vil have enricheren til at enriche til
- Opret en enricher i stil med f.eks. CdaDocumentPhmrModelEnricher
- Dens enrich metode skal modtage XDSDocument som input
- Den skal oprette et beriget objekt (punkt 1) og tilføje det til XDSDocument som en "enrichment".
- Lav de yderligere relevante validatorer, som validererer dette ny enriched object
Kombiner ekisterende og nye enrichere og validatorer i en ValidationFactory som beskrevet i afsnittet tidligere.
Code Block language java title Eksempel på anvendelse af eget format public static final EnrichmentKey<MyTestDocument> ENRICHMENT_MY_TEST_DOCUMENT = EnrichmentKey.create(MyTestDocument.class); public class MyTestDocument { private String somefield1; private String somefield2; } public class MyTestDocumentModelEnricher extends AbstractModelEnricherImpl<XDSDocument> implements Validator<XDSDocument> { @Override protected ValidationResultSet enrich(XDSDocument input) { ValidationResultSet validationResultSet = new ValidationResultSet(); MyTestDocument myTestClass = new MyTestDocument(); // lav logik som tager relevant indhold fra XDSDocument og pakker det om til MyTestDocument // opstår der fejl kan de returneres i validationResultSet xdsDocument.setEnrichment(ENRICHMENT_MY_TEST_DOCUMENT, myTestClass); return validationResultSet; } } public class MyTestDocumentSomeField1Validator extends AbstractValidatorImpl<XDSDocument> { @Override protected ValidationResultSet validateInternal(XDSDocument input) { if (input == null || input.getEnrichment(ENRICHMENT_MY_TEST_DOCUMENT) == null) { return null; } ValidationResultSet validationResultSet = new ValidationResultSet(); // lav logik til validering af input.getEnrichment(ENRICHMENT_MY_TEST_DOCUMENT).getSomeField1(); // hvis fejl returneres de i validationResultSet; return validationResultSet; } }
Eksempel fra DROS
For at gøre brug af xdsValidation skal følgende dependencies tilføjes til maven pom fil:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<dependency>
<groupId>dk.nsp</groupId>
<artifactId>validation-xds</artifactId>
</dependency> |
Hvis man ikke allerede anvender IPF Open eHealth Integration Platform skal følgende dependency tilføjes
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<dependency>
<groupId>org.openehealth.ipf.commons</groupId>
<artifactId>ipf-commons-ihe-xds</artifactId>
<version>${openehealth.version}</version>
</dependency>
<!-- openehealth.version bør være samme version som XDSValidation anvender --> |
Følgende kode er taget fra DROS's validerings logik for ITI 41 kald.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
// Fra klassen Iti41ValidationImpl metode validateAndTransform
List<ErrorInfo> xdsValidationErrors = getXdsValidationErrors(provideAndRegisterDocumentSet, xdsValidatorFactory.buildIti41Validator(), xdsValidationLevel);
// Fra klassen RegistryItiValidationImpl
protected List<ErrorInfo> getXdsValidationErrors(ProvideAndRegisterDocumentSet request, ProvideAndRegisterDocumentSetStarter starter, XdsValidationLevel xdsValidationLevel) {
return getXdsValidationErrors(() -> starter.validate(request), xdsValidationLevel);
}
private List<ErrorInfo> getXdsValidationErrors(Supplier<ValidationResultSet> validator, XdsValidationLevel xdsValidationLevel) {
if(xdsValidationLevel == XdsValidationLevel.OFF) {
return new ArrayList<>();
}
List<ErrorInfo> errors = new ArrayList<>();
// Perform the validation
ValidationResultSet resultSet = validator.get();
// Construct the result
if(resultSet.hasErrors()) {
// Based on the validation level, either return a warning or an error.
Severity severity = getSeverity(xdsValidationLevel);
for(ValidationError ve : resultSet.getErrors()) {
ErrorInfo errorInfo = new ErrorInfo(ErrorCode.REGISTRY_METADATA_ERROR, ve.getErrorMessage(), severity, "", "");
errors.add(errorInfo);
}
}
return errors;
}
//Klassen XdsValidatorFactory
public class XdsValidatorFactory {
public ProvideAndRegisterDocumentSetStarter buildIti41Validator() {
return Iti41ValidationFactory.createIti41Validator();
}
public RegisterDocumentSetStarter buildIti42Validator() {
return Iti42ValidationFactory.createIti42Validator();
}
public RegisterDocumentSetStarter buildIti57Validator() {
return Iti57ValidationFactory.createIti57Validator();
}
public RegisterDocumentSetStarter buildIti61Validator() {
return Iti61ValidationFactory.createIti61Validator();
}
} |
Dvs ønsker man benytte default valideringen for ITI 41 kaldet gøres det ved at:
- Oprette en instans af ProvideAndRegisterDocumentSetStarter (linie 2)
- Kalde metoden validate på denne med ITI 41 requested (ProvideAndRegisterDocumentSet) (linie 6)
- Retur får man en liste over de fejl XdsValidation fandt (linie 15)
På samme måde kan man få valideret de øvrige kald, ved at vælge den rette Starter og sende requsted ind til den.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
// Fra klassen Iti42ValidationImpl metode validateAndTransform
List<ErrorInfo> xdsValidationErrors = getXdsValidationErrors(registerDocumentSet, xdsValidatorFactory.buildIti42Validator(), xdsValidationLevel);
// Fra klassen RegistryItiValidationImpl
protected List<ErrorInfo> getXdsValidationErrors(RegisterDocumentSet request, RegisterDocumentSetStarter starter, XdsValidationLevel xdsValidationLevel) {
return getXdsValidationErrors(() -> starter.validate(request), xdsValidationLevel); //for getXdsValidationErrors se ovenfor
}
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
// Fra klassen Iti57ValidationImpl metode validateAndTransform
List<ErrorInfo> xdsValidationErrors = getXdsValidationErrors(registerDocumentSet, xdsValidatorFactory.buildIti61Validator(), xdsValidationLevel);
// Fra klassen RegistryItiValidationImpl
protected List<ErrorInfo> getXdsValidationErrors(RegisterDocumentSet request, RegisterDocumentSetStarter starter, XdsValidationLevel xdsValidationLevel) {
return getXdsValidationErrors(() -> starter.validate(request), xdsValidationLevel); //for getXdsValidationErrors se ovenfor
}
|
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
// Fra klassen Iti41ValidationImpl metode validateAndTransform
List<ErrorInfo> xdsValidationErrors = getXdsValidationErrors(registerDocumentSet, xdsValidatorFactory.buildIti57Validator(), xdsValidationLevel);
// Fra klassen RegistryItiValidationImpl
protected List<ErrorInfo> getXdsValidationErrors(RegisterDocumentSet request, RegisterDocumentSetStarter starter, XdsValidationLevel xdsValidationLevel) {
return getXdsValidationErrors(() -> starter.validate(request), xdsValidationLevel); //for getXdsValidationErrors se ovenfor
} |
Se iøvrigt praktisk anvendelse i bibliotekets egne unit test. F.eks. CdaHeaderValidatorTest der viser CDA dokument validering og ProvideAndRegisterDocumentSetValidatorTest, der viser en række kald for iti-41.
Understøttede valideringsregler
De implementerede valideringsregler er lavet med udgangspunkt i de danske standarder og IHE XDS specifikationen.
Disse regler/standarder refereres på følgende måde::
- IHE Vol3 4.2.3.1.2 Creating Coded Attributes: Henviser til IHE XDS specifikationen volume 3, afsnit 4.2.3.1.2
- DK_IHE_ClassCode_DE: Henviser til til Medcoms fælles liste over tilladet værdisæt faneblad ClassCode_DE
- Metadata-v096 2.2.3 classCode: Henviser til den danske CDA profil afsnit 2.2.3
- DK-APD-v2.0.1: 2.1.10.1 Appointment Date and Time: Henviser til Appointment Document (APD) til aftaler afsnit 2.1.10.1
- DK-QRD-v1.3: 2.2.5 Custodian: Henviser til Questionnaire Response Document (QRD) afsnit 2.2.5
- PHMR-DK-v1.3 2.13.3 Custodian: Henviser til Personal Healthcare Monitoring Report (PHMR) afsnit 2.13.3
Begreber (entiteter/atributer mm) anvendt i valideringen stammer fra IHE frameworket (documentEntry og SubmissionSet) samt Medcoms Cda builder/parser (anvendes til at parse CDA header og de konkrete danske profileringer).
For nu er følgende valideringer implementeret. Beskrivelserne i tabelkolonnerne "Validering" stammer fra XdsValidationprojektets javadoc og skal vedligeholdes der.
Bemærk det er muligt sortere og filtrere i tabellerne med confluence indbyggede tabelhåndtering.
(Anvend "mvn javadoc:javadoc" for at generere i target/site folderne for mvn modulerne validation-xds og validation-codes)
Default validering konfiguration
Man kan med fordel tage udgangspunkt i disse konfigurerede valideringer, ligesom DROS gør i ovenstående eksempler. Hvad de hver især dækker fremgår af de følgende afsnit.
Klasse |
---|
CdaDocumentValidatorFactory |
Iti41ValidationFactory |
Iti42ValidationFactory |
Iti61ValidationFactory |
Iti57ValidationFactory |
De forskellige factories anvender en TerminologyDictionary. I TerminologyDictionary findes en række "LegalCodeChecker"s som anvendes af typevalideringerne (se afsnit nedenfor) til at validere gyldige koder med. Default opsætningen er specificeret i TerminologyDictionary og er følgende:
- ClassCode: Default gyldigt codeSystem er OID "1.2.208.184.100.9" (DK_IHE_ClassCode_DE).
- ConfidentialityCode: Default gyldigt codeSystem er OID "2.16.840.1.113883.5.25". Gyldig kode er "N". (DK_IHE_ConfidentialityCode_DE)
- OrganisationCode: Default gyldige codeSystemer er "1.2.208.176.1.1" (SOR) og "1.2.208.176.1.4" (YDERNUMMER).
- PatientIdCode: Default gyldigt codeSystem er "1.2.208.176.1.2" (CPR).
Ønskes validering af hele kodersæt, kan disse sendes med ind istedet for anvendelse af default valideringen. Benyt LegalCodeCheckerAsList til dette. Og ønkes en helt anden anden kodevalidering end mod en liste kan man lave sin egen implementation af LegalCodeChecker.
Validering af struktur
Dette er validering, som har med struktur at gøre. F.eks. udpakning af information og forventninger til del-elementer.
Afkrydningen i tabellens 5 sidste søjler indikerer, om en given validering er inkluderet i default valideringer, som er konfigureret i XdsValidation biblioteket.
Klasse | Validering | ITI 41 | ITI 42 | ITI 61 | ITI 57 | Cda dokument |
---|---|---|---|---|---|---|
ProvideAndRegisterDocumentSetStarter |
| x | ||||
RegisterDocumentSetStarter |
| x | x | x | ||
XDSDocumentITI41StructureValidator |
| x | ||||
XDSDocumentITI42StructureValidator |
| x | ||||
XDSDocumentITI61StructureValidator |
| x | ||||
XDSDocumentITI57StructureValidator |
| x | ||||
XDSDocumentValidator |
| x | ||||
CdaDocumentValidator |
| x | ||||
CdaDocumentTypeValidator |
| x | x | |||
XDSDocumentContentModelEnricher |
| x | ||||
CdaDocumentHeaderModelEnricher |
| x | x | |||
CdaDocumentApdV2ModelEnricher |
| x | x | |||
CdaDocumentPhmrModelEnricher |
| x | x | |||
CdaDocumentQrdModelEnricher |
| x | x | |||
CdaDocumentPhadModelEnricher |
| x | x |
Typevalideringer
Dette er hjælpevalideringer, som feltvalideringer gør brug af.
Klasse | Validering |
---|---|
AbstractElementCompare |
|
CodedModelCompare |
|
DateTimeCompare |
|
DateCompare |
|
StringCompare |
|
CodedValueValidation |
|
StringValidation |
|
ClassCodeValidation |
|
ConfidentialityCodeValidation |
|
EventCodeValidation |
|
FormatCodeValidation |
|
HealthcareFacilityTypeCodeValidation |
|
LanguageCodeValidation |
|
OrganisationCodeValidation |
|
PatientIdCodeValidation |
|
PracticeSettingCodeValidation |
|
TitleValidation |
|
TypeCodeValidation |
|
Krydsvalideringer
Her sammenlignes to entiteter. Disse valideringer sikrer, at de samme felter i forskellige entiteter (documentEntry, submissionSet og Cda dokument) er ens. Hvis mindst en af entiterne kan indholde flere felter af den samme type, sammenlignes antallet af disse også.
Afkrydningen i tabellens 5 sidste søjler indikerer, hvilke default valideringer, den enkelte validator er inkludret i.
Klasse | Validering mellem de 2 entiter nævnt i klassens navn | ITI 41 | ITI 42 | ITI 61 | ITI 57 | Cda dokument |
---|---|---|---|---|---|---|
CdaCrossDocumentEntryAuthorInstitutionValidator |
| x | ||||
CdaCrossDocumentEntryAuthorPersonValidator |
| x | ||||
CdaCrossDocumentEntryConfidentialityCodeValidator |
| x | ||||
CdaCrossDocumentEntryCreationTimeValidator |
| x | ||||
CdaCrossDocumentEntryEventCodeValidator |
| x | ||||
CdaCrossDocumentEntryLanguageCodeValidator |
| x | ||||
CdaCrossDocumentEntryLegalAuthenticatorValidator |
| x | ||||
CdaCrossDocumentEntryPatientIdValidator |
| x | ||||
CdaCrossDocumentEntryServiceStartTimeValidator |
| x | ||||
CdaCrossDocumentEntryServiceStopTimeValidator |
| x | ||||
CdaCrossDocumentEntrySourcePatientIdValidator |
| x | ||||
CdaCrossDocumentEntrySourcePatientInfoValidator |
| x | ||||
CdaCrossDocumentEntryTitleValidator |
| x | ||||
CdaCrossDocumentEntryTypeCodeValidator |
| x | ||||
SubmissionSetCrossDocumentEntryAuthorInstitutionValidator |
| x | x | x | x | |
SubmissionSetCrossDocumentEntryAuthorPersonValidator |
| x | x | x | x | |
SubmissionSetCrossDocumentEntryPatientIdValidator |
| x | x | x | x |
Feltvalideringer
Hver validering beskæftiger sig med et specifikt felt i enten ITI kald og/eller CDA dokumentet.
Afkrydningen i tabellens 5 sidste søjler indikerer, hvilke default valideringer, den enkelte validator er inkludret i.
Søjlen "felt" kan anvendes til sortering, hvis man ønsker at se valideringen for et specifik felt på tværs af entitet.
Klasse | Felt | Validering | ITI 41 | ITI 42 | ITI 61 | ITI 57 | Cda dokument |
---|---|---|---|---|---|---|---|
CdaHeaderAuthorInstitutionValidator | AuthorInstitution |
| x | x | |||
CdaHeaderAuthorPersonValidator | AuthorPerson |
| x | x | |||
CdaHeaderConfidentialityCodeValidator | ConfidentialityCode |
| x | x | |||
CdaHeaderEventCodeValidator | EventCode |
| x | x | |||
CdaHeaderFormatCodeValidator | FormatCode |
| x | x | |||
CdaHeaderLanguageCodeValidator | LanguageCode |
| x | x | |||
CdaHeaderPatientIdValidator | PatientId |
| x | x | |||
CdaHeaderSourcePatientIdValidator | SourcePatientId |
| x | x | |||
CdaHeaderSourcePatientInfoValidator | SourcePatientInfo |
| x | x | |||
CdaHeaderTitleValidator | Title |
| x | x | |||
CdaHeaderTypeCodeValidator | TypeCode |
| x | x | |||
DocumentEntryClassCodeValidator | ClassCode |
| x | x | x | x | |
DocumentEntryAuthorInstitutionValidator | AuthorInstitution |
| x | x | x | x | |
DocumentEntryAuthorPersonValidator | AuthorPerson |
| x | x | x | x | |
DocumentEntryAvailabilityStatusValidator | AvailabilityStatus |
| x | x | x | x | |
DocumentEntryClassCodeValidator | ClassCode |
| x | x | x | x | |
DocumentEntryConfidentialityCodeValidator | ConfidentialityCode |
| x | x | x | x | |
DocumentEntryCreationTimeValidator | CreationTime |
| x | x | x | x | |
DocumentEntryEntryUUIDValidator | EntryUUID |
| x | x | x | x | |
DocumentEntryEventCodeValidator | EventCode |
| x | x | x | x | |
DocumentEntryFormatCodeValidator | FormatCode |
| x | x | x | x | |
DocumentEntryHashValidator | Hash |
| x | x | x | ||
DocumentEntryHealthcareFacilityTypeCodeValidator | HealthcareFacilityTypeCode |
| x | x | x | x | |
DocumentEntryLanguageCodeValidator | LanguageCode |
| x | x | x | x | |
DocumentEntryLegalAuthenticatorValidator | LegalAuthenticator |
| x | x | x | x | |
DocumentEntryMimeTypeValidator | MimeType |
| x | x | x | x | |
DocumentEntryPatientIdValidator | PatientId |
| x | x | x | x | |
DocumentEntryPracticeSettingCodeValidator | PracticeSettingCode |
| x | x | x | x | |
DocumentEntryReferenceidListValidator | ReferenceidList |
| x | x | x | x | |
DocumentEntryRepositoryUniqueIdValidator | RepositoryUniqueId |
| x | x | x | x | |
DocumentEntrySizeValidator | Size |
| x | x | x | ||
DocumentEntrySourcePatientIdValidator | SourcePatientId |
| x | x | x | x | |
DocumentEntrySourcePatientInfoValidator | SourcePatientInfo |
| x | x | x | x | |
DocumentEntryTitleValidator | Title |
| x | x | x | x | |
DocumentEntryTypeCodeValidator | TypeCode |
| x | x | x | x | |
DocumentEntryTypeValidator | Type |
| x | x | x | x | |
DocumentEntryUniqueIdValidator | UniqueId |
| x | x | x | x | |
DocumentEntryURIValidator | URI |
| x | x | x | x | |
SubmissionSetAuthorInstitutionValidator | AuthorInstitution |
| x | x | x | x | |
SubmissionSetEntryUUIDValidator | EntryUUID |
| x | x | x | x | |
SubmissionSetPatientIdValidator | PatientId |
| x | x | x | x | |
SubmissionSetUniqueIdValidator | UniqueId |
| x | x | x | x | |
Apd2AppointmentIdValidator | AppointmentId |
| x | x | |||
Apd2CustodianIdValidator | Custodian |
| x | x | |||
Apd2StartStopTimeValidator | StartStopTime |
| x | x | |||
PhmrCustodianIdValidator | Custodian |
| x | x | |||
QrdCustodianIdValidator | Custodian |
| x | x |
.
Typevalideringer
Dette er hjælpevalideringer, som feltvalideringer gør brug af.
...
CodedValueValidation
...
- udfyldt codeSystem (IHE 4.2.3.1.2 Creating Coded Attributes)
- gyldigt codeSystem (DK_IHE_ClassCode_DE)
- udfyldt code (IHE 4.2.3.1.2 Creating Coded Attributes)
...
ClassCodeValidation
...
- længden på code må ikke være større end 3 (DK_IHE_ClassCode_DE)
- displayName skal være udfyldt (IHE 4.2.3.1.2 Creating Coded Attributes)
- validering for CodedValueValidation. Default gyldigt codeSystem er OID "1.2.208.184.100.9" (DK_IHE_ClassCode_DE)
...
- hvis codeSystem er Yder så skal længden på code være 6
- hvis codeSystem er Yder så skal code være numerisk
- validering for CodedValueValidation. Default gyldige codeSystemer er "1.2.208.176.1.1" (SOR) og "1.2.208.176.1.4" (YDERNUMMER)
...
- sammenligning af 2 lister (hver med en eller flere objekter)
- antal af objekter skal være ens
- de enkelte objekter skal være ens på de samme pladser i listen
...
- validering for AbstractElementCompare hvor følgende opfylder "objekterne er ens"
- value skal være ens
- codeSystem skal være ens
- displayName skal være ens
Feltvalideringer
Afkrydningen i tabellens 5 sidste søjler indikerer, om en given validering er inkluderet i default valideringer, som er konfigureret i XdsValidation biblioteket.
...
DocumentEntryClassCodeValidator
...
- udfyldt classCode (Metadata-v096 2.2.3 classCode)
- validering for ClassCodeValidation
...
- der skal være mindst een author (Metadata-v096 2.2.1.1 authorInstitution)
- der skal være en authorInstitution (Metadata-v096 2.2.1.1 authorInstitution)
- validering for OrganisationCodeValidation
...
- der skal være een author (Metadata-v096 2.2.1.1 authorInstitution)
- der skal være en authorInstitution (Metadata-v096 2.2.1.1 authorInstitution)
- validering for OrganisationCodeValidation
...
- validering for OrganisationCodeValidation
...
- der skal være lige mange authors på CDA header og documentEntry
- der skal være lige mange AuthorInstitutions på author på CDA header og documentEntry
- validering for CodedModelCompare af objekt og liste
...
- der valideres kun, hvis submissionSet har authors
- der skal være lige mange authors på submissionSet og documentEntry
- der skal være lige mange AuthorInstitutions på author på submissionSet og documentEntry
- validering for CodedModelCompare af 2 lister
...
- ServiceStartTime skal være udfyldt (DK-APD-v2.0: 2.1.10.1 Appointment Date and Time)
...