Norwegian profile for XDS metadata

This page provides a description of the metadata for the Norwegian XDS profile. This applies both to which attributes to use, how the attributes are to be used and which coding systems are to be used. XDS is content-agnostic, meaning it has no knowledge of the content of the document being shared or made available in an XDS solution.

Whether the document is a PDF, an XML file or an image makes no difference to the XDS solution, it will in any case just treat the file as a document without regard to content or format.
Since XDS solutions have no relation to the content of the document, metadata must be registered that describe, among other things, the overall clinical content of the documents. It is this metadata that is used when searching for specific documents. The metadata are divided into the following areas:

• Patient Identity: Attribute that identifies the patient that a document deals with, including patient ID (national identity number) and name.
• Source/Provenance: Attribute that describes where the document has been generated.
• Security & Privacy: Attribute that describes security rules and can be used to control access to the document.
• Description of Content (Descriptive): Attribute that describes the clinical content of the document. This is an attribute that is important for performing searches and finding documents based on clinical "search parameters".
• Document Status (Object Lifecycle): Attribute that describes the status of the document and any relationships to other documents Exchange: Attribute that describes how the document can be exchanged ("pull" or "push")

Use of XDS and information security

This profile does not describe how different users and solutions should access documents that are made available for lookup in an XDS solution.
XDS has several metadata attributes, such as the company (authorInstitution) that produced the document and the type of document (classCode/typeCode), which can provide a basis for how security and access management can be ensured.
However, there is no "built-in" security/access control in the metadata attributes directly, this must be taken care of by the solutions that together constitute one or more XDS areas and via the system solutions that provide access to documents in an XDS solution

Profile description

Some of the XML Types described below can be used to represent different concepts. The table below describes the different types.

SubmissionSet (<RegistryPackage>)

SubmissionSet is a description of one or more documents in a "package". The SubmissionSet can be compared to the package label on a package. This metadata summarizes the contents of the SubmissionSet and how the associated documents, relationships, and folders are placed together. An example of when a SubmissionSet can be used is when one wants to collect all documents related to a hospital stay for a patient. When submitting a SubmissionSet it is the case that either all of the documents are put in the document archive. That is, if there is an error related to one of the documents, none of the documents will be placed in the archive.

DocumentEntry (<ExtrinsicObject>)

In this context, a DocumentEntry is the metadata registered on the individual document that is to be made available and shared in an XDS solution. This metadata does not contain the content of the document itself, but only metadata about the document. There are two types of DocumentEntry:

• Stable DocumentEntry contains data about a document that has already been generated and exists, and is available for download via the XDS solution.
• On-demand DocumentEntry contains metadata with a unique id that can be used to generate a document when a request has been made for the document with that id.

🚩 Note!
PJD.XcaDocumentSource aswell as all document sources in Norway only support Stable-documents. This is described for informative purposes.
The usage of On-demand Documents in document sharing in Norway is not supported.

Association (<Association>)

An <Association> is used to bind two or more types together in order to create a logical connection between them. This is done using attributes sourceObject and targetObject attributes, referencing the unique identifiers of the associated types. An <Association> can have multiple states based on its associationType

Folder (<RegistryPackage>)

A Folder is a logical collection of those documents that have a relationship to each other. A Folder can be updated by multiple SubmissionSets, also sent from several different companies. This may, for example, be to collect all documents belonging to a laboratory examination, both the laboratory requisition and the associated laboratory results. This document does not specifically describe how to use Folder.

Specification

XDS metadata in Norwegian profile

The current specification is published on Helsedirektoratet's websites

IHE XDS metadata - helsedirektoratet.no

Extensions of the specification

DocumentEntry.ConfidentialityCode

In addition to code system 2.16.578.1.12.4.1.1.9603, the new rendition 2.16.578.1.12.4.1.1.9604 can also be used to classify documents. Document consumers and sources must be able to handle both code systems and the business rules related to them.

SubmissionSet.SourceId

XML Example

<q2:ExternalIdentifier 
    id="8097525e-1d1e-40c3-86f8-0884fc72c95c" 
    objectType="urn:oasis:names:tc:ebxml-regrep:ObjectType:RegistryObject:ExternalIdentifier" 
    registryObject="976905c8-fc37-4a66-aa8d-d993c5a33a9f" 
    identificationScheme="urn:uuid:554ac39e-e3fe-47fe-b233-965d2a147832" 
    value="2.16.578.1.12.4.5.480.15">
<q2:Name>
    <q2:LocalizedString value="XDSSubmissionSet.sourceId" />
</q2:Name>