Norsk profil for XDS-metadata
Denne siden gir en beskrivelse av metadata for den norske XDS-profilen. Dette gjelder både hvilke attributter som skal brukes, hvordan attributtene skal brukes og hvilke kodesystemer som skal brukes. XDS er innholdsagnostisk, noe som betyr at det ikke har kjennskap til innholdet i dokumentet som deles eller gjøres tilgjengelig i en XDS-løsning.
Om dokumentet er en PDF, en XML-fil eller et bilde, spiller ingen rolle for XDS-løsningen – den vil uansett bare behandle filen som et dokument uten hensyn til innhold eller format.
Siden XDS-løsninger ikke har noen relasjon til innholdet i dokumentet, må det registreres metadata som blant annet beskriver det overordnede kliniske innholdet i dokumentene. Det er disse metadataene som brukes ved søk etter bestemte dokumenter. Metadataene er inndelt i følgende områder:
- Pasientidentitet: Attributt som identifiserer pasienten som et dokument omhandler, inkludert pasient-ID (fødselsnummer) og navn.
- Kilde/opprinnelse: Attributt som beskriver hvor dokumentet er generert.
- Sikkerhet og personvern: Attributt som beskriver sikkerhetsregler og kan brukes til å kontrollere tilgang til dokumentet.
- Innholdsbeskrivelse (deskriptiv): Attributt som beskriver det kliniske innholdet i dokumentet. Dette er et attributt som er viktig for å utføre søk og finne dokumenter basert på kliniske «søkeparametere».
- Dokumentstatus (objektlivssyklus): Attributt som beskriver statusen til dokumentet og eventuelle relasjoner til andre dokumenter. Utveksling: Attributt som beskriver hvordan dokumentet kan utveksles («pull» eller «push»)
Bruk av XDS og informasjonssikkerhet
Denne profilen beskriver ikke hvordan ulike brukere og løsninger skal få tilgang til dokumenter som gjøres tilgjengelige for oppslag i en XDS-løsning.
XDS har flere metadataattributter, som virksomheten (authorInstitution) som produserte dokumentet og dokumenttypen (classCode/typeCode), som kan gi grunnlag for hvordan sikkerhet og tilgangsstyring kan ivaretas.
Det er imidlertid ingen «innebygd» sikkerhet/tilgangskontroll i metadataattributtene direkte – dette må ivaretas av løsningene som til sammen utgjør ett eller flere XDS-områder og via systemløsningene som gir tilgang til dokumenter i en XDS-løsning
Profilbeskrivelse
Noen av XML-typene som beskrives nedenfor kan brukes til å representere ulike konsepter. Tabellen nedenfor beskriver de ulike typene.
| Dokumentdelingsobjekt/Assosiasjon | XML-typerepresentasjon |
|---|---|
| DocumentEntry | <ExtrinsicObject> |
| SubmissionSet | <RegistryPackage> |
| Folder | <RegistryPackage> |
| HasMember | <Association> |
| MemberOf | <Association> |
| Relationship | <Association> |
SubmissionSet (<RegistryPackage>)
SubmissionSet betyr at man sender inn flere dokumenter i en «pakke», og metadataene for SubmissionSet kan sammenlignes med pakkeetiketten på en pakke. Disse metadataene oppsummerer innholdet i SubmissionSet og hvordan dokumenter, relasjoner og mapper er plassert sammen. Et eksempel på når et SubmissionSet kan brukes, er når man ønsker å samle alle dokumenter knyttet til et sykehusopphold for en pasient. Når et SubmissionSet sendes inn, er det slik at enten alle dokumentene legges i dokumentarkivet, eller ingen. Det vil si at dersom det er en feil knyttet til ett av dokumentene, vil ingen av dokumentene bli lagt i arkivet.
DocumentEntry (<ExtrinsicObject>)
I denne sammenhengen er et DocumentEntry metadataene som er registrert på det enkelte dokumentet som skal gjøres tilgjengelig og deles i en XDS-løsning. Disse metadataene inneholder ikke innholdet i selve dokumentet, men kun metadata om dokumentet. Det finnes to typer DocumentEntry:
| Egenskap | Beskrivelse |
|---|---|
| Stable | urn:uuid:7edca82f-054d-47f2-a032-9b2a5b5186c1 |
| On-Demand | urn:uuid:34268e47-fdf5-41a6-ba33-82133c465248 |
StableDocumentEntry inneholder data om et dokument som allerede er generert og eksisterer, og som er tilgjengelig for nedlasting via XDS-løsningen.On-demandDocumentEntry inneholder metadata med en unik ID som kan brukes til å generere et dokument når det er gjort en forespørsel om dokumentet med den ID-en.
🚩 Merk!
PJD.XcaDocumentSource samt alle dokumentkilder i Norge støtter kun Stable-dokumenter. Dette er beskrevet for informasjonsformål.
Bruken av On-demand-dokumenter i dokumentdeling i Norge støttes ikke.
Association (<Association>)
En <Association> brukes til å binde to eller flere typer sammen for å skape en logisk forbindelse mellom dem. Dette gjøres ved hjelp av attributtene sourceObject og targetObject, som refererer til de unike identifikatorene til de tilknyttede typene. En <Association> kan ha flere tilstander basert på sin associationType
Folder (<RegistryPackage>)
En Folder er en logisk samling av dokumenter som har en relasjon til hverandre. En Folder kan oppdateres av flere SubmissionSets, også sendt fra flere ulike virksomheter. Dette kan for eksempel være for å samle alle dokumenter som tilhører en laboratorieundersøkelse, både laboratorierekvisjonen og tilhørende laboratoriesvar. Dette dokumentet beskriver ikke spesifikt hvordan Folder skal brukes.
Oversikt over XDS-attributter
XDS-metadata i norsk profil
Følgende koder brukes for å angi om et metadataattributt er obligatorisk eller valgfritt:
| Kode | Required | Forklaring |
|---|---|---|
| R | Required | Attributtet er obligatorisk og skal alltid oppgis |
| R2 | Required if known | Attributtet skal oppgis dersom informasjonen er kjent for systemet og tilgjengelig. |
| O | Optional | Attributtet er valgfritt, og hver aktør som oppretter dokumenter bør avgjøre om attributtet skal brukes eller ikke. |
| - | Should not be used | Attributtet skal ikke brukes. |
Et system integrert med en XDS-løsning må kunne motta og håndtere alle attributter angitt med kodene R, R2 eller O.
For noen attributter kan innholdet som skal registreres for de ulike metadataattributtene hentes fra ulike datakilder. For eksempel kan datakildene være et epikrisdokument som inneholder informasjon som kan inkluderes i ett eller flere metadataattributter. Hvilke datakilder som kan være relevante for ulike metadataattributter kan variere mellom ulike løsninger/faglige systemer som brukes.
Tabellen nedenfor viser mulige datakilder for metadatainformasjonen.
| Kode | Beskrivelse |
|---|---|
| AUT | Metadata som genereres automatisk eller tildeles av enten XDS-registeret eller XDS-repositoriet |
| CDA | Data som kan hentes fra overskriften til et HL7 CDA-dokument (eller tilsvarende) |
| HM | Data som kan hentes fra overskriften; gjelder alle meldinger som bruker en overskrift (f.eks. e-resept) for å angi avsender, mottaker og pasient. |
| HCP | Data som kan hentes fra standarder som bruker HCP-strukturen (HCP = Health Care Professional). Dette gjelder standarder for henvisning, kliniske sammendrag, laboratorierekvisjon og svar. |
| IA | IA = Ikke Angitt. Attributtet skal brukes i den norske profilen, men det kan være en forskjell i hvor informasjonen hentes fra. Det er opp til hver aktør å avgjøre hva som er en relevant kilde. |
| Attributt | DocumentEntry | SubmissionSet | Obligatorisk IHE | Obligatorisk NO | Datatype | Mulig datakilde |
|---|---|---|---|---|---|---|
| Author | X | X | R | R2 | - | |
| author.authorInstitution | X | X | - | R2 | XON | HM/HCP/CDA |
| author.authorPerson | X | X | - | R2 | XCN | HM/HCP/CDA |
| author.authorRole | X | X | - | O | String | HM/HCP/CDA |
| author.authorSpeciality | X | X | - | O | String | HM/HCP/CDA |
| availabilityStatus | X | X | R | R | URN | IA |
| classCode | X | - | R | R | Code | IA |
| comments | - | - | - | - | - | - |
| confidentialityCode | X | - | R | R | Code | IA |
| contentTypeCode | - | - | - | - | - | - |
| creationTime | X | - | R | R | - | HM/HCP/CDA |
| entryUUID | X | X | R | R | String | AUT |
| eventCodeList | X | - | O | R2 | Code | HCP/CDA |
| formatCode | X | - | R | R | Code | IA |
| hash1 | X | - | R | R | SHA1 | AUT |
| healthcareFacilityTypeCode | X | - | R | R | Code | IA |
| homeCommunityId | X | X | R | R | OID URN | IA |
| intendedRecipient | - | - | - | (O)2 | - | - |
| languageCode | X | - | R | R | CS | IA |
| legalAuthenticator | X | O | R2 | XCN | IA | (CDA, HCP) |
| limitedMetadata | - | - | - | - | - | - |
| mimeType | X | R | R | String | IA | - |
| objectType | X | R | R | UUID | IA | - |
| patientId | X | R | R | CX | HM/HCP/CDA | - |
| practiceSettingCode | X | R | R2 | Code | IA | - |
| referenceIdList | X | O | O | CXi | IA | - |
| repositoryUniqueId | X | R | R | OID | AUT | - |
| serviceStartTime | X | R2 | R2 | DTM | IA | - |
| serviceStopTime | X | R2 | R2 | DTM | IA | - |
| size3 | X | R | R | Integer | AUT | - |
| sourceId | X | - | O | OID | - | - |
| sourcePatientId | X | R | R | CX | HM/HCP/CDA | - |
| sourcePatientInfo | X | R | R | PID | HM/HCP/CDA | - |
| submissionTime | X | R | R | DTM | IA | - |
| title | X | X | O | O | String | HM/HCP/CDA |
| typeCode | X | R | R | Code | HM/HCP/CDA | - |
| uniqueId | X | X | R | R | OID | HM/HCP/CDA |
| URI | X | R2 | R2 | URI | AUT | - |
1 Dette attributtet skal ikke brukes for dokumenter av typen «on-demand».
2 Dette attributtet er ikke en del av profilen, men kan prøves ut.
3 Dette attributtet skal ikke brukes for dokumenter av typen «on-demand».
Datatyper
Datatypene som brukes er i henhold til XDS-spesifikasjonen fra IHE.
OID-er
Tabellen nedenfor gir en oversikt over hvilke OID-er (Object-identifiers) som brukes i metadataprofilen.
| Kategori | OID |
|---|---|
| Kodeverk på Volven.no | 2.16.578.1.12.4.1.1.XXXX |
| Fødselsnummer | 2.16.578.1.12.4.1.4.1 |
| D-nummer | 2.16.578.1.12.4.1.4.2 |
| Felles hjelpenummer | 2.16.578.1.12.4.1.4.3 |
| HPR-nummer | 2.16.578.1.12.4.1.4.4 |
| Duf-nummer | 2.16.578.1.12.4.1.4.5 |
| Organisasjonsnummer | 2.16.578.1.12.4.1.4.101 |
UUID-er i bruk i metadata
Submission Set
| UUID | Bruk/Betydning |
|---|---|
| urn:uuid:a54d6aa5-d40d-43f9-88c5-b4633d873bdd | SubmissionSet ClassificationNode |
| urn:uuid:a7058bb9-b4e4-4307-ba5b-e3f0ab85e12d | author External Classification Scheme |
| urn:uuid:aa543740-bdda-424e-8c96-df4873be8500 | contentTypeCode External Classification Scheme |
| urn:uuid:6b5aea1a-874d-4603-a4bc-96a0a7b38446 | patientId External Identifier |
| urn:uuid:554ac39e-e3fe-47fe-b233-965d2a147832 | sourceId External Identifier |
| urn:uuid:96fdda7c-d067-4183-912e-bf5ee74998a8 | uniqueId External Identifier |
DocumentEntry-objekt
| UUID | Bruk/Betydning |
|---|---|
| urn:uuid:93606bcf-9494-43ec-9b4e-a7748d1a838d | author External Classification Scheme |
| urn:uuid:41a5887f-8865-4c09-adf7-e362475b143a | classCode External Classification Scheme |
| urn:uuid:f4f85eac-e6cb-4883-b524-f2705394840f | confidentialityCode External Classification Scheme |
| urn:uuid:2c6b8cb7-8b2a-4051-b291-b1ae6a575ef4 | eventCodeList External Classification Scheme |
| urn:uuid:a09d5840-386c-46f2-b5ad-9c3699a4309d | formatCode External Classification Scheme |
| urn:uuid:f33fb8ac-18af-42cc-ae0e-ed0b0bdb91e1 | healthCareFacilityTypeCode External Classification Scheme |
| urn:uuid:58a6f841-87b3-4a3e-92fd-a8ffeff98427 | patientId ExternalIdentifier |
| urn:uuid:cccf5598-8b07-4b77-a05e-ae952c785ead | practiceSettingCode External Classification Scheme |
| urn:uuid:f0306f51-975f-434e-a61c-c59651d33983 | typeCode External Classification Scheme |
| urn:uuid:2e82c1f6-a085-4c72-9da3-8640a32e42ab | uniqueId ExternalIdentifier |
XDS-attributter i norsk profil
AuthorInstitution
| Attributtnavn | AuthorInstitution | |
|---|---|---|
| Beskrivelse og bruk | Skal inneholde navn og identifikator for organisasjonen som har produsert dokumentet. Organisasjonsnummer skal brukes som identifikator. | |
| Obligatorisk/ valgfritt |
DocumentEntry | R2 |
| SubmissionSet | R2 | |
| Datakilde | HM (meldinger som bruker Head Message), HCP (meldinger som bruker HealthCareProfessional-strukturen) og CDA. | |
| Datatype | XON - HL7 V2.5 Organization Name | |
| Kodesystem/ spesifikasjon |
Følgende koder kan brukes:
|
|
| XML-eksempel (med ebRIM) |
Eksempel der St. Olavs Hospital HF med organisasjonsnummer 883974832 brukes.
Samme eksempel men med RESH-ID:
|
|
AuthorPerson
| Attributtnavn | AuthorPerson | |
|---|---|---|
| Beskrivelse og bruk | Må inneholde navn og identifikator for personen som er forfatter av dokumentet. Dersom dokumentet ikke er forfattet av en person, kan feltet stå uten innhold. Nasjonale identifikatorer for personer kan brukes. |
|
| Obligatorisk/ valgfritt |
DocumentEntry | R2 |
| SubmissionSet | R2 | |
| Datakilde | HM (meldinger som bruker Head Message), HCP (meldinger som bruker HealthCareProfessional-strukturen) og CDA. | |
| Datatype | XCN - HL7 V2.5 Extended Person Name | |
| Kodesystem/ spesifikasjon |
Følgende koder kan brukes:
|
|
| XML-eksempel (med ebRIM) |
Eksempel der Magnar Koman er angitt med HPR-nummer 9144889:
|
|
AuthorRole
| Attributtnavn | AuthorRole | |
|---|---|---|
| Beskrivelse og bruk | Dersom informasjon om forfatterens rolle er kjent, kan dette oppgis. | |
| Obligatorisk/ valgfritt |
DocumentEntry | O |
| SubmissionSet | O | |
| Datakilde | HM (meldinger som bruker Head Message), HCP (meldinger som bruker HealthCareProfessional-strukturen) og CDA. | |
| Datatype | CX | |
| Kodesystem/ spesifikasjon |
Kodesystem 9034 Helsepersonells funksjoner må brukes for å angi rollen. Kodeverdien må angis, se eksempel nedenfor. |
|
| XML-eksempel (med ebRIM) |
|
|
AuthorSpeciality
| Attributtnavn | AuthorSpeciality | |
|---|---|---|
| Beskrivelse og bruk | Dersom informasjon om forfatterens spesialitet er kjent, må dette oppgis. | |
| Obligatorisk/ valgfritt |
DocumentEntry | O |
| SubmissionSet | O | |
| Datakilde | HM (meldinger som bruker Head Message), HCP (meldinger som bruker HealthCareProfessional-strukturen) og CDA. | |
| Datatype | CX | |
| Kodesystem/ spesifikasjon |
Kodesystem 7426 Helsepersonellregisterets (HPR) klassifikasjon av spesialiteter skal brukes for å angi rollen. | |
| XML-eksempel (med ebRIM) |
|
|
availabilityStatus
| Attributtnavn | availabilityStatus | |
|---|---|---|
| Beskrivelse og bruk | Angir status for dokumentet, to statuser er mulige:
|
|
| Obligatorisk/ valgfritt |
DocumentEntry | R |
| SubmissionSet | R | |
| Datakilde | IA (Ikke angitt). Hver aktør må selv avgjøre hvor denne informasjonen kan hentes fra. | |
| Datatype | String | |
| Kodesystem/ spesifikasjon |
Kodesystem 7426 Helsepersonellregisterets (HPR) klassifikasjon av spesialiteter skal brukes for å angi rollen. | |
| XML-eksempel (med ebRIM) |
|
|
classCode
| Attributtnavn | classCode | |
|---|---|---|
| Beskrivelse og bruk | classCode-attributtet bør beskrive hvilken dokumentgruppe dokumentet tilhører på et generelt nivå. Dette attributtet må ses i sammenheng med typeCode-attributtet (se kapittel 3.5.31), som er ment å beskrive dokumenttypen på et mer detaljert nivå. | |
| Obligatorisk/ valgfritt |
DocumentEntry | R |
| SubmissionSet | - | |
| Datakilde | IA (Ikke angitt). Hver aktør må selv avgjøre hvor denne informasjonen kan hentes fra. | |
| Datatype | String | |
| Kodesystem/ spesifikasjon |
classCode-attributtet bør ha følgende urn for classificationScheme: urn:uuid:41a5887f-8865-4c09-adf7-e362475b143a. Kodet som en ebRIM-klassifikasjon. Nivå 1-koder bør brukes (koder som slutter på «-1») i classCode-attributtet. OID: 2.16.578.1.12.4.1.1.9602 |
|
| XML-eksempel (med ebRIM) |
Kodeverdi = "1-A00" Kodetekst = "Discharge summaries and summaries" Kodesystem = "2.16.578.1.12.4.1.1.9602"
|
|
comments
comments-attributtet brukes ikke i denne profilen.
confidentialityCode
| Attributtnavn | confidentialityCode | |
|---|---|---|
| Beskrivelse og bruk |
Dette attributtet angir hvilken konfidensialitetsgruppe dokumentet tilhører.
I Norge er det en distinksjon som vanligvis ikke er basert på ulike grader av konfidensialitet for dokumenter som inneholder helse- og personopplysninger. Det vil derfor ofte bare være kodeverdien «Normal» («N») som er relevant å bruke for dette attributtet.
Utvidet bruk av attributtet er vedtatt. Dersom det er behov for å sette «sperring» og «nekting» av dokumenter, må dette attributtet brukes inntil en felles løsning for tilgangsstyring/sperringshåndtering er etablert. |
|
| Obligatorisk/ valgfritt |
DocumentEntry | R |
| SubmissionSet | - | |
| Datakilde | IA (Ikke angitt). Hver aktør må selv avgjøre hvor denne informasjonen kan hentes fra. | |
| Datatype | Code | |
| Kodesystem/ spesifikasjon |
confidentialityCode bør ha følgende URN for classificationScheme: urn:uuid:f4f85eac-e6cb-4883-b524-f2705394840f.
Følgende kodesystem må brukes for å angi konfidensialitet, sperring og nekting av dokumenter: |
|
| XML-eksempel (med ebRIM) |
|
|
contentTypeCode
contentTypeCode-attributtet brukes ikke i denne profilen
creationTime
| Attributtnavn | creationTime | |
|---|---|---|
| Beskrivelse og bruk | Dette attributtet angir tidspunktet da forfatteren opprettet dokumentet. | |
| Obligatorisk/ valgfritt |
DocumentEntry | R |
| SubmissionSet | - | |
| Datakilde | HM (meldinger som bruker Head Message), HCP (meldinger som bruker HealthCareProfessional-strukturen) og CDA. For Header Message kan tidspunktet hentes fra elementet MsgHead/MsgInfo/GenDate. | |
| Datatype | DTM - HL7 V2.5 Date Time | |
| Kodesystem/ spesifikasjon |
Alle tidspunkter må angis i formatet: YYYYMMDDhhmmss YYYY = år MM = måned DD = dag hh = timer mm = minutter ss = sekunder Alle tidspunkter må angis i UTC-tidssone |
|
| XML-eksempel (med ebRIM) |
Eksempel på tidspunktet 25. august 2015 kl. 15:37:20 UTC:
|
|
entryUUID
| Attributtnavn | ||
|---|---|---|
| Beskrivelse og bruk | Dette attributtet angir en globalt unik identifikator for dokumentet. entryUUID er primært en ID beregnet for intern dokumenthåndtering. Dette er i motsetning til uniqueId-attributtet som primært brukes for eksterne referanser (f.eks. lenker osv.). | |
| Obligatorisk/ valgfritt |
DocumentEntry | R |
| SubmissionSet | R | |
| Datakilde | AUT: Metadata som genereres automatisk eller tildeles av enten XDS-registeret eller XDS-repositoriet. | |
| Datatype | String | |
| Kodesystem/ spesifikasjon |
UUID-en må være i formatet |
|
| XML-eksempel (med ebRIM) |
|
|
eventCodeList
| Attributtnavn | eventCodeList | |
|---|---|---|
| Beskrivelse og bruk | eventCodeList beskriver de kliniske tiltakene/prosedyrene som er utført. | |
| Obligatorisk/ valgfritt |
DocumentEntry | O |
| SubmissionSet | - | |
| Datakilde | HCP (meldinger som bruker HealthCareProfessional-strukturen) og CDA. | |
| Datatype | Code | |
| Kodesystem/ spesifikasjon |
Følgende prosedyrekodesystemer kan brukes:
classificationScheme = urn:uuid:2c6b8cb7-8b2a-4051-b291b1ae6a575ef4 |
|
| XML-eksempel (med ebRIM) |
|
|
formatCode
| Attributtnavn | formatCode | |
|---|---|---|
| Beskrivelse og bruk | Dette bør være en unik kode som beskriver formatet på dokumentet. Formen på koden bør være en URN. Sammen med typeCode bør dette være tilstrekkelig informasjon for en «XDS-konsument» til å avgjøre om man er i stand til å behandle dokumentet. | |
| Obligatorisk/ valgfritt |
DocumentEntry | R |
| SubmissionSet | - | |
| Datakilde | IA (Ikke angitt). Hver aktør må selv avgjøre hvor denne informasjonen kan hentes fra. | |
| Datatype | Code | |
| Kodesystem/ spesifikasjon |
formatCode-attributtet bør ha følgende urn for classificationScheme: UUID: A09D5840-386C-46F2-B5AD-9C3699A4309D
|
|
| XML-eksempel (med ebRIM) |
|
|
hash
| Attributtnavn | hash | |
|---|---|---|
| Beskrivelse og bruk | Dette er en hash av innholdet i dokumentet. | |
| Obligatorisk/ valgfritt |
DocumentEntry | R |
| SubmissionSet | - | |
| Datakilde | AUT: Metadata som genereres automatisk eller tildeles av enten XDS-registeret eller XDS-repositoriet. | |
| Datatype | SHA1 | |
| Kodesystem/ spesifikasjon |
Formatet på hash-verdien skal være SHA1 i henhold til IHE-spesifikasjonen. | |
| XML-eksempel (med ebRIM) |
|
|
healthcareFacilityTypeCode
| Attributtnavn | healthcareFacilityTypeCode | |
|---|---|---|
| Beskrivelse og bruk | Beskriver typen helseinstitusjonen som genererte dokumentet metadataene gjelder for. | |
| Obligatorisk/ valgfritt |
DocumentEntry | R |
| SubmissionSet | - | |
| Datakilde |
IA (Ikke angitt). Hver aktør må selv avgjøre hvor denne informasjonen kan hentes fra. |
|
| Datatype | Code | |
| Kodesystem/ spesifikasjon |
Kodesystem 1303 Næringstype (SN 2007) skal brukes. |
|
| XML-eksempel (med ebRIM) |
|
|
homeCommunityID
| Attributtnavn | homeCommunityId | |
|---|---|---|
| Beskrivelse og bruk |
Dette er en unik ID, i form av en OID, for hvor dokumentet befinner seg (dvs. i hvilket repositorium dokumentet befinner seg). |
|
| Obligatorisk/ valgfritt |
DocumentEntry | R |
| SubmissionSet | R | |
| Datakilde | AUT: tildeles av enten repositorie- eller registreringsløsningen. | |
| Datatype | OID URN | |
| Kodesystem/ spesifikasjon |
||
| XML-eksempel (med ebRIM) |
|
|
intendedRecipient
Attributtet er valgfritt for de som ønsker å prøve det ut.
| Attributtnavn | intendedRecipient | |
|---|---|---|
| Beskrivelse og bruk | Organisasjonen(e) eller personen(e) som dokumentet er beregnet for. | |
| Obligatorisk/ valgfritt |
DocumentEntry | - |
| SubmissionSet | O | |
| Datakilde |
IA (Ikke angitt). Hver aktør må selv avgjøre hvor denne informasjonen kan hentes fra. |
|
| Datatype | ebRIM Slot | |
| Kodesystem/ spesifikasjon |
XON|XCN|XTN, der;
|
|
| XML-eksempel (med ebRIM) |
|
|
languageCode
| Attributtnavn | languageCode | |
|---|---|---|
| Beskrivelse og bruk | Angir språket som brukes i dokumentet | |
| Obligatorisk/ valgfritt |
DocumentEntry | R |
| SubmissionSet | - | |
| Datakilde | AUT | |
| Datatype | CS | |
| Kodesystem/ spesifikasjon |
languageCode bør være i formen nn-CC. Innholdet må være i samsvar med IETF (Internet Engineering Task Force) RFC 5646. Bruk: |
|
| XML-eksempel (med ebRIM) |
|
|
legalAuthenticator
| Attributtnavn | legalAuthenticator | |
|---|---|---|
| Beskrivelse og bruk |
Må inneholde navn og identifikator for personen som har godkjent eller signert dokumentet («juridisk godkjent eller bekreftet dokumentet»). |
|
| Obligatorisk/ valgfritt |
DocumentEntry | R2 |
| SubmissionSet | - | |
| Datakilde |
IA (Ikke angitt). Hver aktør må selv avgjøre hvor denne informasjonen kan hentes fra. |
|
| Datatype | XCN - HL7 V2.5 Extended Person Name | |
| Kodesystem/ spesifikasjon |
Følgende koder kan brukes:
|
|
| XML-eksempel (med ebRIM) |
Eksempel der Magnar Koman er angitt med HPR-nummer 9144889:
|
|
limitedMetadata
limitedMetadata-attributtet brukes ikke i denne profilen.
mimeType
| Attributtnavn | mimeType | |
|---|---|---|
| Beskrivelse og bruk | Må beskrive MIME-typen til dokumentet i repositoriet (dokumentarkivet). | |
| Obligatorisk/ valgfritt |
DocumentEntry | R |
| SubmissionSet | - | |
| Datakilde |
IA (Ikke angitt). Hver aktør må selv avgjøre hvor denne informasjonen kan hentes fra. |
|
| Datatype | String | |
| Kodesystem/ spesifikasjon |
MIME-typen skal være en «Internet Media Type» i henhold til «MIME»-standarden beskrevet i RFC 2045 til RFC 2049. Gyldige MIME-typer finnes hos IANA Media Types |
|
| XML-eksempel (med ebRIM) |
|
|
objectType
| Attributtnavn | objectType | |
|---|---|---|
| Beskrivelse og bruk |
objectType beskriver typen documentEntry som dokumentet tilhører.
|
|
| Obligatorisk/ valgfritt |
DocumentEntry | R |
| SubmissionSet | - | |
| Datakilde |
IA (Ikke angitt). Hver aktør må selv avgjøre hvor denne informasjonen kan hentes fra. |
|
| Datatype | UUID | |
| Kodesystem/ spesifikasjon |
Formatet på verdien i objectType skal være av typen UUID. |
|
| XML-eksempel (med ebRIM) |
|
|
patientId
| Attributtnavn | patientId | |
|---|---|---|
| Beskrivelse og bruk |
En unik identifikator for pasienten, nasjonale identifikatorer som fødselsnummer og D-nummer kan brukes. |
|
| Obligatorisk/ valgfritt |
DocumentEntry | R |
| SubmissionSet | - | |
| Datakilde |
HM (meldinger som bruker Head Message), HCP (meldinger som bruker HealthCareProfessional-strukturen) og CDA. |
|
| Datatype | CX (ebRIM Slot), HL7 V2.5 Identifier | |
| Kodesystem/ spesifikasjon |
Følgende OID-er for nasjonale identifikatorer kan brukes:
|
|
| XML-eksempel (med ebRIM) |
Eksempel der fødselsnummer er angitt:
|
|
practiceSettingCode
| Attributtnavn | practiceSettingCode | |
|---|---|---|
| Beskrivelse og bruk | Brukes for å angi typen helsetjeneste som tilbys ved institusjonen/enheten. | |
| Obligatorisk/ valgfritt |
DocumentEntry | R2 |
| SubmissionSet | - | |
| Datakilde | IA (Ikke angitt). Hver aktør må selv avgjøre hvor denne informasjonen kan hentes fra. | |
| Datatype | ||
| Kodesystem/ spesifikasjon |
Følgende kodesystemer kan være relevante:
|
|
| XML-eksempel (med ebRIM) |
|
|
referenceIdList
| Attributtnavn | referenceIdList | |
|---|---|---|
| Beskrivelse og bruk | Eksempler på slike identifikatorer kan være ordrenumre eller henvisnings-ID-er. | |
| Obligatorisk/ valgfritt |
DocumentEntry | O |
| SubmissionSet | - | |
| Datakilde | IA (Ikke angitt). Hver aktør må selv avgjøre hvor denne informasjonen kan hentes fra. | |
| Datatype | CXi | |
| Kodesystem/ spesifikasjon |
Kodet som et ebRIM-spor. Maksimal lengde for hver verdi er 256 tegn. «name» i ebRIM-sporet skal være «urn:ihe:iti:xds:2013:referenceIdList». |
|
| XML-eksempel (med ebRIM) |
|
|
repositoryUniqueId
| Attributtnavn | repositoryUniqueId | |
|---|---|---|
| Beskrivelse og bruk |
Dette attributtet bør inneholde en globalt unik ID som identifiserer repositoriet der det refererte dokumentet kan finnes. Hvert repositorium bør ha sin egen OID. |
|
| Obligatorisk/ valgfritt |
DocumentEntry | R |
| SubmissionSet | - | |
| Datakilde | AUT: Fast verdi for det individuelle XDS-repositoriet. | |
| Datatype | OID | |
| Kodesystem/ spesifikasjon |
Kodet som et ebRIM-spor. Maksimal lengde er 64 tegn. |
|
| XML-eksempel (med ebRIM) |
|
|
serviceStartTime
| Attributtnavn | serviceStartTime | |
|---|---|---|
| Beskrivelse og bruk |
Inneholder dato og klokkeslett for når den kliniske tjenesten/kontakten beskrevet i dokumentet startet. Dette er ikke nødvendigvis når dokumentet ble opprettet eller godkjent, men når den kliniske tjenesten startet. Dette kan være det samme som tidspunktet for kontakten dersom tjenesten ble levert under en kontakt. Tidspunktet for kontakten er ikke angitt i metadata, men kan angis i selve dokumentet. |
|
| Obligatorisk/ valgfritt |
DocumentEntry | R2 |
| SubmissionSet | - | |
| Datakilde | IA (Ikke angitt). Hver aktør må selv avgjøre hvor denne informasjonen kan hentes fra. | |
| Datatype | DTM, HL7 V2.5 Date Time | |
| Kodesystem/ spesifikasjon |
Kodet som et ebRIM-spor. | |
| XML-eksempel (med ebRIM) |
Eksempel: 16. oktober 2015, 21:20:10 UTC
|
|
serviceStopTime
| Attributtnavn | serviceStopTime | |
|---|---|---|
| Beskrivelse og bruk | Inneholder dato og klokkeslett for når den kliniske tjenesten/kontakten beskrevet i dokumentet ble avsluttet. Dette er ikke nødvendigvis når dokumentet ble opprettet eller godkjent, men når den kliniske tjenesten ble fullført. Dette kan være det samme som tidspunktet for kontakten dersom tjenesten ble levert under en kontakt. Tidspunktet for kontakten er ikke angitt i metadata, men kan angis i selve dokumentet. | |
| Obligatorisk/ valgfritt |
DocumentEntry | R2 |
| SubmissionSet | - | |
| Datakilde | IA (Ikke angitt). Hver aktør må selv avgjøre hvor denne informasjonen kan hentes fra. | |
| Datatype | DTM, HL7 V2.5 Date Time | |
| Kodesystem/ spesifikasjon |
Kodet som et ebRIM-spor. | |
| XML-eksempel (med ebRIM) |
Eksempel: 16. oktober 2015, 22:35:45 UTC
|
|
size
| Attributtnavn | size | |
|---|---|---|
| Beskrivelse og bruk |
Størrelsen på dokumentet i bytes. Merk: Dokumentkilden der dokumentet produseres skal ikke oppgi størrelse, men dette må registreres av dokumentrepositorieet dersom det ikke er angitt av dokumentkilden. |
|
| Obligatorisk/ valgfritt |
DocumentEntry | R |
| SubmissionSet | - | |
| Datakilde | AUT: Metadata som genereres automatisk eller tildeles av enten XDS-registeret eller XDS-repositoriet. | |
| Datatype | Int | |
| Kodesystem/ spesifikasjon |
Kodet som et ebRIM-spor, maks 256 tegn. | |
| XML-eksempel (med ebRIM) |
|
|
sourcePatientId
| Attributtnavn | sourcePatientId | |
|---|---|---|
| Beskrivelse og bruk | Identifikator for pasienten slik den er registrert i kildesystemet der dokumentet ble produsert. Kan være både nasjonale identifikatorer som fødselsnummer eller lokale ID-er, avhengig av hva som brukes i kildesystemet. | |
| Obligatorisk/ valgfritt |
DocumentEntry | R |
| SubmissionSet | - | |
| Datakilde | HM (meldinger som bruker Head Message), HCP (meldinger som bruker HealthCareProfessional-strukturen) og CDA. | |
| Datatype | HL7 v2.5 CX data type | |
| Kodesystem/ spesifikasjon |
Kodet som et ebRIM-spor. Maksimal lengde er 256 tegn. Følgende identifikator-OID-er kan brukes:
|
|
| XML-eksempel (med ebRIM) |
|
|
sourcePatientInfo
| Attributtnavn | sourcePatientInfo | |
|---|---|---|
| Beskrivelse og bruk |
Demografiske data for pasienten som var gjeldende på tidspunktet da dokumentet ble registrert i repositoriet.
Informasjonen skal ikke oppdateres etter at dokumentet er registrert. Det må registreres informasjon om:
|
|
| Obligatorisk/ valgfritt |
DocumentEntry | R |
| SubmissionSet | - | |
| Datakilde | HM (meldinger som bruker Head Message), HCP (meldinger som bruker HealthCareProfessional-strukturen) og CDA. | |
| Datatype | PID (Patient Identification) | |
| Kodesystem/ spesifikasjon |
Kodet som et ebRIM-spor. Maksimal lengde er 256 tegn. Attributtet skal ha verdier for: PID-5 (kildepatientnavn) PID-7 (kildepatientens fødselsdato) PID-8 (kildepatientens kjønn) PID-8 kan ha følgende verdier: M – Mann F – Kvinne O – Annet U – Ukjent |
|
| XML-eksempel (med ebRIM) |
Eksempeldata: Fornavn = Roland Mellomnavn = Arne Etternavn = Gundersen Fødselsdato: 15.7.1965 Kjønn: Mann
|
|
submissionTime
| Attributtnavn | submissionTime | |
|---|---|---|
| Beskrivelse og bruk | Tidspunktet da submission set-et ble sendt inn. Må oppgis av kildesystemet. | |
| Obligatorisk/ valgfritt |
DocumentEntry | - |
| SubmissionSet | R | |
| Datakilde | IA (Ikke angitt). Hver aktør må selv avgjøre hvor denne informasjonen kan hentes fra. | |
| Datatype | DTM, HL7 V2.5 Date Time | |
| Kodesystem/ spesifikasjon |
Kodet som et ebRIM-spor. Maksimal lengde er 256 tegn. | |
| XML-eksempel (med ebRIM) |
Tidspunkt: 26. oktober 2015, kl. 16:30:00:
|
|
title
| Attributtnavn | title | |
|---|---|---|
| Beskrivelse og bruk | Beskriver tittelen på dokumentet. | |
| Obligatorisk/ valgfritt |
DocumentEntry | O |
| SubmissionSet | O | |
| Datakilde | HM (meldinger som bruker Head Message), HCP (meldinger som bruker HealthCareProfessional-strukturen) og CDA. | |
| Datatype | String | |
| Kodesystem/ spesifikasjon |
Maksimal lengde er 128 tegn. Tittelen angis i ebXML ved hjelp av verdiattributtet i LocalizedString-elementet. |
|
| XML-eksempel (med ebRIM) |
|
|
typeCode
| Attributtnavn | typeCode | |
|---|---|---|
| Beskrivelse og bruk |
typeCode-attributtet bør beskrive hvilken dokumentgruppe dokumentet tilhører på et detaljert nivå. Dette attributtet må ses i sammenheng med classCode-attributtet, som er ment å beskrive dokumenttypen på et mer generelt nivå. |
|
| Obligatorisk/ valgfritt |
DocumentEntry | R |
| SubmissionSet | - | |
| Datakilde | IA (Ikke angitt). Hver aktør må selv avgjøre hvor denne informasjonen kan hentes fra. | |
| Datatype | Code | |
| Kodesystem/ spesifikasjon |
ClassificationScheme skal alltid ha verdien: urn:uuid:f0306f51-975f-434e-a61c-c59651d33983
Kodet som en ebRIM-klassifikasjon. Kodesystemer for dokumenttyper som skal brukes i classCode- og typeCode-attributtene er beskrevet i Volven 9602. Nivå 2-koder bør brukes (koder som slutter på «-2») i typeCode-attributtet. OID: 2.16.578.1.12.4.1.1.9602 |
|
| XML-eksempel (med ebRIM) |
kode = "A03-2" visningsverdi = "Epikrise" Kodesystem = "2.16.578.1.12.4.1.1.9602"
|
|
uniqueId
| Attributtnavn | uniqueId | |
|---|---|---|
| Beskrivelse og bruk | Unik ID for dokumentet satt av personen eller systemet som genererte dokumentet. | |
| Obligatorisk/ valgfritt |
DocumentEntry | R |
| SubmissionSet | R | |
| Datakilde | HM (meldinger som bruker Head Message), HCP (meldinger som bruker HealthCareProfessional-strukturen) og CDA. | |
| Datatype | Identifier | |
| Kodesystem/ spesifikasjon |
Hentet fra IHE ITI
TF-3: Dokumentopprettere bør bruke OID-er i punktnotasjon (se OID i tabell 4.2.3.1.7-2) som uniqueId-er, med følgende unntak: For dokumenter som bruker HL7v3 Instance Identifiers (f.eks. CDA-er) med et extension-attributt, bør uniqueId være en serialisering av root- og extension-attributtene i formen root^extension. Eksempelet nedenfor viser tillatt bruk av CDA. UUID kan også brukes. Kodet som en ebRIM ExternalIdentifier |
|
| XML-eksempel (med ebRIM) |
|
|
URI
| Attributtnavn | URI | |
|---|---|---|
| Beskrivelse og bruk |
URI for hvor XDS-dokumentet kan hentes. Når det brukes i Register Document Set-transaksjonen, inneholder dette URI-en til XDS-dokumentet som skal brukes for henting. |
|
| Obligatorisk/ valgfritt |
DocumentEntry | R2 |
| SubmissionSet | - | |
| Datakilde | AUT: Metadata som genereres automatisk eller tildeles av enten XDS-registeret eller XDS-repositoriet. | |
| Datatype | URI | |
| Kodesystem/ spesifikasjon |
Kodet som et ebRIM-spor. | |
| XML-eksempel (med ebRIM) |
|
|