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

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

## Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

### Requirements: Actor Definitions

The following artifacts define the types of individuals and/or systems that will interact as part of the use cases covered by this implementation guide.

ActorDefinition: Imaging Manifest Responder | The actor responsible for producing the Imaging Manifest resources.

### Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

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.
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.

### Behavior: Search Parameters

These define the properties by which a RESTful server can be searched. They can also be used for sorting and including related resources.

SearchParameterDocumentReferenceAccessionNumber | Searches for document references with a specific Accession Number.
SearchParameterDocumentReferenceBodySite | Searches for document references with a specific body site.
SearchParameterDocumentReferenceModality | Searches for document references with a specific modality.
SearchParameterDocumentReferenceStudyInstanceUid | Searches for document references with a specific Study Instance UID.

### Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

Endpoint: MADO WADO endpoint | This profile defines a WADO endpoint for accessing imaging study content. MADO WADO Endpoint holds an example of a endpoint with a `RetrieveLocationUid` and an address. This profile supports two cases (see X.4.1.2 Intra-community Sharing Infrastructure): The case where `address` is provided in addition to a `RetrieveLocationUID`. The case when only the `RetrieveLocationUID` is known and the `address` is unknown (see example EndpointWadoExampleNoAddress). In this case: The `address` SHALL be set to "http://notspecified" A `Data Absent Reason Exception` with the value `unknown` SHALL be added to indicate that the address is missing. Note that we do not require population of the `payloadMimeType` as this information is not present in the DICOM KOS. As is defined in section 6.X.6.6.2, in MADO, only the `dicom` mimetype is required.
Endpoint: MADO profile for Web Viewer endpoints | This profile defines the Web Viewer endpoint for accessing imaging study content. The URL in the Endpoint SHALL be a fully populated URL that contains all the information required to the launch the viewer to this study. The `address` field in the endpoint corresponds to the `Display URI` in the DICOM KOS manifest (see 6.X.2.13 Hierarchical SOP Instance Reference Macro). The endpoint MAY be encoded using the format defined in IHE-RAD-IID.
MADO Creator | A profile for the Device resource that represents the creator of an ImagingStudy in the MADO context.
MADO Creator Organization | Profile on Organization that specifies the required elements for the organization that creates MADO manifests.
MADO Imaging Study | Profile for ImagingStudy resources that represent the imaging studies manifest in the MADO context. It includes additional constraints and extensions specific to the MADO context, such as the study modality, the clinical specialty, the anatomical region of interest, the presence of significant images. In the case significant images are present, an instance referenced in the `ImagingStudy` is a Key Object Selection document TID 2010, the `ImagingStudy.series.instance.extension[ko-document-title]` SHALL contain the Document Title code of the referenced document, and the `ImagingStudy.series.instance.description` field contains the contents of the KeyObjectSelectionDescription field.
MADO Imaging Study Manifest FHIR Bundle | Profile for FHIR Bundles used as a imaging study Manifest in the MADO context. It includes constraints and extensions specific to imaging study manifests, such as the type of study, the clinical specialty, and the anatomical region of interest.
MADO MHD DocumentReference Profile for DICOM KOS Imaging Manifests | MADO specific profile for the IHE-MHD 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`.
MADO MHD DocumentReference Profile for FHIR Imaging Manifests | MADO specific profile for the IHE-MHD 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`.
MADO Patient | Profile on Patient that specifies the required elements for the patient that is the subject of the manifest.
MADO Provenance | The purpose of this resource is to indicate information about the system that created the manifest. Additionally, it can be used to sign the content of the Bundle. In DICOM KOS this information (and the referred MadoCreator) corresponds to the Institution Name, Institution Id, Manufacturer Name in the General Equipment module.
MADO Requested Procedure | A profile for the ServiceRequest resource that represents the Requested Procedure (see 6.X.2.8.1 Referenced Request Macro Description).

### Structures: Data Type Profiles

These define constraints on FHIR data types for systems conforming to this implementation guide.

