Page History

Versions Compared

Key

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

...

Indhold:

Table of Contents

Indledning

På NSP deles i dag CDA dokumenter vha. en XDS infrastruktur. Et CDA dokument er et struktureret XML dokument, som følger en bestemt standard for kliniske dokumenter. Der findes forskellige typer af CDA dokumenter, hvor der er lavet danske profileringer (Udgivelser), som dækker følgende:

...

Da DROS, som nævnt gør brug af XdsValidation, kan man her finde yderligere inspiration for implementering der. Dette dokument beskriver overordnet funktionalitet af biblioteket.

API Beskrivelse og anvendelse

XdsValidation biblioteket kan overordnet validere følgende:

...

En valideringsregel returnerer et object ValidationResultSet. ValidationResultSet kan indholde en række fejl, hvis sådanne er fundet under valideringen.

Validator

En almindelig validering. Den består af en validering samt kald af dens under validatorer.

...

Det som kendetegner en almindelig validator er extension af klassen AbstractValidatorImpl.

ModelEnricher

Dette er ikke en egentlig validator. "Valideringen" består af udpakning af input.

...

Det som kendetegner en ModelEnricher er extension af klassen AbstractModelEnricherImpl.

Starter

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

...

Det som kendetegner en Starter er extension af klassen AbstractStarterImpl.

Den gode kombination

Principperne for oprettelse af valideringsregler og sammensætning af disse i struktur, kan skitseres ved:

...

Der er lavet en hjælpe "abstraktion" i source koden, til at lave validerings strukturen, så man kan opbygge den vha. en builder pattern. Se factory metoderne for sådan anvendelse.

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

