4.2.5. QIDO-RS Specifications

4.2.5.1. QIDO-RS Search For Studies

Table 4.45 QIDO-RS Search for Studies Specification
Parameter Restrictions
Media Types Restricted to ‘multipart/related; type=application/dicom+xml’ or ‘application/json’
Matching Attributes Refer QIDO-RS Study Attribute Matching
Return Attributes Refer QIDO-RS Study Attribute Matching
Limit and Offset supported Yes
Person Name Matching Refer Person Name Matching Note
Table 4.46 QIDO-RS Study Attribute Matching
Attributes Names Tag Query Keys Matching (SCP) Return Attributes (SCP)
Study Instance UID 0020000D UNIQUE UNIQUE
Study ID 00200010 S,*,U S,*,U
Study Date 00080020 S,*,U,R S,*,U,R
Study Time 00080030 S,*,U,R S,*,U,R
Study Description 00081030 S,*,U S,*,U
Accession Number 00080050 S,*,U S,*,U
Issuer of Accession Number 00080051    
Referring Physician’s Name 00080090 S,*,U S,*,U
Institution Name 00080080 S,*,U  
Station Name 00081010 S,*,U  
Body Part Examined 00180015 S,*,U  
SOP Classes in Study 00080062 S,*,U  
Institutional Department Name 00081040 S,*,U  
Series Description 0008103E S,*,U  
Sending Application Entity Title of Series   S,*,U  
Patient Name 00100010 S,*,U  
Patient ID 00100020 S,*,U  
Issuer of Patient ID 00100021 UNIQUE  
Modality 00080061 S,*,U  
Failed SOP Instance UID List 00080058 L  
Procedure Code Sequence 00081032   NONE
Patient Age 00101010   NONE
Patient Size 00101020   NONE
Patient Size Code Sequence 00101021   NONE
Patient Weight 00101030   NONE
Occupation 00102180   NONE
Additional Patient History 001021B0   NONE
Patient Sex Neutered 00102203   NONE
Physicians of Record 00081048   NONE
Specific Character Set 00080005   NONE
Retrieve URL 00081190   NONE
Retrieve AE Title 00080054   NONE
Instance Availability 00080056   NONE
Number of Study Related Series 00201206   NONE
Number of Study Related Instances 00201208   NONE

Types of Matching :

  1. “S” indicates the identifier attribute uses Single Value Matching.
  2. “L” indicates UID List Matching.
  3. “U” indicates Universal Matching. (Note : If only Universal Matching is supported for an attribute then that attribute can only be passed as an “includefield” query key.)
  4. “*” indicates wild card matching.
  5. “R” indicates Range Matching.
  6. “SEQUENCE” indicates Sequence Matching.
  7. “NONE” indicates that no matching is supported, but that values for this Element requested will be returned with all requests.
  8. “UNIQUE” indicates that this is the Unique Key for that query level, in which case Universal Matching or Single Value Matching is used depending on the query level.

4.2.5.2. QIDO-RS Search For Series

Table 4.47 QIDO-RS Search for Series Specification
Parameter Restrictions
Media Types Restricted to ‘multipart/related; type=application/dicom+xml’ or ‘application/json’
Matching Attributes Refer QIDO-RS Study Attribute Matching and QIDO-RS Series Attribute Matching
Return Attributes Refer QIDO-RS Series Attribute Matching
Limit and Offset supported Yes
Relational Queries Supported Yes
Person Name Matching Refer Person Name Matching Note

Types of Matching: As explained above in QIDO-RS Search For Studies

Table 4.48 QIDO-RS Series Attribute Matching
Attributes Names Tag Query Keys Matching (SCP) Return Attributes (SCP)
Series Instance UID 0020000E UNIQUE UNIQUE
Series Number 00200011 S,*,U S,*,U
Modality 00080060 S,*,U S,*,U
Body Part Examined 00180015 S,*,U S,*,U
Performed Procedure Step Start Date 00400244 S,*,U,R S,*,U,R
Performed Procedure Step Start Time 00400245 S,*,U,R S,*,U,R
Performing Physician Name 00081050 S,*,U S,*,U
Station Name 00081010 S,*,U S,*,U
Series Description 0008103E S,*,U S,*,U
Institutional Department Name 00081040 S,*,U S,*,U
Institution Name 00080080 S,*,U S,*,U
Request Attributes Sequence 00400275 SEQUENCE SEQUENCE
>Accession Number 00080050 S,*,U S,*,U
>Issuer of Accession Number 00080051    
>Requesting Service 00321033 S,*,U S,*,U
>Requesting Physician 00321032 S,*,U S,*,U
>Requested Procedure ID 00401001 S,*,U S,*,U
>Study Instance UID 0002000D UNIQUE UNIQUE
>Scheduled Procedure ID 00400009 S,*,U S,*,U
Institution Code Sequence 00080082 SEQUENCE SEQUENCE
>Code Value 00080100 S,*,U S,*,U
>Coding Scheme Designator 00080102 S,*,U S,*,U
>Coding Scheme Version 00080103 S,*,U S,*,U
Sending Application Entity Title of Series   S,*,U  
Failed SOP Instance UID List 00080058 L  
Laterality 00200060   NONE
Manufacturer 00080070   NONE
Manufacturer Model Name 00081090   NONE
Referenced Performed Procedure Step Sequence 00081111   NONE
Specific Character Set 00080005   NONE
Retrieve URL 00081190   NONE
Retrieve AE Title 00080054   NONE
Instance Availability 00080056   NONE
Number of Series Related Instances 00201209   NONE

