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:

...

En grafisk præsentation af denne konfiguration af default validering kan ses i Design og arkitektur dokumentet.

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

...

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

For andre koder tillades alle værdier. Ønskes validering af hele specifikke kodersæt, kan disse sendes med ind istedet for anvendelse af default valideringen.

Man skal være særlig opmærksom på konfiguration omkring CdaTypeCodes. Denne afgør om et givet dokument skal parses som et CDA dokument. Validerer man dokumenter, der ikke er af CDA typen skal man huske at sætte listen med, hvilke TypeCodes, der faktisk er CDA dokumenter.

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.

...

KlasseValideringITI 41ITI 42ITI 61ITI 57Cda dokument
ProvideAndRegisterDocumentSetStarter
  • submissionSet pakkes ud
  • dokumenter pakkes ud
  • der er som minimum et dokument
x



RegisterDocumentSetStarter
  • submissionSet pakkes ud
  • dokumentEntries pakkes ud

xxx







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
CdaDocumentApdV2ModelEnricherx


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
CdaDocumentPhadModelEnricherx


x


Typevalideringer

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

KlasseValidering

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

...

KlasseValidering mellem de 2 entiter nævnt i klassens navnITI 41ITI 42ITI 61ITI 57Cda dokument
CdaCrossDocumentEntryAuthorInstitutionValidator
  • der er lige mange authors (dvs en)
  • der er lige mange AuthorInstitutions på den enkelte author
  • overholder validering i CodedModelCompare
x



CdaCrossDocumentEntryAuthorPersonValidator
  • der er lige mange authors (dvs en)
  • overholder validering i StringCompare indholdende personens titel og navne
x



CdaCrossDocumentEntryConfidentialityCodeValidator
  • der er lige mange ConfidentialityCodes (dvs en)
  • overholder validering i CodedModelCompare
x



CdaCrossDocumentEntryCreationTimeValidator
  • overholder validering i DateTimeCompare
x



CdaCrossDocumentEntryEventCodeValidator
  • overholder validering i CodedModelCompare
x



CdaCrossDocumentEntryLanguageCodeValidator
  • overholder validering i StringCompare indeholdende languageCode værdierne
x



CdaCrossDocumentEntryLegalAuthenticatorValidator
  • overholder validering i StringCompare indeholdende legalAuthenticators titel og navne
x



CdaCrossDocumentEntryPatientIdValidator
  • overholder validering i CodedModelCompare
x



CdaCrossDocumentEntryServiceStartTimeValidator
  • overholder validering i DateTimeCompare
x



CdaCrossDocumentEntryServiceStopTimeValidator
  • overholder validering i DateTimeCompare
x



CdaCrossDocumentEntrySourcePatientIdValidator
  • overholder validering i CodedModelCompare
x



CdaCrossDocumentEntrySourcePatientInfoValidator
  • 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



CdaCrossDocumentEntryTitleValidator
  • overholder validering i StringCompare indeholdende titel værdierne
x



CdaCrossDocumentEntryTypeCodeValidator
  • 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
xxxx
SubmissionSetCrossDocumentEntryAuthorPersonValidator
  • ! forudsætning for validering: submissionSet har authors
  • overholder validering i StringCompare indholdende personernes titel og navne
  • (indirekte test af at der er lige mange authors qua listen af titel og navne)
xxxx
SubmissionSetCrossDocumentEntryPatientIdValidator
  • value og codeSystem er ens
xxxx

Feltvalideringer

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

...