PACS webhooks

Image Availability Message

This is the message sent by the PACS to a remote HTTP endpoint every time the system considers a study to be completely received.

The system sends an HTTP POST message with a JSON payload (application/json Content-Type with UTF-8 charset encoding) for each completed study.

CODE

{
   "SourceID":"PACS-NAME",
   "StudyInstanceUID":"1.3.76.13.800000000.2.20211229104446.800809040.1",
   "AccessionNumber":"800809040-1",
   "PatientID":"LASTNAME^FIRSTNAME",
   "IssuerOfPatientID":"ISSUER-IDENTIFIER",
   "NumberOfStudyRelatedSeries":2,
   "NumberOfStudyRelatedInstances":207,
   "ModalitiesInStudy":[
      "MR", "SM"
   ],
   "AeTitles":[
      "NGV", "FEED"
   ],
   "StationNames":[
      "HITACHI", "HAMA-SCANNER34"
   ],
   "EventType":"COMPLETED",
   "StudyDate":"20220110",
   "StudyTime":"125832",
   "StudyID":"15982",
   "ReferringPhysicianName": "LASTNAME^FIRSTNAME",
   "StudyDescription":"RM CON MDC",
   "PatientName":"LASTNAME^FIRSTNAME",
   "PatientBirthDate":"19901231",
   "PatientSex":"O",
   "Report":null,
   "HolterUsername":null,
   "Series":[
      {
         "SeriesInstanceUID":"1.2.392.200036.9123.100.12.12.40617.90230126141905089629088973",
         "Modality":"MR",
         "BodyPartExamined":"ELBOW",
         "NumberOfSeriesRelatedInstances":206,
         "SeriesDescription":"PD AX GE-T2-FATSAT _Echo#1",
         "AeTitle":"NGV",
         "StationName":"HITACHI",
         "ContainerIdentifier":null,
         "Thumbnail":null
      },
      {
         "SeriesInstanceUID":"1.2.392.200036.9123.100.12.12.40617.90230126141905089629138780",
         "Modality":"SM",
         "BodyPartExamined":null,
         "NumberOfSeriesRelatedInstances":1,
         "SeriesDescription":"I2022-011012-A-1-1",
         "AeTitle":"FEED",
         "StationName":"HAMA-SCANNER34",
         "ContainerIdentifier":"I2022-011012-A-1-1",
         "Thumbnail": "BASE64_ENCODED_JPEG"
      }
   ]
}

Notes:

SourceID: it can be used to identify the PACS that is sending the notification (is a configuration field of the ImageAvailability service);
EventType: its possible values are COMPLETED or INSTANCES_ADDED;
StationNames: it is always present but might be empty;
Thumbnail: it is valued only for series with Modality SM (i.e. Slide Microscopy) and contains the thumbnail of the macro and the label in JPEG format.