...

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) {
 		ValidationResultSet validationResultSet = new ValidationResultSet(); 

        if (input == null || input.getEnrichment(ENRICHMENT_MY_TEST_DOCUMENT) == null) {
			return 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:

...

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.

...

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

...

Der findes en række metoder på XDSConfiguration objektet til at sætte de forskellige konfigurationer.

Validering af struktur

Dette er validering, som har med struktur at gøre. F.eks. udpakning af information og forventninger til del-elementer.

...

Klasse	Validering	ITI 41	ITI 42	ITI 61	ITI 57	Cda dokument
ProvideAndRegisterDocumentSetStarter	submissionSet pakkes ud dokumenter pakkes ud der er som minimum et dokument	x
RegisterDocumentSetStarter	submissionSet pakkes ud dokumentEntries pakkes ud		x	x	x

XDSDocumentITI41StructureValidator	der findes et documentEntry der findes et fysisk dokument der findes et submissionSet	x
XDSDocumentITI42StructureValidator	der findes et documentEntry der findes et submissionSet		x
XDSDocumentITI61StructureValidator	der findes et documentEntry der findes et submissionSet			x
XDSDocumentITI57StructureValidator	der findes et submissionSet				x

XDSDocumentContentModelEnricher	indhold kan læses som bytes (UTF8)	x
CdaDocumentHeaderModelEnricher	der er tale om et cda dokument (typecode i documententry matcher ConfigCodeModel(configCdaTypes) bytes kan parses som en CDA header	x				x
CdaDocumentApdV2ModelEnricher	det er et aftale dokument: CodeCodedValue har Codesystem "2.16.840.1.113883.6.1" og code "39289-4" 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 kan parses som et APD dokument	x				x
CdaDocumentPhmrModelEnricher	det er et PHMR dokument: CodeCodedValue har Codesystem "2.16.840.1.113883.6.1" og code "53576-5" det er Cda Header Version 1: FormatCode er null (anvendt parser finder ikke formatCode for v1) CDA dokumentet kan parses som et PHMR dokument	x				x
CdaDocumentQrdModelEnricher	det er et QRD dokument: CodeCodedValue har Codesystem "2.16.840.1.113883.6.1" og code "74465-6" det er Cda Header Version 1: FormatCode er null (anvendt parser finder ikke formatCode for v1) CDA dokumentet kan parses som et QRD dokument	x				x
CdaDocumentPhadModelEnricher	Denne er pt ikke aktiv, men planlagt via SDS-7229	x				x

Typevalideringer

Dette er hjælpevalideringer, som feltvalideringer gør brug af.

Klasse	Validering
ConfigCodeModelChecker	Afgør om en typeCode tillades for en given ConfigCodeModel ConfigCodeModel er en liste af typeCodes, hvor typeCode skal indgå med mindre man har sat MatchAll på ConfigCodeModel
AbstractElementCompare	sammenligning af 2 lister (hver med nul, en eller flere objekter) antal af objekter i listen er ens de enkelte objekter er ens på de samme pladser i listen
CodedModelCompare	overholder validering i AbstractElementCompare hvor følgende opfylder "objekter er ens" value er ens codeSystem er ens displayName er ens
DateTimeCompare	overholder validering i AbstractElementCompare hvor følgende opfylder "objekter er ens" dateTime er ens
DateCompare	overholder validering i AbstractElementCompare hvor følgende opfylder "objekter er ens" år, måned og dag i Calender er ens
StringCompare	overholder validering i AbstractElementCompare hvor følgende opfylder "objekter er ens" de to strenge er ens

CodedValueValidation	regel: IHE Vol3 4.2.3.1.2 Creating Coded Attributes codeSystem er udfyldt hvis krævet codeSystem er gyldigt hvis krævet code er udfyldt hvis krævet displayName er udfyldt hvis krævet yderligere kode validering som implementeret i ConfigCodeModelChecker (med evt. default værdier i XDSConfiguration)
StringValidation	overholder regler specificeret af anvender: er udfyldt hvis påkrævet sat længden på værdien er ikke større end maksimum længde angivet værdien er en af de tilladte værdier angivet
ClassCodeValidation	regel: IHE Vol3 4.2.3.1.2 Creating Coded Attributes længden på code er ikke større end 3 (DK_IHE_ClassCode_DE) overholder validering i CodedValueValidation. Default gyldigt codeSystem angivet i XDSConfiguration. Code, CodeSystem og DisplayName er udfyldt.
ConfidentialityCodeValidation	regel: IHE Vol3 4.2.3.1.2 Creating Coded Attributes overholder validering i CodedValueValidation. Default gyldigt codeSystem angivet i XDSConfiguration. Code og CodeSystem er udfyldt.
EventCodeValidation	regel IHE 4.2.3.1.2 Creating Coded Attributes overholder validering i CodedValueValidation. Ingen default gyldig codeSystem. Code, CodeSystem og DisplayName er udfyldt.
FormatCodeValidation	regel: IHE 4.2.3.1.2 Creating Coded Attributes overholder validering i CodedValueValidation. Ingen default gyldig codeSystem. Code, CodeSystem og DisplayName er udfyldt.
HealthcareFacilityTypeCodeValidation	regel: IHE 4.2.3.1.2 Creating Coded Attributes hvis udfyldt er værdien numerisk (DK_HealthcareFacilityType_DE) overholder validering i CodedValueValidation. Ingen default gyldig codeSystem. Code, CodeSystem og DisplayName er udfyldt.
LanguageCodeValidation	overholder validering i StringValidation. Påkrævet og default tilladt værdi er "da-DK" (DK_IHE_LanguageCode_DE)
OrganisationCodeValidation	hvis codeSystem er Yder så er længden på code 6 hvis codeSystem er Yder er code numerisk overholder validering i CodedValueValidation. Default gyldigt codeSystem angivet i XDSConfiguration. Code og CodeSystem er udfyldt.
PatientIdCodeValidation	overholder validering i CodedValueValidation. Default gyldigt codeSystem angivet i XDSConfiguration. Code og CodeSystem er udfyldt.
PracticeSettingCodeValidation	regel: IHE 4.2.3.1.2 Creating Coded Attributes overholder validering i CodedValueValidation. Ingen default gyldig codeSystem. Code, CodeSystem og DisplayName er udfyldt.
TitleValidation	validering for StringValidation. Påkrævet og default maksimum længde er 128 (Metadata-v096 2.2.31 title)
TypeCodeValidation	regel: IHE 4.2.3.1.2 Creating Coded Attributes validering i CodedValueValidation. Ingen default gyldig codeSystem. Code, CodeSystem og DisplayName er udfyldt.

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

...

Klasse	Validering mellem de 2 entiter nævnt i klassens navn	ITI 41	ITI 42	ITI 61	ITI 57
CdaHeaderCrossDocumentEntryAuthorInstitutionValidator	der er lige mange authors (dvs en) der er lige mange AuthorInstitutions på den enkelte author overholder validering i CodedModelCompare	x
CdaHeaderCrossDocumentEntryAuthorPersonValidator	der er lige mange authors (dvs en) overholder validering i StringCompare indholdende personens navne	x
CdaHeaderCrossDocumentEntryConfidentialityCodeValidator	der er lige mange ConfidentialityCodes (dvs en) overholder validering i CodedModelCompare	x
CdaHeaderCrossDocumentEntryCreationTimeValidator	overholder validering i DateTimeCompare	x
CdaHeaderCrossDocumentEntryEventCodeValidator	overholder validering i CodedModelCompare	x
CdaHeaderCrossDocumentEntryLanguageCodeValidator	overholder validering i StringCompare indeholdende languageCode værdierne	x
CdaHeaderCrossDocumentEntryLegalAuthenticatorValidator	overholder validering i StringCompare indeholdende legalAuthenticators navne	x
CdaHeaderCrossDocumentEntryPatientIdValidator	overholder validering i CodedModelCompare	x
CdaHeaderCrossDocumentEntryServiceStartTimeValidator	overholder validering i DateTimeCompare	x
CdaHeaderCrossDocumentEntryServiceStopTimeValidator	overholder validering i DateTimeCompare	x
CdaHeaderCrossDocumentEntrySourcePatientIdValidator	overholder validering i CodedModelCompare	x
CdaHeaderCrossDocumentEntrySourcePatientInfoValidator	overholder validering i StringCompare indeholdende personens titel og navne overholder validering i DateCompare med datoer, hvor datoer er fødselsdato overholder validering i StringCompare med køn værdierne	x
CdaHeaderCrossDocumentEntryTitleValidator	overholder validering i StringCompare indeholdende titel værdierne	x
CdaHeaderCrossDocumentEntryTypeCodeValidator	overholder validering i CodedModelCompare	x
SubmissionSetCrossDocumentEntryAuthorInstitutionValidator	! forudsætning for validering: submissionSet har authors der er lige mange authors der er lige mange AuthorInstitutions på den enkelte author overholder validering i CodedModelCompare	x	x	x	x
SubmissionSetCrossDocumentEntryAuthorPersonValidator	! forudsætning for validering: submissionSet har authors overholder validering i StringCompare indholdende personernes navne (indirekte test af at der er lige mange authors qua listen af navne)	x	x	x	x
SubmissionSetCrossDocumentEntryPatientIdValidator	value og codeSystem er ens	x	x	x	x

Feltvalideringer

Hver validering beskæftiger sig med et specifikt felt i enten ITI kald og/eller CDA dokumentet.

...

Content

Space Tools