Sign in

v1

latestOpenAPI 3.0.02026-07-142740323.4 KB
Instances

Get parent study

Get detailed information about the parent study of the DICOM instance whose Orthanc identifier is provided in the URL

get/instances/{id}/study

Path parameters

idstring required

Orthanc identifier of the instance of interest

Query parameters

fullboolean

If present, report the DICOM tags in full format (tags indexed by their hexadecimal format, associated with their symbolic name and their value)

requestedTagsstring

If present, list the DICOM Tags you want to list in the response. This argument is a semi-column separated list of DICOM Tags identifiers; e.g: 'requestedTags=0010,0010;PatientBirthDate'. The tags requested tags are returned in the 'RequestedTags' field in the response. Note that, if you are requesting tags that are not listed in the Main Dicom Tags stored in DB, building the response might be slow since Orthanc will need to access the DICOM files. If not specified, Orthanc will return

shortboolean

If present, report the DICOM tags in hexadecimal format

Response

{"stackTrail":"paths:/instances/{id}/study:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown","description":"Information about the parent DICOM study","example":{"ID":"1c379a23-9fd28bba-02b60e5b-850ff34e-4349f09b","IsStable":true,"LastUpdate":"20200803T131236","MainDicomTags":{"AccessionNumber":"2819497684894126","ReferringPhysicianName":"","StudyDate":"20091022","StudyDescription":"RT^HEAD_NECK (Adult)","StudyID":"","StudyInstanceUID":"1.3.6.1.4.1.14519.5.2.1.2193.7172.847236098565581057121195872945","StudyTime":"172721.327000"},"ParentPatient":"65ce8003-696b2eb6-03adeee7-6561ce8e-3e03f13a","PatientMainDicomTags":{"PatientBirthDate":"","PatientID":"HN_P001","PatientName":"HN_P001","PatientSex":"M"},"Series":["9c7031b2-97909802-c35563e6-168bf0af-5cfbdce4","1d9c4560-6480f3d9-0a4d3654-65715f38-755ad2e0","52f4cb90-29d1d1a2-2ca34edd-4b8851fc-8cb269f2"],"Type":"Study"}}

Example response

{
  "ID": "1c379a23-9fd28bba-02b60e5b-850ff34e-4349f09b",
  "IsStable": true,
  "LastUpdate": "20200803T131236",
  "MainDicomTags": {
    "AccessionNumber": "2819497684894126",
    "ReferringPhysicianName": "",
    "StudyDate": "20091022",
    "StudyDescription": "RT^HEAD_NECK (Adult)",
    "StudyID": "",
    "StudyInstanceUID": "1.3.6.1.4.1.14519.5.2.1.2193.7172.847236098565581057121195872945",
    "StudyTime": "172721.327000"
  },
  "ParentPatient": "65ce8003-696b2eb6-03adeee7-6561ce8e-3e03f13a",
  "PatientMainDicomTags": {
    "PatientBirthDate": "",
    "PatientID": "HN_P001",
    "PatientName": "HN_P001",
    "PatientSex": "M"
  },
  "Series": [
    "9c7031b2-97909802-c35563e6-168bf0af-5cfbdce4",
    "1d9c4560-6480f3d9-0a4d3654-65715f38-755ad2e0",
    "52f4cb90-29d1d1a2-2ca34edd-4b8851fc-8cb269f2"
  ],
  "Type": "Study"
}