MADO Accession Number Identifier | Profile for the Accession Number Identifier used in the MADO context. This profile is used for the Identifier that represents the Accession Number in the MADO context. It includes additional constraints and extensions specific to the MADO context, such as the value set for the type of identifier and the fixed value for the system of the identifier. The combination of the `Identifier.value` of the identifier and the `Identifier.system` of the identifier should be globally unique. The `Identifier.value` of the identifier should be locally unique within the context of the system that assigns the accession number. the `Identifier.system` SHALL be consistent with the content of the DICOM sequence "Issuer of Accession Number Sequence" (0008,0051).
MADO Referenced Accession Number Identifier | Profile for the Reference that contains the Accession Number Identifier used in the MADO context. This profile is used for the Reference that contains the Identifier that represents the Accession Number in the MADO context. It includes additional constraints and extensions specific to the MADO context, such as the value set for the type of identifier and the fixed value for the system of the identifier.
MADO Referenced Study Instance UID Identifier | Profile for the Reference that contains the Study Instance UID Identifier used in the MADO context. This profile is used for the Reference that contains the Identifier that represents the Study Instance UID in the MADO context. It includes additional constraints and extensions specific to the MADO context, such as the value set for the type of identifier and the fixed value for the system of the identifier.
MADO Study Instance UID Identifier | Profile for the Study Instance UID Identifier used in the MADO context. This profile is used for the Identifier that represents the Study Instance UID in the MADO context. It includes additional constraints and extensions specific to the MADO context, such as the value set for the type of identifier and the fixed value for the system of the identifier.

### Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

Extension: Anatomical Region | The anatomical region in an ImagingStudy instance. This is additional information next to ImagingStudy.series.bodySite.
Extension: Creator of the MADO | The creator of the MADO, which is the device that created the ImagingStudy resource in the MADO context.
Extension: MADO Document Title of Key Object Selection documents | The document title code of the Key Object Selection document TID 2010 this instance refers to.
Extension: Number of Frames | The number of frames in an ImagingStudy instance.
Extension: Representative Instance | An extension to indicate that a referenced instance on and ImagingStudy series is a representative instance for that series. This extension is used in the MADO context to indicate that a referenced instance on an ImagingStudy series is a representative instance for that series, which can be used for display purposes in the MADO context.
Extension: Retrieve Location UID | The location UID of the source of the WADO URL. See XC-WADO and https://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_A.35.4.3.html#table_A.35.4-1.

### Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

Anatomical Region | A shortlist of anatomical regions that can be used for searching reports and manifests. This set is defined in Table 6.X.6.4-1. In this case discrepancies, the values in the table have prevalence. It is planned to move this ValueSet to IHE terminologies. When that is done, this definition will be removed.
ValueSet: Imaging Procedure Type | This value set includes all imaging procedure types defined in SNOMED CT. The codes represent combinations of the modality to be used and the procedure to be performed.

### Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

MADO Device Type Code System | Code system for the type of device used in the MADO context. This code system is used to specify the type of device used in the MADO context, such as the type of device used as the author of an ImagingStudy in the MADO context.

### Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

Bundle: MADO FHIR document | An example of a MADO FHIR manifest.
DocumentReference Example for DICOM KOS manifests | DocumentReference Example for DICOM KOS manifests
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 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
Endpoint: MADO WADO Endpoint | Example of a DICOM web endpoint supporting WADO.
Endpoint: MADO WADO Endpoint example with no URL | Example implementation of an WADO endpoint holding a RetrieveLocationUID and no address.
Example of an orgnization that generated the manifest |
Example patient | Example patient

### Other

These are resources that are used within this implementation guide that do not fit into one of the other categories.

dicom-kos-mado--2047166865 |
dicom-kos-mado--2047166866 |
mado-bundle--2047166865 |
mado-bundle--2047166866 |
mado-documentreference-fhir--2047166865 | Imaging Manifest for Imaging Study urn:oid:1.2.250.1.59.40211.22756022.2.1.102
mado-documentreference-fhir--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
mado-documentreference-kos--2047166866 | Imaging Manifest for Imaging Study urn:oid:1.2.250.1.59.40211.22756022.2.1.101
pat-mrn--1097192655 |