iCure. eHealth Solutions
  • Developer Documentation
  • iCure Software Modules
  • Get Started
    • Create your own Database
      • Receive an invitation
      • Create new User
      • Create a new Healthcare Party
    • Structure your Database
    • Access your database
    • Use the Console
  • Data Stack Module
    • The Data Stack
      • Install iCure
      • Get Started with a Database
    • iCure Data Model
      • Overview
      • User
        • Permission
      • Healthcare Party
      • Patient
        • Insurability
        • Relationship
        • Patient Hcp care period
          • Referral period
      • Contact
        • Service
          • Content
            • Medication
              • Regimen item
            • Measure
        • SubContact
      • Healthcare Element
        • Care team member
        • Healthcare approach
      • Form
      • Additional Classes
        • AccessLog
        • Address
          • Telecom
        • Message
        • Document
        • FilterChain
          • Filter
          • Predicate
        • Group
        • Insurance
        • Invoice
          • Invoicing code
        • Tarification
          • Valorisation
    • Hybrid Cloud Storage
    • Mobile/Web SDKs
      • JavaScript/Typescript
        • Setting up your environment
        • Logging in
        • Managing patients
        • iCure for MedTech: Getting Started
          • Exchange data using FHIR model
          • Exchange data using iCure SDK
      • Java/Kotlin
      • Swift/Objective C
    • REST API calls
      • User
      • Patient
      • HealthcareParty
      • Contact
      • HealthcareElement
      • Form
      • Document
      • Message
      • Invoice
      • Additional endpoints
        • AccessLog
        • Authentication
        • Codification
        • Document template
        • Entity reference
        • Entity template
        • Insurance
        • Receipt
        • Tarification
    • Access Rights management
    • End-to-End-Encryption
    • ATNA Audit Records
  • Interoperability Module
    • IHE XDS calls
      • The XDS Concept
      • ITI-18 get associations api call
      • ITI-41 provide and register document set api call
      • Iti-42 register document set api call
    • IHE IPS call
      • The IPS Concept
    • FHIR API Data Exchange
      • The FHIR Concept
    • Freehealth Connector 🇧🇪
    • Encrypted Data Exchange
      • Internal
      • External
  • Customizable Features Module
    • Input Forms
    • Medical Records
    • Data Dashboards
    • Custom Connectors
    • Secure Log-in App
  • Support
    • Download
    • Contact Us
  • Advanced topics
    • Healthcare Data
      • Business intelligence
      • Anonymized Data
    • Encryption Key Creation and Storage
    • Multi-Master database replication
    • Cross Databases Sharing
    • Complex queries
Powered by GitBook
On this page
  • Actors
  • XDS.b endpoints
  • ITI-8: Patient Identity Feed
  • ITI-43: Retrieve Document Set
  • ITI-44: Patient Identity Feed HL7 V3
  • ITI-57: Update Document Set
  • ITI-61: Register On-Demand Document Entry
  • ITI-62: Remove Metadata
  • RAD-68: Provide and Register Imaging Document Set

Was this helpful?

  1. Interoperability Module
  2. IHE XDS calls

The XDS Concept

PreviousIHE XDS callsNextITI-18 get associations api call

Last updated 3 years ago

Was this helpful?

Actors

XDS.b declares 4 types of actors: Document Source, Document Repository, Document Registry, and Document Consumer.

  • A Document Source is responsible for the document publishing and provides the clinical documents to a Document Consumer or the Document Repository.

  • A Document Consumer requests and retrieves documents from the XDS network, either from a Document Repository or a Document Source.

  • The Document Repository handles the document storage in a transparent, secure, reliable, and persistent manner. It is also responsible for delivering the requested documents to the Document Consumer.

  • The Document Registry manages and stores the metadata associated with the documents and allows Documents Consumers to perform various searches to identify the documents of interest and subsequently retrieve them from the Document Repository.

XDS.b endpoints

Xds.b is based upon ebXML Registry standards and SOAP. iCure acts as a Document Registry and a Document Repository and supports de following ITIs: iti-8, iti-18, iti-41, iti-42, iti-43, iti-44, iti-57, iti-61, iti-62, RAD-68.

ITI-8: Patient Identity Feed

This endpoint is used by a Patient Identity source to update the patient identity stored in the document Registry. The transaction is conducted by an HL7 ADT message.

The Document Registry will store only the patient identifiers of the patient identification domain designated by the XDS Affinity Domain for document sharing in the registry. If other patient identification domains are present in a received message, they will be ignored.

ITI TF-2a section 3.8 for the detailed definition of the transaction.

ITI-43: Retrieve Document Set

This transaction is used by a Document Consumer to retrieve a set of documents from the Document Repository.

When receiving a Retrieve Document Set Request, the Document Repository will generate a Retrieve Document Set Response containing the requested documents.

ITI-44: Patient Identity Feed HL7 V3

ITI-44 uses patient identifiers provided by Patient Identity Source to ensure that XDS Documents metadata registered is associated with a known patient and updates patient identity in document metadata by tracking identity change operations.

The Document Registry accepts Patient Registry Record Added and Patient Registry Record Revised messages.

The Document Registry stores only the patient identifiers of the patient identification domain designated by the Affinity Domain for document sharing in the registry. Patient identifiers of other patient identification domains, if present in a received message, will be ignored.

ITI-57: Update Document Set

When receiving an Update Document Set Request message, the Document Registry parses the supplied metadata and makes the updates triggered by the metadata objects in the message. In general, each metadata object supplied triggers a separate metadata update.

The registry is capable of storing multiple versions of DocumentEntry and Folder metadata objects and makes them available through the ITI-18 transaction

ITI-61: Register On-Demand Document Entry

ITI-61 allows the Registry to receive and store metadata about available on-demand documents.

An on-demand document is one that collects the latest, most recently available information at the time of retrieval. For more information about the on-demand document see ITI TF-3 section 4.1.1.

Upon receipt of a Register On-Demand Document Entry Request message, the Document Registry will:

  1. Perform metadata validations

  2. Store all IHE-defined metadata attributes

ITI-62: Remove Metadata

The Remove Metadata transaction is used by a Document Administrator to submit a list of entry UUID attributes identifying the metadata objects to be removed from the Document Registry including Submission Set, Document Entry, Folder, and Association objects.

RAD-68: Provide and Register Imaging Document Set

RAD-68 is very similar to the ITI-41 transaction, with different metadata.

ITI TF-2b section 3.43 for the detailed definition of the transaction.

ITI TF-2b section 3.44 for the detailed definition of the transaction.

XDS Metadata Update section 3.57 for the detailed definition of the transaction.

ITI TF-2b section 3.61 for the detailed definition of the transaction.

RMD for the detailed definition of the transaction.

IHE RAD TF-3 for the detailed definition of the transaction

ℹ️
ℹ️
ℹ️
ℹ️
ℹ️
ℹ️
ℹ️