4.2.5.3. QIDO-RS Search For Instances

Table 4.49 QIDO-RS Search for Instances Specification
Parameter Restrictions
Media Types Restricted to ‘multipart/related; type=application/dicom+xml’ or ‘application/json’
Matching Attributes Refer QIDO-RS Study Attribute Matching, QIDO-RS Series Attribute Matching and QIDO-RS Instance Attribute Matching
Return Attributes Refer QIDO-RS Instance Attribute Matching
Limit and Offset supported Yes
Relational Queries Supported Yes
Person Name Matching Refer Person Name Matching Note

Types of Matching: As explained above in QIDO-RS Search For Studies

Table 4.50 QIDO-RS Instance Attribute Matching
Attributes Names Tag Query Keys Matching (SCP) Return Attributes (SCP)
SOP Class UID 00080016 L L
SOP Instance UID 00080018 UNIQUE UNIQUE
Content Date 00080023 S,*,U,R S,*,U,R
Content Time 00080033 S,*,U,R S,*,U,R
Instance Number 00200013 S,*,U S,*,U
Concept Name Code Sequence 0040A043 SEQUENCE SEQUENCE
>Code Value 00080100 S,*,U S,*,U
>Coding Scheme Designator 00080102 S,*,U S,*,U
>Coding Scheme Version 00080103 S,*,U S,*,U
Verifying Observer Sequence 0040A073 SEQUENCE SEQUENCE
>Verifying Observer Name 0040A075 S,*,U S,*,U
>Verification Date Time 0040A030 S,*,U, R S,*,U, R
Completion Flag 0040A491 S,*,U S,*,U
Verification Flag 0040A493 S,*,U S,*,U
Content Sequence 0040A730 SEQUENCE SEQUENCE
>Value Type 0040A040 S S
>Concept Name Code Sequence 0040A043 SEQUENCE SEQUENCE
>>Code Value 00080100 S,*,U S,*,U
>>Coding Scheme Designator 00080102 S,*,U S,*,U
>>Coding Scheme Version 00080103 S,*,U S,*,U
>Relationship Type 0040A010 S,*,U S,*,U
>Concept Code Sequence 0040A168 SEQUENCE SEQUENCE
>>Code Value 00080100 S,*,U S,*,U
>>Coding Scheme Designator 00080102 S,*,U S,*,U
>>Coding Scheme Version 00080103 S,*,U S,*,U
>Text Value 0040A160 S,*,U S,*,U
Image Type 00080008   NONE
Observation Date Time 0040A032   NONE
Referenced Series Sequence 00081115   NONE
Number of Frames 00280008   NONE
Rows 00280010   NONE
Columns 00280011   NONE
Bits Allocated 00280100   NONE
Referenced Request Sequence 0040A370   NONE
Current Requested Procedure Evidence Sequence 0040A375   NONE
Content Template Sequence 0040A504   NONE
Identical Documents Sequence 0040A525   NONE
Document Title 00420010   NONE
MIME Type of Encapsulated Document 00420012   NONE
Content Label 00700080   NONE
Content Description 00700081   NONE
Presentation Creation Date 00700082   NONE
Presentation Creation Time 00700083   NONE
Content Creator’s Name 00700084   NONE
Specific Character Set 00080005   NONE
Retrieve URL 00081190   NONE
Retrieve AE Title 00080054   NONE
Instance Availability 00080056   NONE

4.2.5.4. QIDO-RS Search For Patients

Table 4.51 QIDO-RS Search for Patients Specification
Parameter Restrictions
Media Types Restricted to ‘multipart/related; type=application/dicom+xml’ or ‘application/json’
Matching Attributes Refer QIDO-RS Patient Attribute Matching
Return Attributes Refer QIDO-RS Patient Attribute Matching
Limit and Offset supported Yes
Relational Queries Supported No
Person Name Matching Refer Person Name Matching Note

Types of Matching: As explained above in QIDO-RS Search For Studies

