Dette dokument er en vejledning til brug for anvendere af FSK Registry. Da anvendelsen af FSK Registry sker via Dokumentdelingsservicen, starter dokumentet med et overblik over arkitekturen. Formålet med dette er at dokumentere, hvordan DDS og FSK Registry hænger sammen, og hvilke opgaver disse komponenter dækker hver især.
Da FSK Registrys primære opgave er at fortolke forespørgsler fra dokumentanvendere og levere konkrete svar på disse, indeholder dette dokument beskrivelser af:
Disse beskrivelser er bygget op med eksempler på requests og responses, hvor det giver mening. Eksemplerne stammer fra TEST2 miljøet.
Tilsidst i dokumentet dokumenteres det, hvordan et svar fra FSK Registry ser ud - herunder sammenhæng med Medcoms danske profilering: XDS Metadata for Document Sharing v. 0.95.
Dette dokument antager, at læseren er bekendt med basale koncepter indenfor IHE XDS, Dokumentdelingsservicen og CDA Dokumenter.
Der kan blandt andet henvises til følgende:
MedComs brug af HL7 standarder
DDS | Dokumentdelingsservice |
BRS | Behandlingsrelationsservice |
FSK | Fælles Stamkort |
XDS | Cross-Enterprise Document Sharing |
Fremsøgning af stamkort sker via DDS (se DDS Registry - Querying User's Guide og DDS Registry Querying Interface Description).
FSK Registry er således en kilde, som DDS anvender til at understøtte fremsøgingsforespørgsler fra anvendere.
Således foregår en forespørgsel mod FSK Registry på følgende måde:
DDS Registry forholder sig ikke til indholdet af den konkrete query, der kommer fra Dokumentanvenderen, men overlader til de bagvedliggende registre (herunder FSK Registry) at fortolke og besvare den konkrete query. I næste afsnit findes en detaljeret oversigt over, hvorledes FSK Registry fortolker indkommende queries.
FSK Registry implementerer transaktionen Registry Stored Query (ITI-18), som er beskrevet i IHE IT Infrastructure Technical Framework Volume 2a (ITI TF-2a) 10 Transactions Part A.
ITI-18 query beskeder følger ebXML Registry Information Mode Version (RIM) 3.0. Overordnet set findes der i en ITI-18 query 3 typer af parametre:
I det følgende afsnit vil vi gennemgå hver af disse 3 parameter-typer og angive, hvordan disse er understøttede/fortolkede i FSK Registry. Gennemgangen vil indeholde eksempler på queries, hvor dette giver mening.
FSK Registry melder tilbage til DDS med et response af ...TODO.
ReturnType kan som udgangspunkt antage een af følgende to værdier:
FSK Registry ignorerer ReturnCompoesedObjects parameteren. Alle queries besvarers, somom denne parameter er true.
FSK Registry ignorerer return type parameteren. Alle queries besvares, somom denne parameter er sat til LeafClass dvs. fuldt sæt af metadata.
DDS bruger de returnerede metadata til evt. at foretage filtrering i forhold til dataspecifikke spærringer. For at dette kan lade sig gøre, har DDS brug for adgang til det fulde sæt af metadata (LeafClass) og ikke kun objekt-ider (ObjectRef).
I IHE IT Infrastructure Technical Framework opereres med en række standard XDS Query identificeret med UUID'er. Nedenstående tabel viser den samlede oversigt over de definerede Query ID.
Kolonnen længst til højre viser, om FSK Registry forstår/understøtter den specifikke Query.
Query Name | Query ID | FSK Registry understøttelse |
---|---|---|
FindDocuments | urn:uuid:14d4debf-8f97-4251-9a74-a90016b0af0d | Ja |
FindSubmissionSets | urn:uuid:f26abbcb-ac74-4422-8a30-edb644bbc1a9 | Nej |
FindFolders | urn:uuid:958f3006-baad-4929-a4de-ff1114824431 | Nej |
GetAll | urn:uuid:10b545ea-725c-446d-9b95-8aeb444eddf3 | Nej |
GetDocuments | urn:uuid:5c4f972b-d56b-40ac-a5fc-c8ca9b40b9d4 | Nej |
GetFolders | urn:uuid:5737b14c-8a1a-4539-b659-e03a34a5e1e4 | Nej |
GetAssociations | urn:uuid:a7ae438b-4bc2-4642-93e9-be891f7bb155 | Nej |
GetDocumentsAndAssociations | urn:uuid:bab9529a-4a10-40b3-a01f-f68a615d247a | Nej |
GetSubmissionSets | urn:uuid:51224314-5390-4169-9b91-b1980040715a | Nej |
GetSubmissionSetAndContents | urn:uuid:e8e3cb2c-e39c-46b9-99e4-c12f57260b83 | Nej |
GetFolderAndContents | urn:uuid:b909a503-523d-4517-8acf-8e5834dfc4c7 | Nej |
GetFoldersForDocument | urn:uuid:10cae35a-c7f9-4cf5-b61e-fc3278ffb578 | Nej |
GetRelatedDocuments | urn:uuid:d90e5407-b356-4d91-a89f-873917b4b0e6 | Nej |
FindDocumentsByReferenceId | urn:uuid:12941a89-e02e-4be5-967c-ce4bfc8fe492 | Nej |
FSK Registry vil besvare en forespørgsel med ikke-understøttet Query ID med en fejl af typen 'XDSUnknownStoredQuery'. Se eksempel nedenfor.
som giver dette resultat:
De søgeparametre, der er kan anvendes er defineret udfra Query ID. Dette betyder at hver Query type (se tabellen ovenfor) medfører en liste af tvungne/optionelle søgeparametre. I de følgende afsnit gennemgås FSK Registrys understøttede Query typer, og for hver af disse angives søgeparametrene, som defineret i IHE IT Infrastructure Technical Framework Volume 2a (ITI TF-2a) 10 Transactions Part A. En kolonne udfor hver søgeparameter angiver FSK Registrys fortolkning (hvis nogen) af den medsendte parameter samt evt. valideringer.
Som defineret i IHE IT Infrastructure Technical Framework Volume 2a (ITI TF-2a) 10 Transactions Part A giver Querytypen FindDocuments anledning til en specificeret liste af søgeparametre. Nedenfor er denne tabel gengivet, og FSK Registry understøttelse angivet i kolonnen yderst til højre. FSK Registry understøttelser viser, om FSK Registry kigger på søgeparametren, og hvad FSK Registry betegner som et match på query (kommer der et svar tilbage eller ej).
Fra IHE IT Infrastructure Technical Framework for specifikation af parametre relevante for FindDocuments: Find documents (XDSDocumentEntry objects) in the registry for a given patientID with a matching availabilityStatus attribute. The other parameters can be used to restrict the set of XDSDocumentEntry objects returned. | ||||
Parameter Name | Attribute | Opt | Mult | FSK Registry understøttelse |
---|---|---|---|---|
$XDSDocumentEntryPatientId | XDSDocumentEntry.patientId | R | -- | Denne parameter skal angives. FSK Registry validerer at den medsendte værdi for CPR nummeret har længde 10 og består af cifre. Medsendes værdien ikke eller overholder den medsendte værdi ikke FSK Registrys validering returneres en fejl af typen 'XDSUnknownPatientId'. Se eksempel nedenfor. |
$XDSDocumentEntryReferenceIdList (5) | XDSDocumentEntry.referenceIdList (3) | R | M | |
$XDSDocumentEntryClassCode (1) | XDSDocumentEntry.classCode | O | M | FSK Registry matcher queries, der
eller
eller
|
$XDSDocumentEntryTypeCode (1) | XDSDocumentEntry.typeCode | O | M | FSK Registry matcher queries, der
eller
eller
|
$XDSDocumentEntryPracticeSettingCode (1) | XDSDocumentEntry.practiceSettingCode | O | M | N/A |
$XDSDocumentEntryCreationTimeFrom | Lower value of XDSDocumentEntry.creationTime | O | -- | N/A |
$XDSDocumentEntryCreationTimeTo | Upper value of XDSDocumentEntry.creationTime | O | -- | N/A |
$XDSDocumentEntryServiceStartTimeFrom | Lower value of XDSDocumentEntry.serviceStartTime | O | -- | N/A |
$XDSDocumentEntryServiceStartTimeTo | Upper value of XDSDocumentEntry.serviceStartTime | O | -- | N/A |
$XDSDocumentEntryServiceStopTimeFrom | Lower value of XDSDocumentEntry.serviceStopTime | O | -- | N/A |
$XDSDocumentEntryServiceStopTimeTo | Upper value of XDSDocumentEntry.serviceStopTime | O | -- | N/A |
$XDSDocumentEntryHealthcareFacilityTypeCode (1) | XDSDocumentEntry.healthcareFacilityTypeCode | O | M | N/A |
$XDSDocumentEntryEventCodeList (1) | XDSDocumentEntry.eventCodeList (3) | O | M | FSK Registry matcher queries, der
eller
eller
|
$XDSDocumentEntryConfidentialityCode (1) | XDSDocumentEntry.confidentialityCode (3) | O | M | FSK Registry matcher queries, der
eller
eller
|
$XDSDocumentEntryAuthorPerson (4) | XDSDocumentEntry.author | O | M | FSK Registry matcher kun queries, der
eller
|
$XDSDocumentEntryFormatCode (1) | XDSDocumentEntry.formatCode | O | M | FSK Registry matcher queries, der
eller
eller
|
$XDSDocumentEntryStatus | XDSDocumentEntry.availabilityStatus | R | M | FSK Registry matcher queries, der
eller
eller
|
$XDSDocumentEntryType (6) | XDSDocumentEntry.objectType | O | M(1) | FSK Registry matcher queries, der
eller
eller
|
1) Shall be coded according to specification of Coding of Code/Code
3) 3 Supports AND/OR semantics
4) The value for this parameter is a pattern compatible with the SQL keyword LIKE which allows the use of the following wildcard characters: % to match any (or no) characters and _ to match a single character. The match shall be applied to the text contained in the Value elements of the authorPerson Slot on the author Classification (value strings of the authorPerson sub-attribute)
5) The value for this parameter is a pattern compatible with the SQL keyword LIKE which allows the use of the following wildcard characters: % to match any (or no) characters and _ to match a single character
FSK Registry er sat op med en række miljøspecifikke variable. De forskellige variable gennemgåes og deres anvendelse specificeres. Nogle af disse variable er miljøspecifikke (i disse tilfælde listes parametrene for de forskellige miljøer) mens andre er ens henover de forskellige miljøer (den nuværende konfiguration vises).
Som det fremgår af tabellen anvendes de forskellige metadata opsætningsvariable til filtrering af queries og/eller til indsættelse i de DocumentEntries, som FSK Registry genererer. FSK Registry genererer ikke selve stamdatadokumentet, så en beskrivelse af selve Stamdata CDA dokumentindholdet ligger udenfor scope af dette dokument.
Dog vil der være en sammenhæng mellem det forventede indhold af de returnerede DocumentEntries og den af Medcom specifikcerede danske metadataprofil.
Gennem et konkret eksempel på svar fra FSK Registry vil vi dokumentere sammenhængen med den danske metadataprofil.
Til filtrering af indkommende queries (se afsnit vedr. FSK Registry Query Parameters) samt til generering af de udgående DocumentEntries i responses er FSK Registry konfigureret med følgende opsætningsvariable:
Opsætningsvariablens navn | Beskrivelse | Miljøspecifik | Værdi (nuværende opsætning) |
---|---|---|---|
documentEntry.homeCommunityId | Anvendes til indsættelse i feltet xxx for de returnerede DocumentEntries | J | ?? (TEST1) |
documentEntry.repositoryUniqueId | Anvendes til indsættelse i feltet xxx for de returnerede DocumentEntries | J | ?? (TEST1) |
documentEntry.title | Anvendes til indsættelse i feltet xxx for de returnerede DocumentEntries | N | Fælles stamkort |
documentEntry.mimeType | Anvendes til indsættelse i feltet xxx for de returnerede DocumentEntries | N | text/xml |
documentEntry.languageCode | Anvendes til indsættelse i feltet xxx for de returnerede DocumentEntries | N | da-DK |
documentEntry.patient.assigningAuthority.root | Anvendes til indsættelse i feltet xxx for de returnerede DocumentEntries | N | 1.2.208.176.1.2 (CPR) |
documentEntry.organisation.assigningAuthority.root | Anvendes til indsættelse i feltet xxx for de returnerede DocumentEntries | N | 1.2.208.176.1.1 (SOR) |
documentEntry.healthcareFacilityTypeCode.code | Anvendes til indsættelse i feltet xxx for de returnerede DocumentEntries | N | 554041000005106 |
documentEntry.healthcareFacilityTypeCode.schemeName | Anvendes til indsættelse i feltet xxx for de returnerede DocumentEntries | N | 2.16.840.1.113883.6.96 |
documentEntry.healthcareFacilityTypeCode.name | Anvendes til indsættelse i feltet xxx for de returnerede DocumentEntries | N | sundhedsforvaltning |
documentEntry.classCode.code | Anvendes til filtrering af queries. Anvendes til indsættelse i feltet xxx for de returnerede DocumentEntries | N | 001 |
documentEntry.classCode.schemeName | Anvendes til filtrering af queries. Anvendes til indsættelse i feltet xxx for de returnerede DocumentEntries | N | 1.2.208.184.100.9 |
documentEntry.classCode.name | Anvendes til indsættelse i feltet xxx for de returnerede DocumentEntries | N | Klinisk rapport |
documentEntry.formatCode.code | Anvendes til filtrering af queries. Anvendes til indsættelse i feltet xxx for de returnerede DocumentEntries | N | DK FSK Schema |
documentEntry.formatCode.schemeName | Anvendes til filtrering af queries. Anvendes til indsættelse i feltet xxx for de returnerede DocumentEntries | N | urn:ad:dk:medcom:fsk:full |
documentEntry.formatCode.name | Anvendes til indsættelse i feltet xxx for de returnerede DocumentEntries | N | DK FSK Schema |
documentEntry.typeCode.code | Anvendes til filtrering af queries. Anvendes til indsættelse i feltet xxx for de returnerede DocumentEntries | N | 52460-3 |
documentEntry.typeCode.schemeName | Anvendes til filtrering af queries. Anvendes til indsættelse i feltet xxx for de returnerede DocumentEntries | N | 2.16.840.1.113883.6.1 |
documentEntry.typeCode.name | Anvendes til indsættelse i feltet xxx for de returnerede DocumentEntries | N | Patient Information |
documentEntry.author.organisation.id | Anvendes til indsættelse i feltet xxx for de returnerede DocumentEntries | N | 634491000016008 |
documentEntry.author.organisation.name | Anvendes til indsættelse i feltet xxx for de returnerede DocumentEntries | N | Sundhedsdatastyrelsen |
documentEntry.confidentialityCode.code | Anvendes til filtrering af queries. Anvendes til indsættelse i feltet xxx for de returnerede DocumentEntries | N | N |
documentEntry.confidentialityCode.schemeName | Anvendes til filtrering af queries. Anvendes til indsættelse i feltet xxx for de returnerede DocumentEntries | N | 2.16.840.1.113883.5.25 |
documentEntry.confidentialityCode.name | Anvendes til indsættelse i feltet xxx for de returnerede DocumentEntries | N | normal |
documentEntry.practiceSettingCode.code | Anvendes til indsættelse i feltet xxx for de returnerede DocumentEntries | N | 408443003 |
documentEntry.practiceSettingCode.schemeName | Anvendes til indsættelse i feltet xxx for de returnerede DocumentEntries | N | 2.16.840.1.113883.6.96 |
documentEntry.practiceSettingCode.name | Anvendes til indsættelse i feltet xxx for de returnerede DocumentEntries | N | almen medicin |
Som det fremgår af ovenstående tabel anvendes variablene til både: