Manifest-based Access to DICOM Objects (MADO)
0.1.0 - trial-use International flag

Manifest-based Access to DICOM Objects (MADO), published by IHE Radiology Technical Committee. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/RAD.MADO/ and changes regularly. See the Directory of published versions

Manifest Envelopes for IHE-MHD

The following MHD DocumentReferences SHALL be used when distributing a MADO Imaging Manifest in an IHE-ITI-MHD environment:

An IHE-MHD infrastructure may choose to implement an mapping service between the two manifest formats. When such a mapping service is supported, the address field in the unsupported DocumentReference MAY include a fully populated url to the mapping service that will return the translated document.

In the case the manifest is available in multiple formats, the Document Consumer SHOULD show to the user a single entry chosen by the implementation.

As is stated in section X.6.1, Manifest Creators SHALL create the manifest in the format of their choice. The selection is made at deployment time (see section X.6.1 for more detail).

The figure below shows the MHD DocumentReferences including the most relevant restrictions and its relationship with the manifests and each other.

manifest-envelope.drawio.svg
Figure: IHE-MHD envelope

The main choices illustrated in the figure are:

  • There are two different DocumentReferences, one for the FHIR and one for the DICOM KOS representation. When both are present, the relatesTo field points to the other representation.
  • FHIR manifest:
  • DICOM KOS manifest:
    • A KOS manifest is represented as a application/dicom encoded DICOM instance (see 8.7.3.1 Instance Media Types) following the MADO KOS profile.
    • The KOS manifest DocumentReference SHALL have include the SOPInstanceUid of the KOS instance as masterIdentifier.
  • The masterIdentifier SHALL be part of the identifier list as well.

The FHIR-manifest can be translated into the KOS-manifest and vice-versa allowing applications to change the representation when needed.

In this specification the choice for presenting the manifest in an IHE-MHD environment is representing them as two separate DocumentReference instances. Feedback is requested from the implementer community whether this approach is correct and adequate.
NameTitleDescription
MadoDicomKosMinimalDocumentReference

MADO MHD DocumentReference Profile for DICOM KOS Imaging Manifests

MADO specific profile for the IHE-MHD Minimal Document Reference for MADO DICOM KOS Manifests that includes the MADO specific content format, the extensions related to body-site and modality, and the definition on where StudyInstanceUID and AccessionNumber are stored.

This profile copies most of the restrictions defined in the MHD DocumentReference Comprehensive profiles (except securityLabel) and requires context.period.

MadoFhirMinimalDocumentReference

MADO MHD DocumentReference Profile for FHIR Imaging Manifests

MADO specific profile for the IHE-MHD Minimal Document Reference for MADO FHIR Manifests that includes the MADO specific content format, the extensions related to body-site and modality, and the definition on where StudyInstanceUID and AccessionNumber are stored.

This profile copies most of the restrictions defined in the MHD DocumentReference Comprehensive profiles (except securityLabel) and requires context.period.

Capability Statements

NameTitleDescription
IHE_RAD_MADO_DocumentConsumer

MADO Document Consumer (client)

IHE RAD Manifest based Access to DICOM Objects(MADO) - Document Consumer (client). It extends MHD Document Consumer (client).

Please note that this CapabilityStatement representation only shows the delta of this instance with the MHD Document Responder (client). All the functionality specified by the Document Consumer (client) SHALL also be supported.

IHE_RAD_MADO_DocumentResponder

MADO Document Responder (server)

IHE RAD Manifest based Access to DICOM Objects(MADO) - Document Responder (server). It extends MHD Document Responder (client).

Please note that this CapabilityStatement representation only shows the delta of this instance with the MHD Document Responder (client). All the functionality specified by the Document Consumer (client) SHALL also be supported.

Imaging specific search parameters

Imaging specific search parameters include:

NameTitleDescription
DocumentReferenceAccessionNumber

Searches for document references with a specific Accession Number.

DocumentReferenceBodySite

Searches for document references with a specific body site.

DocumentReferenceModality

Searches for document references with a specific modality.

DocumentReferenceStudyInstanceUid

Searches for document references with a specific Study Instance UID.

The expression below uses these search parameters to search for a FHIR manifest with StudyInstanceUid=324.232.5.5.324.2.

DocumentReference/?study-instance-uid=urn:oid:324.232.5.5.324.2&format=urn:ihe:rad:MADO:fhir-manifest:2026

This uses the optional study-instance-uid search parameter. An alternative with standard search params would be. As the study instance uid is an OID, in the identifier it is prefixed with urn:oid:.

DocumentReference/?related:identifier=urn:oid:324.232.5.5.324.2&format=urn:ihe:rad:MADO:fhir-manifest:2026

A similar query searching for DICOM KOS Manifests with accession number 12345 would look like:

DocumentReference/?related:identifier="12345"&format=1.2.840.10008.5.1.4.1.1.88.59

an alternative using the accession-number query is:

DocumentReference/?accession-number="12345"&format=1.2.840.10008.5.1.4.1.1.88.59

DocumentReference examples

The list below presents various examples of MADO DocumentReferences.

NameTitleDescription
DocumentReference Example for FHIR manifests

DocumentReference Example for FHIR manifests

DocumentReference Example for FHIR manifests with transform

DocumentReference Example for FHIR manifests with transform service called to transform the KOS manifest into a FHIR manifest

DocumentReference Example for DICOM KOS manifests

DocumentReference Example for DICOM KOS manifests

DocumentReference Example for DICOM KOS manifests and no related reference to the FHIR manifest example

DocumentReference Example for DICOM KOS manifests with no related reference to the FHIR manifest example

DocumentReference Example for DICOM KOS manifests

DocumentReference Example for DICOM KOS manifests

mado-documentreference-fhir--2047166866

Imaging Manifest for Imaging Study urn:oid:1.2.250.1.59.40211.22756022.2.1.101

mado-documentreference-fhir--2047166865

Imaging Manifest for Imaging Study urn:oid:1.2.250.1.59.40211.22756022.2.1.102

mado-documentreference-kos--2047166866

Imaging Manifest for Imaging Study urn:oid:1.2.250.1.59.40211.22756022.2.1.101

mado-documentreference-kos--2047166865

Imaging Manifest for Imaging Study urn:oid:1.2.250.1.59.40211.22756022.2.1.102

The DocumentReference Example for FHIR manifests with transform example contains a FHIR MADO DocumentReference. The content section does not point to a FHIR file but to a transform service. The content.attachment section is presented below

{
  "contentType" : "application/fhir+json",
  "language" : "de-DE",
  "url" : "http://kos2FhirTranformService.example.com/transform?url=http://mhdserver.example.com/Binary/mado-kos-manifest-binary",
  "creation" : "2025-05-08T00:00:00Z"
}

The url points to a transform service and passes the link to the KOS manifest. This is just one example of such service. This specification does not specify the interface. Alternative implementations could could pass the StudyInstanceUID and wado URL parameters, or some other set of data.