Table 4.52 QIDO-RS Patient Attribute Matching
Attributes Names Tag Query Keys Matching (SCP) Return Attributes (SCP)
Patient Name 00100010 S,*,U S,*,U
Patient ID 00100020 S,*,U S,*,U
Patient Birth Date 00100030 S,*,U,R S,*,U,R
Patient Sex 00100040 S,*,U S,*,U
Issuer of Patient ID 00100021 S,*,U S,*,U
Issuer of Patient ID Qualifier Sequence 00100024   NONE
Patient Birth Time 00100032   NONE
Patient Insurance Plan Code Sequence 00100050   NONE
Patient Primary Language Code Sequence 00100101   NONE
Other Patient Names 00101001   NONE
Other Patient IDs Sequence 00101002   NONE
Patient Birth Name 00101005   NONE
Patient Address 00101040   NONE
Patient Mother Birth Name 00101060   NONE
Military Rank 00101080   NONE
Branch of Service 00101081   NONE
Medical Record Locator 00101090   NONE
Medical Alerts 00102000   NONE
Allergies 00102110   NONE
Country of Residence 00102150   NONE
Region of Residence 00102152   NONE
Patient Telephone Numbers 00102154   NONE
Ethnic Group 00102160   NONE
Smoking Status 001021A0   NONE
Pregnancy Status 001021C0   NONE
Last Menstrual Date 001021D0   NONE
Patient Religious Preference 001021F0   NONE
Patient Species Description 00102201   NONE
Patient Species Code Sequence 00102202   NONE
Patient Breed Description 00102292   NONE
Patient Breed Code Sequence 00102293   NONE
Breed Registration Sequence 00102294   NONE
Responsible Person 00102297   NONE
Responsible Person Role 00102298   NONE
Responsible Organization 00102299   NONE
Patient Comments 00104000   NONE
Clinical Trial Sponsor Name 00120010   NONE
Clinical Trial Protocol ID 00120020   NONE
Clinical Trial Protocol Name 00120021   NONE
Clinical Trial Site ID 00120030   NONE
Clinical Trial Site Name 00120031   NONE
Clinical Trial Subject ID 00120040   NONE
Clinical Trial Subject Reading ID 00120042   NONE
Patient Identity Removed 00120062   NONE
Deidentification Method 00120063   NONE
Deidentification Method Code Sequence 00120064   NONE
Clinical Trial Protocol Ethics Committee Name 00120081   NONE
Clinical Trial Protocol Ethics Committee Approval Number 00120082   NONE
Special Needs 00380050   NONE
Pertinent Documents Sequence 00380100   NONE
Patient State 00380500   NONE
Patient Clinical Trial Participation Sequence 00380502   NONE
Confidentiality Constraint On Patient Data Description 00403001   NONE
Specific Character Set 00080005   NONE
Retrieve URL 00081190   NONE
Retrieve AE Title 00080054   NONE
Instance Availability 00080056   NONE

Person Name Matching Note :

  • DCM4CHEE-QIDO-SERVICE supports “fuzzymatching” only for attributes having value representation as PN. If all characters of Person Name are in upper case, then the service performs case insensitive matching, else it shall perform case sensitive matching. The service also supports literal and wild card matching. It will not perform other forms of fuzzy matching. This applies to the following attributes:

    In QIDO-RS Study Attribute Matching Referring Physician’s Name (0008,0090).
      Patient’s Name (0010,0010).
      Physicians of Record (0008,1048).
    In QIDO-RS Series Attribute Matching Performing Physician’s Name (0008,1050).
    In QIDO-RS Instance Attribute Matching Verifying Observer Name (0040,A075).
    In QIDO-RS Patient Attribute Matching Patient’s Name (0010,0010).

4.2.5.5. QIDO-RS Connection Policies

4.2.5.5.1. General

All standard RS connection policies apply. There are no extensions for RS options.

4.2.5.5.2. Number Of Connections

The maximal number of simultaneous HTTP Requests is configurable. It is unlimited by default.

Table 4.53 Number of HTTP Requests Supported
Maximum number of simultaneous HTTP requests No Maximum Limit (Configurable)

4.2.5.5.3. Response Status

DCM4CHEE-QIDO-SERVICE shall provide a response message header containing the appropriate status code indicating success, warning, or failure as shown below

Table 4.54 HTTP Standard Response Codes
Code Name Description
Success    
200 OK The query completed and any matching results are returned in the message body.
Failure    
400 Bad Request This indicates that the QIDO-RS Provider was unable to fulfill it because it cannot understand the query component.
401 Unauthorized This indicates that the QIDO-RS Provider refused to fulfill it because the client is not authorized.
403 Forbidden This indicates that the QIDO-RS Provider understood the request, but is refusing to fulfill it (e.g., no single patient specified, an authorized user with insufficient privileges, etc.).
413 Request entity too large This indicates that the query was too broad and a narrower query or paging should be requested. This code will be returned for queries that do not specify PatientID.
503 Busy Service is unavailable.

4.2.5.5.4. Web Service Endpoint URL

http://localhost:8080/dcm4chee-arc/aets/{AETitle}/rs

Replace {AETitle} in the URL with the configured AE title.