Page History
...
Dette dokument er en vejledning til brug for anvendere af FSK Registry Adapter. Da anvendelsen af FSK Registry Adapter sker via Dokumentdelingsservicen, starter dokumentet med et overblik over arkitekturen. Formålet med dette er at dokumentere, hvordan DDS og FSK Registry Adapter hænger sammen, og hvilke opgaver disse komponenter dækker hver især.
Da FSK Registrys Adapter primære opgave er at fortolke forespørgsler fra dokumentanvendere og levere konkrete svar på disse, indeholder dette dokument beskrivelser af:
- Hvilke søgeparametre, FSK Registry Adapter understøtter
- Hvilke valideringer FSK Registry Adapter laver
Tilsidst i dokumentet dokumenteres det, hvordan et svar fra FSK Registry Adapter ser ud - herunder sammenhæng med Medcoms danske profilering: XDS Metadata for Document Sharing v. 0.95.
...
Fremsøgning af stamkort sker via DDS (se DDS Registry - Querying User's Guide og DDS Registry Querying Interface Description).
FSK Registry Adapter understøtter følgende User Story:
FSK-SOEG-1 |
---|
Som en dokumentanvender ønsker jeg at fremsøge dokumentreference til en borgers stamkort, så jeg kan få adgang til borgerens stamkort |
FSK Registry Adapter er således en kilde, som DDS anvender til at understøtte fremsøgingsforespørgsler fra anvendere.
Nedenstående viser et eksempel, hvor en dokumentanvender (sundhedsfaglig) laver forespørgsel. For andre anvendertyper og brugsscenarier henvises til dokumentationen for Dokumentdelingsservicen.
Gliffy Diagram | ||||
---|---|---|---|---|
|
Således foregår en forespørgsel mod FSK Registry Adapter på følgende måde:
- Dokumentanvender laver en forespørgsel med DDS Registry for at fremsøge dokumenter for patient
- DDS Registry konsulterer MinSpærring for at afvise forespørglerforespørgsler, hvor der er spærringer (mod dokumentanvenderen)
- Tjek af behandlingsrelation (evt. opfølgning)
- Videredelegering af søgning til bagvedliggende registries (herunder FSK Registry Adapter)
- Der foretages evt. en filtrering af resultaterne, hvis der for patienten findes dataspecifikke spærringer
- DDS logger dataadgang til MinLog
DDS Registry forholder sig ikke til indholdet af den konkrete query, der kommer fra Dokumentanvenderen, men overlader til de bagvedliggende registre (herunder FSK Registry Adapter) at fortolke og besvare den konkrete query. I næste afsnit findes en detaljeret oversigt over, hvorledes FSK Registry Adapter fortolker indkommende queries.
FSK Registry Adapters fortolkning af forespørgsler
FSK Registry Adapter 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.
...
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 Adapter. Gennemgangen vil indeholde eksempler på queries, hvor dette giver mening.
FSK Registry Adapter melder tilbage til DDS med et response af DocumentEntries. Det dokumenteres, hvorledes en sådan DocumentEntry ser ud, og i hvor høj grad FSK Registry Adapter lever op til de krav, der er sat i Medcoms danske profilering af XDS Metadata.
FSK Registry Adapter Response Options
ReturnType kan som udgangspunkt antage een af følgende to værdier:
- LeafClass: Denne type returnerer en liste af XML elementer bestående af fuldt specificerede ebXML objekter, der matcher den modtagne query. Resultatlisten af objekter (ExtrinsicObject/XDSDocumentEntry) er helt selvindeholdt: Slots, external identifiers, classifications etc. Dvs alt, hvad der vides om de konkrete objekter returneres.
- ObjectRef: Denne type returnerer en liste af UUIDer som refererer objekter i et XDS Registry, der matcher den modtagne query.
FSK Registry Adapter ignorerer ReturnCompoesedObjects parameteren. Alle queries besvarersbesvares, somom denne parameter er true - dvs vi forventer et response.
FSK Registry Adapter ignorerer return type ReturnType 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).
FSK Registry Adapter QueryID (UUID)
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 Adapter forstår/understøtter den specifikke Query.
Query Name | Query ID | FSK Registry Adapter 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'.
FSK Registry Adapter Query Parameters
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 Registry Adapters 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 Registry Adapters fortolkning (hvis nogen) af den medsendte parameter samt evt. valideringer.
FSK Registry Adapter FindDocuments parametre
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. Kolonnen "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).Adapter understøttelse" beskriver for hver søgeparameter, hvordan FSK Registry Adapter forholder sig til denne: Bliver søgeparameteren anvendt eller ignoreret af FSK Registry Adapter? Og hvis den bliver anvendt af FSK Registry Adapter, hvordan bliver den så anvendt?
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 | OptMult | Multiple (lister af værdier) | FSK Registry Adapter understøttelse |
---|---|---|---|---|
$XDSDocumentEntryPatientId | XDSDocumentEntry.patientId | R | -- | Denne parameter skal angives. FSK Registry Adpter 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'. DDS foran FSK Registry har også valideringer på CPR numre, så denne validering burde ikke ramme anvendere. Dog skal det nævnes, at en konsekvens af denne validering er, at FSK Registry Adapter vil melde fejl tilbage til anvendere, der forespørger på erstatningsCPR. |
$XDSDocumentEntryReferenceIdList (5) | XDSDocumentEntry.referenceIdList (3) | R | M | Ingen fortolkning af FSK Registry |
$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 | Ingen fortolkning af FSK Registry |
$XDSDocumentEntryCreationTimeFrom | Lower value of XDSDocumentEntry.creationTime | O | -- | Ingen fortolkning af FSK Registry |
$XDSDocumentEntryCreationTimeTo | Upper value of XDSDocumentEntry.creationTime | O | -- | Ingen fortolkning af FSK Registry |
$XDSDocumentEntryServiceStartTimeFrom | Lower value of XDSDocumentEntry.serviceStartTime | O | -- | Ingen fortolkning af FSK Registry |
$XDSDocumentEntryServiceStartTimeTo | Upper value of XDSDocumentEntry.serviceStartTime | O | -- | Ingen fortolkning af FSK Registry |
$XDSDocumentEntryServiceStopTimeFrom | Lower value of XDSDocumentEntry.serviceStopTime | O | -- | Ingen fortolkning af FSK Registry |
$XDSDocumentEntryServiceStopTimeTo | Upper value of XDSDocumentEntry.serviceStopTime | O | -- | Ingen fortolkning af FSK Registry |
$XDSDocumentEntryHealthcareFacilityTypeCode (1) | XDSDocumentEntry.healthcareFacilityTypeCode | O | M | Ingen fortolkning af FSK Registry |
$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, hvor
|
...
Fra Medcoms danske profilering tabel 4 (de rækker der er relevante for DocumentEntries minus de rækker, der ikke er relevante for on-demand Entries) | ||||
Metadata attribute | Optional (IHE) | Optional (DK) | FSK Registry implementerings-status | Eksempel (udklip af response ovenfor) |
---|---|---|---|---|
author.authorInstituation | R | OK | <Slot name="authorInstitution"> | |
author.authorPerson | R2 | N/A | ||
availabilityStatus | R | R | OK | <ExtrinsicObject mimeType="text/xml" |
confidentialityCode | R | R | OK | <Classification classificationScheme="urn:uuid:f4f85eac-e6cb-4883-b524-f2705394840f" classifiedObject="1.2.208.176.43210.8.20.12^80c7deaf-bf77-4abd-a187-61ab8cad111e" nodeRepresentation="N" id="urn:uuid:7bcba75e-6abe-4e54-b03e-9cbe65f2e780"> |
contentTypeCode | R | - | OK | N/A (ikke brugt i den danske profilering) |
creationTime | R | R | OK | <Slot name="creationTime"> |
entryUUID | R | R | FSK Registry anvender unique id som entryUUID. Burde være et UUID (burde gemmes i FSK Registry databasen) | <ExtrinsicObject mimeType="text/xml" |
eventCodeList | O | R2 | OK | <Classification classificationScheme="urn:uuid:f0306f51-975f-434e-a61c-c59651d33983" classifiedObject="1.2.208.176.43210.8.20.12^80c7deaf-bf77-4abd-a187-61ab8cad111e" nodeRepresentation="52460-3" id="urn:uuid:66d7b10a-78ef-4e17-a58c-b96ca58a3114"> |
formatCode | R | R | OK | <Classification classificationScheme="urn:uuid:a09d5840-386c-46f2-b5ad-9c3699a4309d" classifiedObject="1.2.208.176.43210.8.20.12^80c7deaf-bf77-4abd-a187-61ab8cad111e" nodeRepresentation="DK FSK Schema" id="urn:uuid:6c86ab04-3cb9-4869-bb45-f44bc17b26ee"> <Slot name="codingScheme"> <ValueList> <Value>urn:ad:dk:medcom:fsk:full</Value> </ValueList> </Slot> <Name> <LocalizedString xml:lang="en-US" charset="UTF-8" value="DK FSK Schema"/> </Name> </Classification |
| ||||
healthcareFacilityTypeCode | R | R | OK | <Classification classificationScheme="urn:uuid:f33fb8ac-18af-42cc-ae0e-ed0b0bdb91e1" classifiedObject="1.2.208.176.43210.8.20.12^80c7deaf-bf77-4abd-a187-61ab8cad111e" nodeRepresentation="554041000005106" id="urn:uuid:ad3bebde-dfab-4ef0-a679-7b8271bc33c2"> |
homeCommunityId | R | R | OK | <ExtrinsicObject mimeType="text/xml" objectType="urn:uuid:34268e47-fdf5-41a6-ba33-82133c465248" status="urn:oasis:names:tc:ebxml-regrep:StatusType:Approved" id="1.2.208.176.43210.8.20.12^80c7deaf-bf77-4abd-a187-61ab8cad111e" home="1.2.208.176.8.1.12"> |
languageCode | R | R | OK | <Slot name="languageCode"> |
legalAuthenticator | O | R2 | OK | N/A |
mimeType | R | R | OK | <ExtrinsicObject mimeType="text/xml" objectType="urn:uuid:34268e47-fdf5-41a6-ba33-82133c465248" status="urn:oasis:names:tc:ebxml-regrep:StatusType:Approved" id="1.2.208.176.43210.8.20.12^80c7deaf-bf77-4abd-a187-61ab8cad111e" home="1.2.208.176.8.1.12"> |
objectType | R | R | Antager OK | Metadataprofilen udtaler sig kun om stable document entry men FKS Registrys angivelse af on-demand er sikkert ok <ExtrinsicObject mimeType="text/xml" |
patientId | M | R | Se sourcePatientId | |
practiceSettingCode | R | - | OK konkret værdi valgt udfra lovlige værdier i metadata value set | <Classification classificationScheme="urn:uuid:cccf5598-8b07-4b77-a05e-ae952c785ead" classifiedObject="1.2.208.176.43210.8.20.12^80c7deaf-bf77-4abd-a187-61ab8cad111e" nodeRepresentation="408443003" id="urn:uuid:37cfb6b2-7279-4230-b954-f088c7e62ffb"> |
referenceIdList | O | O | OK | N/A |
repositoryUniqueId | R | R | OK | <Slot name="repositoryUniqueId"> |
serviceStartTime | R2 | R2 | OK | N/A |
serviceStopTime | R2 | R2 | OK | N/A |
| ||||
sourcePatientId | R | R | OK | <Slot name="sourcePatientId"> |
sourcePatientInfo | R | R | Nej | FSK Registry Adapter har ikke tilstrækkeligt datagrundlag til levering af dette. I sin nuværende form er FSK Registry Adapters eneste "datakilde" den forespørgsel, der modtages. FSK Registry Adapter har således ingen integration til f.eks. CPR data. Bemærk at selve dokumentet dannes udenfor FSK Registry Adapter, og derfor indeholder data fra flere/andre kilder. |
title | O | R | OK..pånær forkert languagecode | <Name> |
typeCode | R | R | OK | <Classification classificationScheme="urn:uuid:f0306f51-975f-434e-a61c-c59651d33983" classifiedObject="1.2.208.176.43210.8.20.12^80c7deaf-bf77-4abd-a187-61ab8cad111e" nodeRepresentation="52460-3" id="urn:uuid:66d7b10a-78ef-4e17-a58c-b96ca58a3114"> |
uniqueId | R | R | OK | <ExternalIdentifier registryObject="1.2.208.176.43210.8.20.12^80c7deaf-bf77-4abd-a187-61ab8cad111e" identificationScheme="urn:uuid:2e82c1f6-a085-4c72-9da3-8640a32e42ab" value="1.2.208.176.43210.8.20.12^80c7deaf-bf77-4abd-a187-61ab8cad111e" id="urn:uuid:85402c9d-7cf7-4b25-bd36-3b72fa132b89"> |
URI | O | O | OK | N/A |
...