Study List - OsiriX-Foundation/KheopsAuthorization GitHub Wiki

Used to get a list of studies for a given user. This API should conform to QIDO-RS in the sense that a QIDO-RS client doing a study search, and capable of sending an appropriate bearer token, should be able to call this resource directly.

The original implementation will only support a very limited subset of parameters. Future versions may implement more options

URL : /studies

Method : GET

Auth Required : Authorization with a JWT Bearer token with the user as the sub claim.

Headers

  • Accept : If present, require that this value be application/dicom+json optional

URL Parameters

Only accept the follwing QIDO-RS parameters

  • {attributeID}={value}

    Only accept the following attributeIDs as parameters:

    • StudyInstanceUID or 00080020
    • PatientID or 00100020
    • PatientName or 00100010
    • PatientSex or 00100040
    • PatientBirthDate or 00100030
    • AccessionNumber or 00080050
    • ReferringPhysicianName or 00080090
    • StudyID or 00200010
    • StudyDate or 00080020
      • {date} : the exact date
      • -{date} : before the date (include date)
      • {date}- : after the date (include date)
      • {date_1}-{date_2} : from date_1 to date_2 (include date)
      • date format : YYYYMMDD min: 00010101 max: 99991231
    • StudyTime or 00080030
      • {time} : the exact time
      • -{time} : before the time (include time)
      • {time}- : after the time (include time)
      • {time_1}-{time_2} : from time_1 to time_2 (include time)
      • time format : hhmmss.frac(6) min: 000000.000000 max: 235959.999999
    • ModalitiesInStudy or 00080061
      • Accept only one modality like : CT or MR or SC ...

    For non date parameters the following format can be used :

    • *{value} : end with
    • {value}* : start with
    • *{value}* : contain

  • limit={limit}

  • offset={offset}

  • fuzzymatching={true/false} by default : false

    • Use SOUNDEX algorithm

Custom Parameters

  • sort={sortBy} by default : sort by study date descending

    • sort={sortBy} for ascending
    • sort=-{sortBy} for descending
    • StudyDate or 00080020
    • StudyTime or 00080030
    • AccessionNumber or 00080050
    • ReferringPhysicianName or 00080090
    • PatientName or 00100010
    • StudyInstanceUID or 00080020
    • PatientID or 00100020
    • StudyID or 00200010

  • favorite={true}

    • Return only favorites study.

  • includefield={00012345} or includefield={favorite}

    • Return the sum of favorites series in the study

  • includefield={00012346} or includefield={comments}

    • Return the number of comments

  • album={album_id} : Filter the returned studies to only include series that are in the specified album.

  • inbox : Filter returned studies to only include series in the inbox.

    Note :

    Use album={album_id} or inbox not both. If you dont use album or inbox the QIDO will return all series from the inbox and all albums that are accessible by the user.

Response

Header X-Total-Count contains the total number of series to which the user has access.

The response should be as described in the QIDO-RS specification.

  • Instance Availability (0008,0056) should be ONLINE.
  • Retrieve URL (0008,1190) should be the address of the Web Server until the PACS is secured.