Top Banner
TRACKING AND MONITORING WEB SERVICE DEFINITIONS DOCUMENT DOCUMENT Revision Number: 1.51 Compatible with ÜTS Version 7.6.x.
155

TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

Apr 04, 2019

Download

Documents

lethuy
Welcome message from author
This document is posted to help you gain knowledge. Please leave a comment to let me know what you think about it! Share it to your friends and learn new things together.
Transcript
Page 1: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

TRACKING AND MONITORING

WEB SERVICE DEFINITIONS

DOCUMENT DOCUMENT

Revision Number: 1.51

Compatible with ÜTS Version 7.6.x.

Page 2: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

2 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

CHANGE SUMMARY

Rev. No Publication Date Reason for Publication Prepared By

1.0.8 07/07/2015 First version. Burak İbrahim SEVİNDİ

Eren ŞENELMİŞ

1.0.13 16/02/2016 Name, parameters taken and changed notifications of the return data structure were updated.

Eren ŞENELMİŞ

14/03/2016 The deficiencies in the parameters taken by the notifications were eliminated.

Packet notifications and other services related to the packet were added.

Eren ŞENELMİŞ

1.0.20 01/07/2016 REST addresses were updated. Ahmet Çağrı ŞİMŞEK

Murat NARMANLI

12/10/2016 Services, service parameters and service messages were updated.

Kerim ÖZTÜRK

08/11/2016 Missing inquiry services were added. Kerim ÖZTÜRK

13/12/2016 The Barcode Agency Field was removed from Inquiries. Missing inquiry services were added.

Ahmet Çağrı Şimşek

1.0.26 20/12/2016 Medula – ÜTS integration services were added. Missing inquiry services and messages were added.

Kerim ÖZTÜRK

1.0.27 27/12/2016 All services related to the packet were deleted. Kerim ÖZTÜRK

1.0.28 09/02/2017 System packet services were added. Emre ÇİLESİZ

1.0.30 15/02/2017 Notification services for purchase/return receipts done with individual product information and unique device identifier were added. The inquiry request and response fields were updated.

Nurseda ÖZDEMİR

1.0.31 23/03/2017 Sample request structures for each notification and inquiry were added. The request and response fields for notifications made with unique device identifier were added. The temporary notification name change was updated as "borrowed". Medula – ÜTS integration services were removed.

Kerim ÖZTÜRK

1.0.33 24/04/2017 Borrowed return, cancellation, borrowed retrieval notification services were added, the individual product and notifications that went out of the system were added.

Kerim ÖZTÜRK

1.0.34 13/06/2017 The data fields that changed as a result of VEDOP inquiries being done instead of MERSIS for Delivery Notifications to places Undesignated on ÜTS and deliver packet notifications for place Undesignated on ÜTS.

Ahmet Çağrı Şimşek

1.0.35 21/09/17 The UDI and unique device identifier fields explanations were corrected, the Delivery to Consumer and Usage Notifications identification no. fields explanations were corrected.

Ahmet Çağrı Şimşek

Page 3: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

3 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

1.0.36 18/10/2017 Data fields were added as needed for different companies to make Retrieve from Consumer Notifications, error messages were added and updates were made in some error messages.

Kerim ÖZTÜRK

1.0.37 23.11.2017 1) A field was added for the "Destroy/Disposal Document Number" required in Destroy/Disposal Notification.

2) The "Company Number" (KUN) field that is required in Borrowed Return Notification was removed.

3) Where "Delivery to Consumer Cancellation Notification" was written has been updated as “Cancel Delivery to Consumer Notification".

4) The required date field "Delivery to Consumer Date" for Delivery to Consumer Notification was added,

The date field "Use Date" required for Usage Notification was added,

The date field "Loan Out Date" required for Loan Out Notification was added,

The date field "Provision for Temporary Use Date" required for Providing for Temporary Usage Notification was added,

The date field "Date of Removal from Patient Body" required for Removal from Patient Body Notification was added,

The common JSON name for these is "GIT" (Actual Transaction Date).

5) The "Voluntary Tracking Scope" (GTK) which is not required has been added to Production and Import Notifications.

6) "Field Company Name" (AKU), "Brand Model Label Name" (MME) has been added to the pending individual product inquiries. "Sender Company Name" (GKU), "Brand Model Label Name" (MME) has been added to the individual product inquiries to be accepted. "Brand Model Label Name" (MME) has been added to the individual product inquiries. "Notifier Company Name" (BKU), "Other Company Name" (DKU) and "Brand Model Label Name" (MME) has been added to notification inquiries. 4. The "Actual Transaction Date" (GIT) added in article 4 was added to the necessary inquiries. "Manufacturer Importer Company No" (UIK) was added to the necessary inquiries.

7) The warning messages added to the system were added to the document.

Kerim Öztürk

1.0.51 18/12/2017 Product Inquiry service was added. Akif BOYNUEĞRİ

Page 4: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

4 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

CONTENTS

1 INTRODUCTION..........................................................................................................................................14

1.1 PURPOSE ....................................................................................................................................................14

1.2 SCOPE .........................................................................................................................................................14

1.3 TERMS AND ABBREVIATIONS ..................................................................................................................14

2 THE GENERAL STRUCTURE OF WEB SERVICES .................................................................................15

2.1 INTEGRATION OF THE ÜTS WITH OTHER INFORMATION SYSTEMS .................................................15

3 WEB SERVICES..........................................................................................................................................16

3.1 ACTION NOTIFICATION SERVICES ..........................................................................................................16

3.1.1.1 Production Notification Service Address ..................................................................................................... 16

3.1.1.2 Production Notification Data Fields ............................................................................................................. 16

3.1.1.3 Production Notification Sample Request .................................................................................................... 18

3.1.2.1 Import Notification Service Address ............................................................................................................ 19

3.1.2.2 Import Notification Data Fields .................................................................................................................... 20

3.1.2.3 Import Notification Sample Request ........................................................................................................... 22

3.1.3.1 Delivery Notification Service Address ......................................................................................................... 24

3.1.3.2 Delivery Notification Sample Request ........................................................................................................ 25

3.1.3.3 Delivery Notification Service Address with Unique Device Identifier Information ....................................... 26

3.1.3.4 Delivery Notification Data Fields with Unique Device Identifier Information ............................................... 26

3.1.3.5 Delivery Notification with Unique Device Identifier Information Sample Request ...................................... 26

3.1.4.1 Receive notification Service Address ......................................................................................................... 27

3.1.4.2 Receive notification Data Fields ................................................................................................................. 27

3.1.4.3 Receive notification Sample Request ......................................................................................................... 29

3.1.4.4 Receive notification Service Address with Unique Device Identifier Information ....................................... 29

3.1.4.5 Receive notification Data Fields with Unique Device Identifier Information ............................................... 29

3.1.4.6 Receive notification with Unique Device Identifier Information Sample Request ....................................... 30

3.1.5.1 Delivery Notification to a Place Undesignated on ÜTS Service Address ................................................... 31

3.1.5.2 Delivery Notification to a Place Undesignated on ÜTS Data Fields ........................................................... 31

3.1.5.3 Delivery Notification to a Place Undesignated on ÜTS Sample Request ................................................... 32

3.1.5.4 Delivery Notification with Unique Device Identifier to a Place Undesignated on ÜTS Service Address .... 32

3.1.5.5 Delivery Notification with Unique Device Identifier to a Place Undesignated on ÜTS Data Fields ............ 32

3.1.5.6 Delivery Notification with Unique Device Identifier to a Place Undesignated on ÜTS Sample Request .... 34

3.1.1 PRODUCTION NOTIFICATION ............................................................................................................................16

3.1.2 IMPORT NOTIFICATION ....................................................................................................................................19

3.1.3 DELIVERY NOTIFICATION .................................................................................................................................24

3.1.4 RECEIVE NOTIFICATION ...................................................................................................................................27

3.1.5 DELIVERY NOTIFICATION TO A PLACE UNDESIGNATED ON ÜTS .........................................................................31

3.1.6 RETRIEVE FROM UNDESIGNATED PLACE ON ÜTS NOTIFICATION ........................................................................34

Page 5: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

5 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

3.1.6.1 Retrieve from undesignated place on ÜTS Notification Service Address .................................................. 34

3.1.6.2 Retrieve from undesignated place on ÜTS Notification Data Fields .......................................................... 34

3.1.6.3 Retrieve from undesignated place on ÜTS Sample Request ..................................................................... 36

3.1.6.4 Retrieve from undesignated place on ÜTS Notification with Unique Device Identifier Service Address.... 36

3.1.6.5 Retrieve from undesignated place on ÜTS Notification with Unique Device Identifier Data Fields ............ 36

3.1.6.6 Retrieve from undesignated place on ÜTS Notification with Unique Device Identifier Sample Request ... 37

3.1.7.1 Usage Notification Service Address ........................................................................................................... 37

3.1.7.2 Usage Notification Data Fields ................................................................................................................... 37

3.1.7.3 Import Notification Sample Request ........................................................................................................... 39

3.1.7.4 Usage Notification with Unique Device Identifier Information Service Address ......................................... 39

3.1.7.5 Usage Notification with Unique Device Identifier Information Data Fields ................................................. 39

3.1.7.6 Usage Notification with Unique Device Identifier Information Sample Request ......................................... 41

3.1.8.1 Delivery to Consumer Notification Service Address ................................................................................... 41

3.1.8.2 Delivery to Consumer Notification Data Fields ........................................................................................... 41

3.1.8.3 Delivery to Consumer Notification Sample Request ................................................................................... 43

3.1.8.4 Delivery to Consumer Notification with Unique Device Identifier Information Service Address ................. 43

3.1.8.5 Delivery to Consumer Notification with Unique Device Identifier Information Data Fields ......................... 43

3.1.8.6 Delivery to Consumer Notification with Unique Device Identifier Information Sample Request ................. 45

3.1.9.1 Retrieve from Consumer Notification Service Address .............................................................................. 45

3.1.9.2 Retrieve from Consumer Notification Data Fields ...................................................................................... 45

3.1.9.3 Retrieve from Consumer Notification Sample Request .............................................................................. 47

3.1.9.4 Retrieve from Consumer Notification with Unique Device Identifier Information Service Address ............ 48

3.1.9.5 Retrieve from Consumer Notification with Unique Device Identifier Information Data Fields .................... 48

3.1.9.6 Retrieve from Consumer Notification with Unique Device Identifier Information Sample Request ............ 49

3.1.10.1 Delivery for Temporary Usage Notification Service Address ...................................................................... 49

3.1.10.2 Delivery for Temporary Usage Notification Data Fields .............................................................................. 49

3.1.10.3 Delivery for Temporary Usage Notification Sample Request ..................................................................... 50

3.1.10.4 Delivery for Temporary Usage Notification with Unique Device Identifier Information Service Address.... 51

3.1.10.5 Delivery for Temporary Usage Notification with Unique Device Identifier Information Data Fields ............ 51

3.1.10.6 Delivery for Temporary Usage Notification with Unique Device Identifier Information Sample Request ... 52

3.1.11.1 Retrieve from Usage Notification Service Address ..................................................................................... 52

3.1.11.2 Retrieve from Usage Notification Data Fields ............................................................................................. 52

3.1.11.3 Retrieve from Usage Notification Sample Request .................................................................................... 54

3.1.11.4 Retrieve from Usage Notification with Unique Device Identifier Information Service Address ................... 54

3.1.7 USAGE NOTIFICATION .....................................................................................................................................37

3.1.8 DELIVERY TO CONSUMER NOTIFICATION ..........................................................................................................41

3.1.9 RETRIEVE FROM CONSUMER NOTIFICATION .....................................................................................................45

3.1.10 DELIVERY FOR TEMPORARY USAGE NOTIFICATION ...........................................................................................49

3.1.11 RETRIEVE FROM USAGE NOTIFICATION ............................................................................................................52

Page 6: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

6 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

3.1.11.5 Retrieve from Usage Notification with Unique Device Identifier Information Data Fields ........................... 54

3.1.11.6 Retrieve from Usage Notification with Unique Device Identifier Information Sample Request .................. 55

3.1.12.1 Reprocessing Notification Service Address ................................................................................................ 55

3.1.12.2 Reprocessing Notification Data Fields ........................................................................................................ 55

3.1.12.3 Reprocessing Notification Sample Request ............................................................................................... 56

3.1.12.4 Reprocessing Notification with Unique Device Identifier Information Service Address .............................. 56

3.1.12.5 Reprocessing Notification with Unique Device Identifier Information Data Fields ...................................... 56

3.1.12.6 Reprocessing Notification with Unique Device Identifier Information Sample Request ............................. 57

3.1.13.1 Export Notification Service Address ........................................................................................................... 57

3.1.13.2 Export Notification Data Fields ................................................................................................................... 57

3.1.13.3 Export Notification Sample Request ........................................................................................................... 58

3.1.13.4 Export Notification with Unique Device Identifier Information Service Address ......................................... 59

3.1.13.5 Export Notification with Unique Device Identifier Information Data Fields ................................................. 59

3.1.13.6 Export Notification with Unique Device Identifier Information Sample Request ......................................... 59

3.1.14.1 Return to Country of Origin Notification Service Address ........................................................................... 60

3.1.14.2 Return to Country of Origin Data Fields ...................................................................................................... 60

3.1.14.3 Return to Country of Origin Notification Sample Request .......................................................................... 60

3.1.14.4 Return to Country of Origin Notification with Unique Device Identifier Information Service Address......... 61

3.1.14.5 Return to Country of Origin Notification with Unique Device Identifier Information Data Fields ................. 61

3.1.14.6 Return to Country of Origin Notification with Unique Device Identifier Information Sample Request ........ 61

3.1.15.1 SOU / Loss Notification Service Address .................................................................................................. 62

3.1.15.2 SOU / Loss Notification Data Fields .......................................................................................................... 62

3.1.15.3 SOU / Loss Notification Sample Request .................................................................................................. 63

3.1.15.4 SOU / Loss Notification with Unique Device Identifier Information Service Address ................................ 63

3.1.15.5 SOU / Loss Notification with Unique Device Identifier Information Data Fields ........................................ 63

3.1.15.6 SOU / Loss Notification with Unique Device Identifier Information Sample Request ................................ 64

3.1.16.1 Recall/Withdrawal Delivery Notification Service Address ........................................................................... 64

3.1.16.2 Recall/Withdrawal Delivery Notification Data Fields ................................................................................... 64

3.1.16.3 Recall/Withdrawal Delivery Notification Sample Request .......................................................................... 65

3.1.16.4 Recall/Withdrawal Delivery Notification with Unique Device Identifier Information Service Address ......... 65

3.1.16.5 Recall/Withdrawal Delivery Notification with Unique Device Identifier Information Data Fields ................. 66

3.1.16.6 Recall/Withdrawal Delivery Notification with Unique Device Identifier Information Sample Request ........ 66

3.1.12 REPROCESSING NOTIFICATION ........................................................................................................................55

3.1.13 EXPORT NOTIFICATION ...................................................................................................................................57

3.1.14 RETURN TO COUNTRY OF ORIGIN NOTIFICATION ..............................................................................................60

3.1.15 SOU / LOSS NOTIFICATION ............................................................................................................................62

3.1.16 RECALL/WITHDRAWAL DELIVERY NOTIFICATION ...............................................................................................64

3.1.17 RECALL/WITHDRAWAL RECEIVE NOTIFICATION ................................................................................................67

Page 7: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

7 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

3.1.17.1 Recall/Withdrawal Receive Notification Service Address ........................................................................... 67

3.1.17.2 Recall/Withdrawal Receive Notification Data Fields ................................................................................... 67

3.1.17.3 Recall/Withdrawal Receive Notification Sample Request .......................................................................... 68

3.1.17.4 Recall/Withdrawal Receive Notification with Unique Device Identifier Information Service Address ......... 69

3.1.17.5 Recall/Withdrawal Receive Notification with Unique Device Identifier Information Data Fields ................. 69

3.1.17.3 Recall/Withdrawal Delivery Notification with Unique Device Identifier Information Sample Request ........ 70

3.1.18.1 Improvement / Corrective Action Notification Service Address .................................................................. 70

3.1.18.2 Improvement / Corrective Action Notification Data Fields .......................................................................... 70

3.1.18.3 Improvement / Corrective Action Notification Sample Request .................................................................. 71

3.1.18.4 Improvement / Corrective Action Notification with Unique Device Identifier Information Service Address 71

3.1.18.5 Improvement / Corrective Action Notification with Unique Device Identifier Information Data Fields ........ 72

3.1.18.6 Improvement / Corrective Action Notification with Unique Device Identifier Information Sample Request 72

3.1.19.1 Destruction / Disposal Notification Service Address ................................................................................... 73

3.1.19.2 Destruction / Disposal Notification Data Fields ........................................................................................... 73

3.1.19.3 Destruction / Disposal Notification Sample Request .................................................................................. 74

3.1.19.4 Destruction / Disposal Notification with Unique Device Identifier Information Service Address ................. 75

3.1.19.5 Destruction / Disposal Notification with Unique Device Identifier Information Data Fields ......................... 75

3.1.19.6 Destruction / Disposal Notification with Unique Device Identifier Information Sample Request ................ 76

3.1.20.1 Removal from Patient’s Body Notification Service Address ....................................................................... 77

3.1.20.2 Removal from Patient’s Body Notification Data Fields ............................................................................... 77

3.1.20.3 Removal from Patient’s Body Notification Sample Request ....................................................................... 78

3.1.20.4 Removal from Patient’s Body Notification with Unique Device Identifier Information Service Address ..... 79

3.1.20.5 Removal from Patient’s Body Notification with Unique Device Identifier Information Data Fields ............. 79

3.1.20.6 Removal from Patient’s Body Notification with Unique Device Identifier Information Sample Request ..... 80

3.1.21.1 Lend Notification Service Address .............................................................................................................. 80

3.1.21.2 Lend Notification Data Fields ...................................................................................................................... 81

3.1.21.3 Lend Notification Sample Request ............................................................................................................. 81

3.1.21.4 Lend Notification with Unique Device Identifier Information Service Address ............................................ 82

3.1.21.5 Lend Notification with Unique Device Identifier Information Data Fields .................................................... 82

3.1.21.6 Lend Notification with Unique Device Identifier Information Sample Request ........................................... 82

3.1.22.1 Borrow Notification Service Address .......................................................................................................... 83

3.1.22.2 Borrow Notification Data Fields .................................................................................................................. 83

3.1.22.3 Borrow Notification Sample Request .......................................................................................................... 84

3.1.22.4 Borrow Notification with Unique Device Identifier Information Service Address ........................................ 85

3.1.18 IMPROVEMENT / CORRECTIVE ACTION NOTIFICATION .......................................................................................70

3.1.19 DESTRUCTION / DISPOSAL NOTIFICATION ........................................................................................................72

3.1.20 REMOVAL FROM PATIENT’S BODY NOTIFICATION ..............................................................................................77

3.1.21 LEND NOTIFICATION .......................................................................................................................................80

3.1.22 BORROW NOTIFICATION ..................................................................................................................................83

Page 8: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

8 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

3.1.22.5 Borrow Notification with Unique Device Identifier Information Data Fields ................................................ 85

3.1.22.6 Borrow Notification with Unique Device Identifier Information Sample Request ........................................ 86

3.1.23.1 Borrow Return Notification Service Address............................................................................................... 86

3.1.23.2 Borrow Return Notification Data Fields ....................................................................................................... 86

3.1.23.3 Borrow Return Notification Sample Request .............................................................................................. 87

3.1.23.4 Borrow Return Notification with Unique Device Identifier Information Service Address ............................ 87

3.1.23.5 Borrow Return Notification with Unique Device Identifier Information Data Fields..................................... 87

3.1.23.6 Borrow Return Notification with Unique Device Identifier Information Sample Request ............................ 88

3.1.24.1 Borrow Retrieve Notification Service Address ............................................................................................ 88

3.1.24.2 Borrow Retrieve Notification Data Fields .................................................................................................... 88

3.1.24.3 Borrow Retrieve Notification Sample Request ........................................................................................... 90

3.1.24.4 Borrow Retrieve Notification with Unique Device Identifier Information Service Address .......................... 90

3.1.24.5 Borrow Retrieve Notification with Unique Device Identifier Information Data Fields .................................. 91

3.1.24.6 Borrow Retrieve Notification with Unique Device Identifier Information Sample Request ......................... 92

3.2 CANCELLATION NOTIFICATIONS.............................................................................................................92

3.2.1.1 Cancellation Notification Data Fields .......................................................................................................... 93

3.2.1.2 Cancellation Notifications Sample Request ................................................................................................ 94

3.3 NOTIFICATION RESPONSE .......................................................................................................................94

3.4 INQUIRING SERVICES ...............................................................................................................................95

3.4.1.1 Individual Product Inquiry Service Address ................................................................................................ 95

3.4.1.2 Individual Product Inquiry Request Data Fields .......................................................................................... 95

3.4.1.3 Individual Product Inquiry Response Data Fields ....................................................................................... 95

3.4.1.4 Individual Product Inquiry Sample Request ................................................................................................ 98

3.4.1.5 Individual Product Inquiry with Unique Device Identifier Service Address ................................................. 98

3.4.1.6 Individual Product Inquiry with Unique Device Identifier Data Fields ......................................................... 98

3.4.1.7 Individual Product Inquiry with Unique Device Identifier Sample Request ................................................. 98

3.4.2.1 Producer/Importer Individual Product Inquiry Service Address .................................................................. 99

3.4.2.2 Producer/Importer Individual Product Inquiry Request Data Fields ........................................................... 99

3.4.2.3 Producer/Importer Individual Product Inquiry Response Data Fields ......................................................... 99

3.4.2.4 Producer/Importer Individual Product Inquiry Sample Request ................................................................ 101

3.1.23 BORROW RETURN NOTIFICATION ....................................................................................................................86

3.1.24 BORROW RETRIEVE NOTIFICATION ..................................................................................................................88

3.2.1 CANCELLATION NOTIFICATIONS SERVICE ADDRESSES ......................................................................................92

3.3.1 NOTIFICATION RESPONSE DATA FIELDS ..........................................................................................................94

3.4.1 INDIVIDUAL PRODUCT INQUIRY ........................................................................................................................95

3.4.2 PRODUCER/IMPORTER INDIVIDUAL PRODUCT INQUIRY ......................................................................................99

3.4.3 PRODUCER’S / IMPORTER’S QUERY SERVICE FOR AN INDIVIDUAL PRODUCT THAT WENT OUT OF THE SYSTEM .101

Page 9: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

9 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

3.4.3.1 Producer’s / Importer’s Query Service for an Individual Product That Went Out of the System Service

Address 102

3.4.3.2 Producer’s / Importer’s Query Service for an Individual Product That Went Out of the System Request

Data Fields ............................................................................................................................................................... 102

3.4.3.3 Producer’s / Importer’s Query Service for an Individual Product That Went Out of the System Response

Data Fields ............................................................................................................................................................... 102

3.4.3.4 Producer’s / Importer’s Query Service for an Individual Product That Went Out of the System Sample

Request 106

3.4.4.1 Pending Individual Product Inquiry Service Address ................................................................................ 106

3.4.4.2 Pending Individual Product Inquiry Request Data Fields ......................................................................... 106

3.4.4.3 Pending Individual Product Inquiry Response Data Fields ....................................................................... 107

3.4.4.4 Pending Individual Product Inquiry Sample Request ............................................................................... 109

3.4.5.1 Borrowed Individual Product Inquiry Service Address .............................................................................. 110

3.4.5.2 Borrowed Individual Product Inquiry Request Data Fields ....................................................................... 110

3.4.5.3 Borrowed Individual Product Inquiry Request Data Fields ....................................................................... 110

3.4.5.4 Borrowed Individual Product Inquiry Sample Request ............................................................................. 113

3.4.6.1 Query Notification Service Address .......................................................................................................... 113

3.4.6.2 Query Notification Request Data Fields .................................................................................................... 113

3.4.6.3 Query Notification Response Data Fields ................................................................................................. 114

3.4.6.4 Query Notification Sample Request .......................................................................................................... 119

3.4.7.1 Query Individual Product to be Accepted Service Address ...................................................................... 119

3.4.7.2 Query Individual Product to be Accepted Request Data Fields ................................................................ 119

3.4.7.3 Query Individual Product to be Accepted Response Data Fields ............................................................. 120

3.4.7.4 Individual Product to be Accepted Inquiry Sample Request ..................................................................... 122

3.4.8.1 Individual Product to be Borrowed Inquiry Service Address ..................................................................... 122

3.4.8.2 Individual Product to be Borrowed Inquiry Request Data Fields .............................................................. 122

3.4.8.3 Individual Product to be Borrowed Inquiry Request Data Fields .............................................................. 123

3.4.8.4 Individual Product to be Borrowed Inquiry Sample Request .................................................................... 126

3.4.9.1 Query Withdrawn Individual Product to be Accepted Service Address .................................................... 126

3.4.9.2 Query Withdrawn Individual Product to be Accepted Request Data Fields ............................................. 126

3.4.9.3 Query Withdrawn Individual Product to be Accepted Request Data Fields ............................................. 126

3.4.9.4 Query Withdrawn Individual Product to be Accepted ............................................................................... 128

3.5 PACKET TRANSFER SYSTEM (PTS) SERVICES ...................................................................................129

3.4.4 PENDING INDIVIDUAL PRODUCT INQUIRY ........................................................................................................106

3.4.5 QUERY BORROWED INDIVIDUAL PRODUCT .....................................................................................................110

3.4.6 QUERY NOTIFICATION ...................................................................................................................................113

3.4.7 QUERY INDIVIDUAL PRODUCT TO BE ACCEPTED .............................................................................................119

3.4.8 QUERY INDIVIDUAL PRODUCT TO BE BORROWED ...........................................................................................122

3.4.9 QUERY WITHDRAWN INDIVIDUAL PRODUCT TO BE ACCEPTED .........................................................................126

Page 10: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

10 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

3.5.1.1 Add Packet Service Address .................................................................................................................... 129

3.5.1.2 Add Packet Request Data Fields .............................................................................................................. 129

3.5.1.3 Add Packet Response Data Fields ........................................................................................................... 130

3.5.1.4 Add Packet Sample Request .................................................................................................................... 131

3.5.2.1 Delete Packet Service Address ................................................................................................................ 132

3.5.2.2 Delete Packet Request Data Fields .......................................................................................................... 132

3.5.2.3 Delete Packet Response Data Fields ....................................................................................................... 132

3.5.2.4 Delete Packet Sample Request ................................................................................................................ 133

3.5.3.1 Query Packet Service Address ................................................................................................................. 133

3.5.3.2 Query Packet Request Data Fields .......................................................................................................... 134

3.5.3.3 Query Packet Response Data Fields ........................................................................................................ 134

3.5.3.4 Query Packet Sample Request ................................................................................................................ 135

3.5.4.1 Mark as Read the Packet that Arrived at the Organization Service Address ........................................... 135

3.5.4.2 Mark as Read the Packet that Arrives at the Organization Request Data Fields ..................................... 135

3.5.4.3 Mark as Read the Packet that Arrives at the Organization Response Data Fields .................................. 136

3.5.4.4 Mark as Read the Packet that Arrived at the Organization Sample Request ........................................... 137

3.5.5.1 Bring the Packet that Arrived at the Organization Service Address ......................................................... 137

3.5.5.2 Bring the Packet that Arrived at the Organization Request Data Fields ................................................... 137

3.5.5.3 Bring the Packet that Arrived at the Organization Response Data Fields ................................................ 137

3.5.5.4 Query Packet that Arrived at Organization Sample Request ................................................................... 139

3.5.6.1 Query the Packets that Arrived at the Organization Service Address ...................................................... 139

3.5.6.2 Query the Packet that Arrived at the Organization Request Data Fields ................................................. 139

3.5.6.3 Query the Packets that Arrived at the Organization Response Data Fields ............................................. 140

3.5.6.4 Query Packets that Arrived at Organization Sample Request.................................................................. 141

3.6 QUERY COMPANY SERVICE ..................................................................................................................141

3.7 SEARCH PRODUCT DEFINITION SERVICE ...........................................................................................143

3.5.1 ADD PACKET ................................................................................................................................................129

3.5.2 DELETE PACKET ...........................................................................................................................................132

3.5.3 QUERY PACKET ............................................................................................................................................133

3.5.4 MARK AS READ THE PACKET THAT ARRIVED AT THE ORGANIZATION ................................................................135

3.5.5 BRING THE PACKET THAT ARRIVED AT THE ORGANIZATION .............................................................................137

3.5.6 QUERY PACKETS THAT ARRIVED AT ORGANIZATION .......................................................................................139

3.6.1 QUERY COMPANY SERVICE ADDRESS ...........................................................................................................142

3.6.2 QUERY COMPANY SERVICE DATA FIELDS ......................................................................................................142

3.6.3 PRODUCT INQUIRY SERVICE SAMPLE REQUEST .............................................................................................142

3.7.1 SEARCH PRODUCT DEFINITION SERVICE ADDRESS ........................................................................................143

3.7.2 SEARCH PRODUCT DEFINITION SERVICE DATA FIELDS ...................................................................................143

3.7.3 SEARCH PRODUCT DEFINITION SERVICE SAMPLE REQUEST ...........................................................................143

Page 11: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

11 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

4 ANNEXES ..................................................................................................................................................145

4.1 ANNEX-A SERVICE MESSAGES .............................................................................................................145

TABLES

Table 1. Production Notification Data Fields ........................................................................................................... 16

Table 2. Import Notification Data Fields .................................................................................................................. 20

Table 3. Delivery Notification Data Fields ............................................................................................................... 24

Table 4. Delivery Notification Data Fields with Unique Device Identifier Information ............................................. 26

Table 5. Receive notification Data Fields ................................................................................................................ 27

Table 6. Receive notification Data Fields with Unique Device Identifier Information .............................................. 29

Table 7. Delivery Notification to a Place Undesignated on ÜTS Data Fields .......................................................... 31

Table 8. Delivery Notification with Unique Device Identifier to a Place Undesignated on ÜTS Data Fields ........... 32

Table 9 .Retrieve from undesignated place on ÜTS Notification Data Fields ......................................................... 34

Table 10. Retrieve from undesignated place on ÜTS Notification with Unique Device Identifier Data Fields ....... 36

Table 11.Usage Notification Data Fields ................................................................................................................. 37

Table 12. Usage Notification with Unique Device Identifier Information Data Fields .............................................. 39

Table 13.Delivery to Consumer Notification Data Fields ......................................................................................... 41

Table 14. Delivery to Consumer Notification with Unique Device Identifier Information Data Fields ...................... 43

Table 15 .Retrieve from Consumer Notification Data Fields ................................................................................... 45

Table 16. Retrieve from Consumer Notification with Unique Device Identifier Information Data Fields ................. 48

Table 17 . Delivery for Temporary Usage Notification Data Fields ......................................................................... 49

Table 18. Delivery for Temporary Usage Notification with Unique Device Identifier Information Data Fields ........ 51

Table 19. Retrieve from Usage Notification Data Fields ......................................................................................... 52

Table 20. Retrieve from Usage Notification with Unique Device Identifier Information Data Fields ...................... 54

Table 21. Reprocessing Notification Data Fields .................................................................................................... 55

Page 12: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

12 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Table 22. Reprocessing Notification with Unique Device Identifier Information Data Fields .................................. 56

Table 23. Export Notification Data Fields ................................................................................................................ 57

Table 24. Export Notification with Unique Device Identifier Information Data Fields .............................................. 59

Table 25. Return to Country of Origin Data Fields .................................................................................................. 60

Table 26. Return to Country of Origin Notification with Unique Device Identifier Information Data Fields ............. 61

Table 27 .SOU / Loss Notification Data Fields ....................................................................................................... 62

Table 28. SOU / Loss Notification with Unique Device Identifier Information Data Fields ..................................... 63

Table 29. Recall/Withdrawal Delivery Notification Data Fields ............................................................................... 64

Table 30. Recall/Withdrawal Delivery Notification with Unique Device Identifier Information Data Fields ............. 66

Table 31. Recall/Withdrawal Receive Notification Data Fields ............................................................................... 67

Table 32. Recall/Withdrawal Receive Notification with Unique Device Identifier Information Data Fields ............ 69

Table 33 .Improvement / Corrective Action Notification Data Fields ....................................................................... 70

Table 34. Improvement / Corrective Action Notification with Unique Device Identifier Information Data Fields ..... 72

Table 35. Destruction / Disposal Notification Data Fields ....................................................................................... 73

Table 36. Destruction / Disposal Notification with Unique Device Identifier Information Data Fields ..................... 75

Table 37. Removal from Patient’s Body Notification Data Fields ............................................................................ 77

Table 38. Removal from Patient’s Body Notification with Unique Device Identifier Information Data Fields .......... 79

Table 39 . Lend Notification Data Fields ................................................................................................................. 81

Table 40. Lend Notification with Unique Device Identifier Information Data Fields ............................................... 82

Table 41. Borrow Notification Data Fields ............................................................................................................... 83

Table 42. Borrow Notification with Unique Device Identifier Information Data Fields ............................................. 85

Table 43. Borrow Return Notification Data Fields ................................................................................................... 86

Table 44. Borrow Return Notification with Unique Device Identifier Information Data Fields ................................. 87

Table 45. Borrow Retrieve Notification Data Fields ................................................................................................. 88

Table 46. Borrow Retrieve Notification with Unique Device Identifier Information Data Fields............................... 91

Table 47. Cancellation Notifications Service Addresses ......................................................................................... 92

Table 48. Cancellation Notification Data Fields ....................................................................................................... 93

Table 49. Notification Response Data Fields .......................................................................................................... 94

Table 50. Individual Product Inquiry Request Data Fields ...................................................................................... 95

Table 51. Individual Product Inquiry Response Data Fields ................................................................................... 95

Table 52. Individual Product Inquiry with Unique Device Identifier Data Fields ...................................................... 98

Table 53. Producer/Importer Individual Product Inquiry Request Data Fields ........................................................ 99

Table 54. Producer/Importer Individual Product Inquiry Response Data Fields ..................................................... 99

Table 55. Producer’s / Importer’s Query Service for an Individual Product That Went Out of the System Request

Data Fields ............................................................................................................................................................. 102

Table 56. Producer’s / Importer’s Query Service for an Individual Product That Went Out of the System Response

Data Fields ............................................................................................................................................................. 102

Table 57. Pending Individual Product Inquiry Request Data Fields ...................................................................... 106

Table 58. Pending Individual Product Inquiry Response Data Fields ................................................................... 107

Page 13: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

13 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Table 59. Borrowed Individual Product Inquiry Request Data Fields ................................................................... 110

Table 60. Borrowed Individual Product Inquiry Request Data Fields .................................................................... 110

Table 61. Query Notification Request Data Fields ................................................................................................ 113

Table 62. Query m Notification Response Data Fields ......................................................................................... 114

Table 63. Query Individual Product to be Accepted Request Data Fields ............................................................ 119

Table 64. Query Individual Product to be Accepted Response Data Fields ......................................................... 120

Table 65. Individual Product to be Borrowed Inquiry Request Data Fields ........................................................... 122

Table 66. Individual Product to be Borrowed Inquiry Request Data Fields ........................................................... 123

Table 67. Query Withdrawn Individual Product to be Accepted Request Data Fields .......................................... 126

Table 68. Query Withdrawn Individual Product to be Accepted Request Data Fields .......................................... 126

Table 69. Add Packet Request Data Fields .......................................................................................................... 129

Table 70. Add Packet Response Data Fields ........................................................................................................ 130

Table 71. Delete Packet Request Data Fields ...................................................................................................... 132

Table 72. Delete Packet Response Data Fields .................................................................................................... 132

Table 73. Query Packet Request Data Fields ....................................................................................................... 134

Table 74. Query Packet Response Data Fields .................................................................................................... 134

Table 75. Mark as Read the Packet that Arrives at the Organization Request Data Fields ................................. 135

Table 76. Mark as Read the Packet that Arrives at the Organization Response Data Fields............................... 136

Table 77. Bring the Packet that Arrived at the Organization Request Data Fields ............................................... 137

Table 78. Bring the Packet that Arrives at the Organization Response Data Fields ............................................ 137

Table 79. Query the Packet that Arrived at the Organization Request Data Fields .............................................. 139

Table 80. Query the Packets that Arrived at the Organization Response Data Fields ......................................... 140

Table 81. Query Company Service Data Fields .................................................................................................... 142

Table 82. Query Product Service Data Fields ....................................................................................................... 143

Table 83. Service Messages ................................................................................................................................. 145

Page 14: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

14 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

1 INTRODUCTION

1.1 PURPOSE

Companies and organizations will be able to use the web services or the ÜTS web interface to be provided by the

ÜTS to report their actions. In order to use the ÜTS web services the organizations and companies must integrate

their information systems according to the web service definitions with ÜTS. The purpose of this document is to

provide the information that organizations or companies may need to use the web services provided by ÜTS

1.2 SCOPE

The services that are used for transactions in the scope of both normal actions and return actions for individual

products have been described in this document. By using these services companies or organizations will be able

to report changes in ownership of individual products, amounts or use figures.

The purpose of each service has been briefly explained in the document; the access address for the service, the

parameters necessary to call the service and the data structure of the response returned by the service have

been defined.

1.3 TERMS AND ABBREVIATIONS

Term / Abbreviation Definition

BİLGEM Informatics and Information Security ReQuery Center

Action Notification

This is the notification that is made for the action of each lot/party/batch of each

individual product. Each action notification has a format that has been pre-assigned

by the ÜTS.

Administration TİTCK

JSON JavaScript Object Notation

REST Representational State Transfer

System Product Tracking System

Individual Product The individual unit of each product. For example; each blood pressure gauging

instrument or each perfume bottle is an individual product.

TİTCK T.R. Ministry of Health Medicines and Medical Devices Agency

TÜBİTAK Scientific and Technological Research Council of Turkey

MERSİS Central Registration System

UDI Unique Device Identification

URL Uniform Resource Locator

Product Each of the medical devices and cosmetic products of organizations and companies

Page 15: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

15 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Term / Abbreviation Definition

that are registered in the ÜTS.

ÜTS Product Tracking System

YTE Software Technologies ReQuery Institute

2 THE GENERAL STRUCTURE OF WEB SERVICES

2.1 INTEGRATION OF THE ÜTS WITH OTHER INFORMATION SYSTEMS

All of the functions that the ÜTS provides to users are in standard REST services form. These functions can be

used through the user interfaces provided by ÜTS and are also open to integration with other information

systems.

In order for users to integrate their own information systems to ÜTS they must obtain an integration key by using

the PTS interfaces. The integration key is a code produced using e-signature. This is called a code system token.

The purpose of the system code is to verify the identity of information systems that wish to send notification to

ÜTS and to determine the limits of their authority.

After the user information system obtains the system token they must add the system token's value with the

utsToken label to the header section of each web service call they make. Otherwise when the system token is not

added to the header section of the REST call with the utsToken label a PTS authorization error will appear and

will not complete the transaction.

Users can obtain the system token they will use to integrate their own information systems to ÜTS by following

the below steps (The users that will be following these steps must have signature authority in their company /

organization). Whether or not users have signature authority shall be automatically searched from MERSIS.).

1. With a user in the authorized user group the address “https://utsuygulama.saglik.gov.tr1” can be used to

enter ÜTS. If necessary the user must use the “Change Account” link to enter the relevant account of the

organization / company they want to do a transaction on.

2. The user will choose the “User System User Assignment Transactions” option from the menu.

3. The user will sign the text that appears on the screen using e-signature.

4. The PTS will create a system token for the user and the user will copy this token to their own information

system.

1 The Product Actions and Product Call Back Modules also provide service in the PTS test setting

(https://utstest.saglik.gov.tr). Companies can also use the test setting to do a trial. The data in the test setting will

not be transferred to the real setting.

Page 16: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

16 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

3 WEB SERVICES

3.1 ACTION NOTIFICATION SERVICES

When evaluated in terms of individual product actions the ÜTS is a closed system. Individual products start to be

in the System (ÜTS) with their Production or Import notification. Individual products change hands between

organizations/companies assigned on the System with their Delivery and Receive notifications. When an

individual product is given to an organization/company that is not assigned to the ÜTS the "Delivery to

Undesignated Place Notification" is used on ÜTS. The individual product will go off the System with this

notification. The "Delivery to Consumer Notification" is used for individual products that are given to patients or

consumers for a fee or free of charge. The individual product will go off the System with the "Delivery to

Consumer Notification".

The actions of individual products with a recall on them can be restricted. Specialized services have been

designated for individual products with restricted action.

Each notification has been explained in a separate section. The address of the service to which the notification

will be called and fields that must be sent with the service call have been specified.

The data structures that the service rotates as a result of all action notifications are common. This data structure

has been explained under the heading number 3.2.1.2.

3.1.1 Production Notification

The Producer makes a Production Notification for each individual product they produce.

3.1.1.1 Production Notification Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/uretim/ekle

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/uretim/ekle

3.1.1.2 Production Notification Data Fields

Table 1. Production Notification Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Product Number UNO Text 23 Yes The product's product number/barcode

number.

Page 17: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

17 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Lot/Batch

Number LNO Text 20

Condition

al

Required to submit for products tracked

by lot.

Serial/Order

Number SNO Text 20

Condition

al

Required to submit for products tracked

individually.

Production Date URT Date 10 Yes In YYYY-MM-DD format. Y: Year, M:

Month, D: Day.

Expiry Date SKT Date 13 No

In YYYY-MM-DD TT format. Y: Year, M:

Month, D: Day, T: Time.

Time is not given for GS1 products.

Time and day fields may not be given

according to HIBCC product properties.

Item ADT Number - Condition

al

Not given for products tracked

individually.

Specifies how many were produced

from the same lot/series/batch for

products tracked by lot.

Required to submit for products tracked

by lot.

Unique Device

Identifier UDI Text -

Condition

al

If available the Unique Device Identifier

of an individual product known as

Unique Device Identifier (UDI) or

Datamatrix can be given.

System and

Procedure

Packs

SIP

List

(BRK, UNO,

LNO, SNO,

ADT)

- Condition

al

Required if the individual product has a

System and Procedure Packs and there

is at least one product in it that is in the

scope of tracking.

The information provided in the list is

sub individual product information.

Page 18: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

18 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Cosmetic

Product Set KUS

List

(BRK, UNO,

LNO, SNO,

ADT)

- Condition

al

Required if the individual product is a

cosmetic product set and there is at

least one product in it that is in the

scope of tracking.

The information provided in the list is

sub individual product information.

Voluntary

Tracking Scope GTK

Single Option

List 5 No

Required field for voluntary tracking by

companies of products that do not have

any tracking configuration.

It can take on one of the values below.

INDIVIDUAL

LOT

3.1.1.3 Production Notification Sample Request

Sample 1 product with lot tracking:

{

"UNO" : "1111111110324",

"LNO" : "250515186001",

"ADT" : 100,

"UDI" : "011111111110324111603021719030210250515186001",

"URT" : "2016-03-02",

"SKT" : "2019-03-02"

}

Sample 2 product with individual tracking:

{

"UNO" : "1111111110010",

"SNO" : "KYY012345678999",

"UDI" : "011111111110010111603021719030221KYY012345678999",

"URT" : "2016-03-02",

"SKT" : "2019-03-02"

}

Page 19: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

19 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

NOTE: On individually tracked products the “ADT” information must be entered as “1” or o field should not be

entered.

Sample 3 individually tracked System and Procedure Packs:

{

"UNO" : "9321502013475",

"SNO" : "112212345678MM9",

"UDI" : "019321502013475111603021719030221112212345678MM9",

"ADT" : 1,

"URT" : "2016-03-02",

"SKT" : "2019-03-02",

"SIP" : [

{

"UNO" : "2451643000038",

"SNO" : "B8NN12345678999"

},

{

"UNO" : "2451643000007",

"LNO" : "250515186001",

"ADT" : 10

}

]

}

Sample 4 production by voluntarily tracking a product without a tracking configuration individually:

{

"UNO" : "1111111110010",

"SNO" : "KYY012345678999",

"UDI" : "011111111110010111603021719030221KYY012345678999",

"URT" : "2016-03-02",

"SKT" : "2019-03-02",

"GTK" : "INDIVIDUAL"

}

3.1.2 Import Notification

An Importer makes an Import Notification for the individual products they import.

3.1.2.1 Import Notification Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/ithalat/ekle

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/ithalat/ekle

Page 20: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

20 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

3.1.2.2 Import Notification Data Fields

Table 2. Import Notification Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Product Number UNO Text 23 Yes The product's product number/barcode

number.

Lot/Batch

Number LNO Text 20

Condition

al

Required to submit for products tracked

by lot.

Serial/Order

Number SNO Text 20

Condition

al

Required to submit for products tracked

individually.

Production Date URT Date 10 Yes

In YYYY-MM-DD format. Y: Year, M:

Month and D: Means day.

If an import date has been provided for

cosmetic products the production date

can be omitted.

Expiry Date SKT Date 13 No

In YYYY-MM-DD TT format. Y: Year, M:

Month, D: Means Day and T means

time.

Time is not given for GS1 products.

Time and day fields may not be given

according to HIBCC product properties.

Import Date ITT Date 10 Condition

al

In YYYY-MM-DD format. Y: Year, M:

Month and D: Means day.

The import date must be provided for

cosmetic products when the production

date is not known.

Page 21: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

21 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Item ADT Number - Condition

al

Not given for products tracked

individually.

Specifies how many were imported from

the same lot/series/batch for products

tracked by lot.

Required to submit for products tracked

by lot.

Unique Device

Identifier UDI Text -

Condition

al

If available the Unique Device Identifier

of an individual product known as

Unique Device Identifier (UDI) or

Datamatrix can be given.

Imported

Country IEU Number 3 Yes The country code. *

Origin Country MEU Number 3 Yes The country code. *

Customs

Declaration

Number

GBN Text 16 Yes -

System and

Procedure

Packs

SIP

List

(BRK, UNO,

LNO, SNO,

ADT)

- Condition

al

Required if the individual product has a

System and Procedure Packs and there

is at least one product in it that is in the

scope of tracking.

The information provided in the list is

sub individual product information.

Cosmetic

Product Set KUS

List

(BRK, UNO,

LNO, SNO,

ADT)

- Condition

al

Required if the individual product is a

cosmetic product set and there is at

least one product in it that is in the

scope of tracking.

The information provided in the list is

sub individual product information.

Page 22: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

22 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Voluntary

Tracking Scope GTK

Single Option

List 5 No

Required field for voluntary tracking by

companies of products that do not have

any tracking configuration.

It can take on one of the values below.

INDIVIDUAL

LOT

* The codes published by the Risk Management and Directorate General of Control are used.

3.1.2.3 Import Notification Sample Request

Sample 1 product with lot tracking:

{

"UNO" : "1111111110058",

"LNO" : "250515186001",

"ADT" : 100,

"UDI" : "011111111110058111603021719030210250515186001",

"URT" : "2016-03-02",

"SKT" : "2019-03-02",

"IEU" : "038",

"MEU" : "452",

"GBN" : "15343100IM003176"

}

Sample 2 product with individual tracking:

{

"UNO" : "1111111110065",

"SNO" : "KYY012345678999",

"UDI" : "011111111110065111603021719030221KYY012345678999",

"URT" : "2016-03-02",

"SKT" : "2019-03-02",

"IEU" : "716",

"MEU" : "082",

Page 23: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

23 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

"GBN" : "15343100IM003176"

}

NOTE: On individually tracked products the “ADT” information must be entered as “1” or o field should

not be entered.

Sample 3 individually tracked System and Procedure Packs:

{

"UNO" : "851479856540",

"SNO" : "112212345678MM9",

"UDI" : "01851479856540111603021719030221112212345678MM9",

"ADT" : 1,

"URT" : "2016-03-02",

"SKT" : "2019-03-02",

"IEU" : "400",

"MEU" : "400",

"GBN" : "15343100IM003176",

"SIP" : [

{

"UNO" : "1111111110065",

"SNO" : "KYY012345678999"

},

{

"UNO" : "1111111110058",

"LNO" : "250515186001",

"ADT" : 1

}

]

}

Sample 4 importing by voluntarily tracking a product without a tracking configuration individually:

{

"UNO" : "1111111110065",

"SNO" : "KYY012345678999",

"UDI" : "011111111110065111603021719030221KYY012345678999",

"URT" : "2016-03-02",

"SKT" : "2019-03-02",

"IEU" : "716",

Page 24: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

24 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

"MEU" : "082",

"GBN" : "15343100IM003176",

"GTK" : "INDIVIDUAL"

}

3.1.3 Delivery Notification

When the organization/company gives the individual products they own to another organization/company they

make a Delivery Notification. Delivery Notifications are made for sales, donations, returns, etc.

3.1.3.1 Delivery Notification Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/verme/ekle

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/verme/ekleDelivery Notification Data Fields

Table 3. Delivery Notification Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Product Number UNO Text 23 Yes The product's product number/barcode

number.

Lot/Batch

Number LNO Text 20

Condition

al

Required to submit for products tracked

by lot.

Serial/Order

Number SNO Text 20

Condition

al

Required to submit for products tracked

individually.

Item ADT Number - Condition

al

Not given for products tracked

individually.

Specifies how many were given from

the same lot/series/batch for products

tracked by lot.

Required to submit for products tracked

by lot.

Organization No KUN Number - Yes

The number of the

organization/company assigned on the

ÜTS that the individual product was

given to.

Page 25: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

25 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Free Sample BEN Single Option

List 5 No

Specifies whether the given individual

products were free samples or not.

They may take on the values below.

The default value is NO.

YES: Yes

NO: No

Document

Number BNO Text 50 Yes

The invoice and/or Dispatch note

number.

3.1.3.2 Delivery Notification Sample Request

{

"UNO" : "2451643000007",

"LNO" : "250515186001",

"ADT" : 25,

"KUN" : 7,

"BEN" : "NO",

"BNO" : "123B"

}

3.1.3.3 Delivery Notification Service Address with Unique Device Identifier Information

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/verme/ekle/essizKimlik

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/verme/ekle/essizKimlik

3.1.3.4 Delivery Notification Data Fields with Unique Device Identifier Information

Table 4. Delivery Notification Data Fields with Unique Device Identifier Information

Page 26: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

26 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Unique Device

Identifier UDI Text - Required

This must be provided when you want

to make a notification with the individual

product unique identity known as the

Unique Device Identifier (UDI) or

Datamatrix.

Item ADT Number - No

Not given for products tracked

individually.

Specifies how many were taken from

the same lot/series/batch for products

tracked by lot.

Used when an amount of individual

products less than what was given is

taken.

The item amount information in the

default value Delivery Notification.

Organization No KUN Number - Yes

The number of the

organization/company assigned on the

ÜTS that the individual product was

given to.

Document

Number BNO Text 50 Yes

The invoice and/or Dispatch note

number.

3.1.3.5 Delivery Notification with Unique Device Identifier Information Sample Request

{

“UDI” : “0151022222233336111603021719030210A213B1211234”,

"KUN" : 7,

"ADT" : 5,

"BNO" : "123"

}

Page 27: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

27 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

3.1.4 Receive notification

The organization/company makes a Receive notification to accept individual products given to them. With this

notification the individual product ownership passes to the receiving side.

3.1.4.1 Receive notification Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/alma/ekle

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/alma/ekle

3.1.4.2 Receive notification Data Fields

Table 5. Receive notification Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Delivery

Notification ID VBI Number -

Condition

al

Shows which Delivery Notification the

product is being taken against.

Item ADT Number - No

Not given for products tracked

individually.

Specifies how many were taken from

the same lot/series/batch for products

tracked by lot.

Used when an amount of individual

products less than what was given is

taken.

The item amount information in the

default value Delivery Notification.

Page 28: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

28 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Sending

Organization

Number

GKK Number - Condition

al

The number of the notifying

organization that is assigned on the

ÜTS.

If Delivery Notifications have been

made by different organizations for the

individual products that have the same

individual product information in an

organization this is necessary to specify

the Delivery Notification from which

organization you want to make a

receive notification against.

Unique Device

Identifier UDI Text -

Condition

al

This must be provided to make a

receive notification with a Unique

Device Identifier when a notification

code is not provided.

Product Number UNO Text 23 Condition

al

The product's product number/barcode

number.

If a notification code or unique device

identifier is not provided the product

number must be provided when you

want to take with the individual product

information.

Lot/Batch

Number LNO Text 20

Condition

al

If a notification code or unique device

identifier is not provided the product

number must be provided when you

want to receivewith the individual

product information.

Required to submit for products tracked

by lot.

Page 29: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

29 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Serial/Order

Number SNO Text 20

Condition

al

If a notification code or unique device

identifier is not provided the product

number must be provided when you

want to receivewith the individual

product information.

Required to submit for products tracked

individually.

3.1.4.3 Receive notification Sample Request

Sample 1 receive notification request made with Delivery Notification ID:

{

"VBI" : "5d59e861-0ecc-11e7-a708-f52ed20ddd29",

"ADT" : 15

}

Sample 2 receive notification request made with lot/batch no and series/order no:

{

"UNO" : "1111111110324",

"LNO" : "250515186001",

"ADT" : 5,

“GKK" : 10

}

3.1.4.4 Receive notification Service Address with Unique Device Identifier Information

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/alma/ekle/essizKimlik

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/alma/ekle/essizKimlik

3.1.4.5 Receive notification Data Fields with Unique Device Identifier Information

Table 6. Receive notification Data Fields with Unique Device Identifier Information

Page 30: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

30 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Unique Device

Identifier UDI Text - Required

This must be provided to make a

receive notification with a Unique

Device Identifier when a notification

code is not provided.

Item ADT Number - No

Not given for products tracked

individually.

Specifies how many were taken from

the same lot/series/batch for products

tracked by lot.

Used when an amount of individual

products less than what was given is

taken.

The item amount information in the

default value Delivery Notification.

Sending

Organization

Number

GKK Number - No

The number of the notifying

organization that is assigned on the

ÜTS.

If Delivery Notifications have been

made by different organizations for the

unique device identified individual

products that have the same individual

product information in an organization

this is necessary to specify the Delivery

Notification from which organization you

want to make a receive notification

against.

3.1.4.6 Receive notification with Unique Device Identifier Information Sample Request

{

“UDI” : “0151022222233336111603021719030210A213B1211234”,

"ADT" : 5,

Page 31: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

31 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

"GKK" : 10

}

3.1.5 Delivery Notification to a Place Undesignated on ÜTS

When an organization/company gives an individual product to a company that is not assigned on the ÜTS they

make a Delivery Notification to a Place Undesignated on ÜTS.

3.1.5.1 Delivery Notification to a Place Undesignated on ÜTS Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/utsdeTanimsizYereVerme/ekle

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/utsdeTanimsizYereVerme/ekle

3.1.5.2 Delivery Notification to a Place Undesignated on ÜTS Data Fields

Table 7. Delivery Notification to a Place Undesignated on ÜTS Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Product Number UNO Text 23 Yes The product's product number/barcode

number.

Lot/Batch

Number LNO Text 20

Condition

al

Required to submit for products tracked

by lot.

Serial/Order

Number SNO Text 20

Condition

al

Required to submit for products tracked

individually.

Item ADT Number - Condition

al

Not given for products tracked

individually.

Specifies how many were given from

the same lot/series/batch for products

tracked by lot.

Required to submit for products tracked

by lot.

Page 32: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

32 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Free Sample BEN Single Option

List 5 No

Specifies whether the given individual

products were free samples or not.

They may take on the values below.

The default value is NO.

YES: Yes

NO: No

Tax

Identification No VKN Number - Yes

It is mandatory to enter the tax

identification number of a company not

registered on ÜTS.

Document

Number BNO Text 50 Yes

The invoice and/or Dispatch note

number.

3.1.5.3 Delivery Notification to a Place Undesignated on ÜTS Sample Request

{

"UNO" : "1111111110058",

"LNO" : "250515186001",

"ADT" : 25,

"VKN" : "1234567890",

"BNO" : "123B",

"BEN" : "NO"

}

3.1.5.4 Delivery Notification with Unique Device Identifier to a Place Undesignated on ÜTS Service

Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/utsdeTanimsizYereVerme/ekle/essizKimlik

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/utsdeTanimsizYereVerme/ekle/essizKimlik

3.1.5.5 Delivery Notification with Unique Device Identifier to a Place Undesignated on ÜTS Data Fields

Table 8. Delivery Notification with Unique Device Identifier to a Place Undesignated on ÜTS Data Fields

Page 33: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

33 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Unique Device

Identifier UDI Text - Required

Must be provided when you want to

make a notification with Unique Device

Identifier.

Item ADT Number - Condition

al

Not given for products tracked

individually.

Specifies how many were given from

the same lot/series/batch for products

tracked by lot.

Required to submit for products tracked

by lot.

Free Sample BEN Single Option

List 5 No

Specifies whether the given individual

products were free samples or not.

They may take on the values below.

The default value is NO.

YES: Yes

NO: No

Tax

Identification No VKN Number - Yes

It is mandatory to enter the tax

identification number of a company not

registered on ÜTS.

MERSİS No MEN Number - Condition

al

Must be provided when the individual

product is to be given to a company

assigned on MERSİS.

T.R.

Identification No TKN Number -

Condition

al

Must be provided when the individual

product is to be given to a company

assigned on ESBİS.

Vocation Code MEK Number - Condition

al

Must be provided when the individual

product is to be given to a company

assigned on ESBİS.

Page 34: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

34 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Chamber Code ODK Number - Condition

al

Must be provided when the individual

product is to be given to a company

assigned on ESBİS.

Document

Number BNO Text 50 Yes

The invoice and/or Dispatch note

number.

3.1.5.6 Delivery Notification with Unique Device Identifier to a Place Undesignated on ÜTS Sample

Request

{

“UDI” : “0151022222233336111603021719030210A213B1211234”,

"ADT" : 5,

"VKN" : "1234567890",

"BNO" : "123B",

"BEN" : "NO"

}

3.1.6 Retrieve from undesignated place on ÜTS Notification

When an organization/company takes back an individual product to a company that is not assigned on the ÜTS

they make a Retrieve from undesignated place on ÜTS Notification.

3.1.6.1 Retrieve from undesignated place on ÜTS Notification Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/utsdeTanimsizYerdenIadeAlma/ekle

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/utsdeTanimsizYerdenIadeAlma/ekle

3.1.6.2 Retrieve from undesignated place on ÜTS Notification Data Fields

Table 9 .Retrieve from undesignated place on ÜTS Notification Data Fields

Page 35: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

35 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Delivery

Notification to a

Place

Undesignated

on ÜTS ID

UTI Number - Condition

al

This expresses which Delivery

Notification to place Undesignated on

ÜTS that the return from place

Undesignated on ÜTS is being made

against.

Item ADT Number - Condition

al

Not given for products tracked

individually.

Specifies how many were given from

the same lot/series/batch for products

tracked by lot.

Required to submit for products tracked

by lot.

Unique Device

Identifier UDI Text -

Condition

al

This must be provided to make a

receive notification with a Unique

Device Identifier when a notification

code is not provided.

Product Number UNO Text 23 Condition

al

The product's product number/barcode

number.

When you want to make a return with

individual product information and the

notification code or unique device

identifier is not provided, the product

number must be provided.

Lot/Batch

Number LNO Text 20

Condition

al

If a notification code or unique device

identifier is not provided the product

number must be provided when you

want to receivea return with the

individual product information.

Required to submit for products tracked

by lot.

Page 36: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

36 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Serial/Order

Number SNO Text 20

Condition

al

If a notification code or unique device

identifier is not provided the product

number must be provided when you

want to receivea return with the

individual product information.

Required to submit for products tracked

individually.

3.1.6.3 Retrieve from undesignated place on ÜTS Sample Request

Sample 1 Request for retrieve from undesignated place on ÜTS notification made with retrieve from undesignated

place on ÜTS notification ID:

{

"UTI" : "5d59e861-0ecc-11e7-a708-f52ed20ddd29",

"ADT" : 15

}

Sample 2 retrieve from undesignated place on ÜTS notification request made with lot/batch no and series/order

no:

{

"UNO" : "1111111110324",

"LNO" : "250515186001",

"ADT" : 5

}

3.1.6.4 Retrieve from undesignated place on ÜTS Notification with Unique Device Identifier Service

Address

Real Setting:

https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/utsdeTanimsizYerdenIadeAlma/ekle/essizKimlik

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/utsdeTanimsizYerdenIadeAlma/ekle/essizKimlik

3.1.6.5 Retrieve from undesignated place on ÜTS Notification with Unique Device Identifier Data Fields

Table 10. Retrieve from undesignated place on ÜTS Notification with Unique Device Identifier Data Fields

Page 37: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

37 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Unique Device

Identifier UDI Text - Required

This must be provided to make a

receive notification with a Unique

Device Identifier when a notification

code is not provided.

Item ADT Number - No

Not given for products tracked

individually.

Specifies how many were taken from

the same lot/series/batch for products

tracked by lot.

Used when an amount of individual

products less than what was given is

taken.

The item amount information in the

default value Delivery Notification.

3.1.6.6 Retrieve from undesignated place on ÜTS Notification with Unique Device Identifier Sample

Request

{

"UDI" : "0151022222233336111603021719030210A213B1211234",

"ADT" : 5

}

3.1.7 Usage Notification

When a health organization/application center uses an individual product on a patient/consumer they make a

Usage Notification.

3.1.7.1 Usage Notification Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/kullanim/ekle

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/kullanim/ekle

3.1.7.2 Usage Notification Data Fields

Table 11.Usage Notification Data Fields

Page 38: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

38 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Product Number UNO Text 23 Yes The product's product number/barcode

number.

Lot/Batch

Number LNO Text 20

Condition

al

Required to submit for products tracked

by lot.

Serial/Order

Number SNO Text 20

Condition

al

Required to submit for products tracked

individually.

Item ADT Number - Condition

al

Not given for products tracked

individually.

Specifies how many were used from the

same lot/series/batch for products

tracked by lot.

Required to submit for products tracked

by lot.

Patient Name HAA Text 50 Condition

al

Given if the identification number is

necessary when using. (If there is a

tracking configuration)

Patient Last

Name HAS Text 50

Condition

al

Given if the identification number is

necessary when using. (If there is a

tracking configuration)

T.R.

Identification No TKN Number -

Condition

al

Given if identification number is needed

when using and it is used on a Republic

of Turkey citizen. (If there is a tracking

configuration)

Foreign

Identification No YKN Number -

Condition

al

Given if identification number is needed

when using and it is used on a patient

with a foreign identification number. (If

there is a tracking configuration)

Page 39: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

39 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Passport No PAN Text 20 Condition

al

Given if identification number is needed

when using and it is used on a patient

without a foreign identification number.

(If there is a tracking configuration)

Use Date GIT Date 10 Yes In YYYY-MM-DD format. Y: Year, M:

Month and D: Means day.

3.1.7.3 Import Notification Sample Request

{

"UNO" : "1111111110010",

"SNO" : "KYY012345678999",

"GIT" : "2017-11-22",

"TKN" : "11223344678",

"TUA" : "Ali",

"TUS" : "Yılmaz"

}

3.1.7.4 Usage Notification with Unique Device Identifier Information Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/kullanim/ekle/essizKimlik

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/kullanim/ekle/essizKimlik

3.1.7.5 Usage Notification with Unique Device Identifier Information Data Fields

Table 12. Usage Notification with Unique Device Identifier Information Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Unique Device

Identifier UDI Text - Required

Must be provided when you want to

make a notification with Unique Device

Identifier.

Page 40: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

40 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Item ADT Number - Condition

al

Not given for products tracked

individually.

Specifies how many were used from the

same lot/series/batch for products

tracked by lot.

Required to submit for products tracked

by lot.

Patient Name HAA Text 50 Condition

al

Given if the identification number is

necessary when using. (If there is a

tracking configuration)

Patient Last

Name HAS Text 50

Condition

al

Given if the identification number is

necessary when using. (If there is a

tracking configuration)

T.R.

Identification No TKN Number -

Condition

al

Given if identification number is needed

when using and it is used on a Republic

of Turkey citizen. (If there is a tracking

configuration)

Foreign

Identification No YKN Number -

Condition

al

Given if identification number is needed

when using and it is used on a patient

with a foreign identification number. (If

there is a tracking configuration)

Passport No PAN Text 20 Condition

al

Given if identification number is needed

when using and it is used on a patient

without a foreign identification number.

(If there is a tracking configuration)

Use Date GIT Date 10 Yes In YYYY-MM-DD format. Y: Year, M:

Month and D: Means day.

Page 41: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

41 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

3.1.7.6 Usage Notification with Unique Device Identifier Information Sample Request

{

"UDI" : "0151022222233336111603021719030210A213B1211234",

"GIT" : "2017-11-22",

"TKN" : "11223344678",

"TUA" : "Ali",

"TUS" : "Yılmaz"

}

3.1.8 Delivery to Consumer Notification

The place of sale will make a Delivery to Consumer notification for individual products they have given to a

consumer. Delivery to Consumer Notifications are made for sales, donations, returns, etc.

NOTE: No Delivery to Consumer Notification (or cancel notification) will be submitted to ÜTS for optical products

given to the consumer by prescription and in the scope of SGK reimbursement. These will be notified to

MEDULA as is done presently.

3.1.8.1 Delivery to Consumer Notification Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/tuketiciyeVerme/ekle

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/tuketiciyeVerme/ekle

3.1.8.2 Delivery to Consumer Notification Data Fields

Table 13.Delivery to Consumer Notification Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Product Number UNO Text 23 Yes The product's product number/barcode

number.

Lot/Batch

Number LNO Text 20

Condition

al

Required to submit for products tracked

by lot.

Serial/Order

Number SNO Text 20

Condition

al

Required to submit for products tracked

individually.

Page 42: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

42 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Item ADT Number - Condition

al

Not given for products tracked

individually.

Specifies how many were produced

from the same lot/series/batch for

products tracked by lot.

Required to submit for products tracked

by lot.

Free Sample BEN Single Option

List 5 No

Specifies whether the given individual

products were free samples or not.

They may take on the values below.

The default value is NO.

YES: Yes

NO: No

Consumer

Name TUA Text 50

Condition

al

Given if the identification number is

necessary when selling. (If there is a

tracking configuration)

Consumer Last

Name TUS Text 50

Condition

al

Given if the identification number is

necessary when selling. (If there is a

tracking configuration)

T.R.

Identification No TKN Number -

Condition

al

Given if identification number is needed

when selling and is a Republic of

Turkey citizen. (If there is a tracking

configuration)

Foreign

Identification No YKN Number -

Condition

al

Given if identification number is needed

when selling and is a foreign

identification number holder. (If there is

a tracking configuration)

Page 43: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

43 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Passport No PAN Text 20 Condition

al

Given if identification number is needed

when selling and is not a foreign

identification number holder. (If there is

a tracking configuration)

Delivery to

Consumer Date GIT Date 10 Yes

In YYYY-MM-DD format. Y: Year, M:

Month and D: Means day.

3.1.8.3 Delivery to Consumer Notification Sample Request

{

"UNO" : "1111111110324",

"LNO" : "250515186001",

"ADT" : 25,

"GIT" : "2017-11-20",

"BEN" : "NO",

"TKN" : "11223344678",

"TUA" : "Ali",

"TUS" : "Yılmaz"

}

3.1.8.4 Delivery to Consumer Notification with Unique Device Identifier Information Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/tuketiciyeVerme/ekle/essizKimlik

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/tuketiciyeVerme/ekle/essizKimlik

3.1.8.5 Delivery to Consumer Notification with Unique Device Identifier Information Data Fields

Table 14. Delivery to Consumer Notification with Unique Device Identifier Information Data Fields

Page 44: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

44 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Unique Device

Identifier UDI Text - Required

Must be provided when you want to

make a notification with Unique Device

Identifier.

Item ADT Number - Condition

al

Not given for products tracked

individually.

Specifies how many were produced

from the same lot/series/batch for

products tracked by lot.

Required to submit for products tracked

by lot.

Free Sample BEN Single Option

List 5 No

Specifies whether the given individual

products were free samples or not.

They may take on the values below.

The default value is NO.

YES: Yes

NO: No

Consumer

Name TUA Text 50

Condition

al

Given if the identification number is

necessary when selling. (If there is a

tracking configuration)

Consumer Last

Name TUS Text 50

Condition

al

Given if the identification number is

necessary when selling. (If there is a

tracking configuration)

T.R.

Identification No TKN Number -

Condition

al

Given if identification number is needed

when selling and there is a T.R.

Identification Number. (If there is a

tracking configuration)

Page 45: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

45 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Foreign

Identification No YKN Number -

Condition

al

Given if identification number is needed

when selling and there is a Foreign

Identification No. (If there is a tracking

configuration)

Delivery to

Consumer Date GIT Date 10 Yes

In YYYY-MM-DD format. Y: Year, M:

Month and D: Means day.

3.1.8.6 Delivery to Consumer Notification with Unique Device Identifier Information Sample Request

{

"UDI" : "0151022222233336111603021719030210A213B1211234",

"ADT" : 25,

"GIT" : "2017-11-20",

"BEN" : "NO",

"TKN" : "11223344678",

"TUA" : "Ali",

"TUS" : "Yılmaz"

}

3.1.9 Retrieve from Consumer Notification

If the organization/company takes back an individual product that they had given to a consumer they make a

Retrieve from Consumer Notification.

NOTE: No Retrieve from Consumer Notification (or cancel notification) will be submitted to ÜTS for optical

products given to the consumer by prescription and in the scope of SGK reimbursement. These will be notified to

MEDULA as is done presently.

3.1.9.1 Retrieve from Consumer Notification Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/tuketicidenIadeAlma/ekle

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/tuketicidenIadeAlma/ekle

3.1.9.2 Retrieve from Consumer Notification Data Fields

Table 15 .Retrieve from Consumer Notification Data Fields

Page 46: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

46 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Delivery to

Consumer

Notification ID

TID Number - Condition

al

Expresses which Delivery to Consumer

notification the product is being taken

back against.

Item ADT Number - Condition

al

Not given for products tracked

individually.

Specifies how many were taken back

from the same lot/series/batch for

products tracked by lot.

Required to submit for products tracked

by lot.

Number of

Organization

that Gave

Product to

Consumer

VKN Number - Condition

al

Not required if the organization that

gave the product to the consumer is

taking back from the consumer but

require if the return is from a different

organization.

Unique Device

Identifier UDI Text -

Condition

al

This must be provided to make a

receive notification with a Unique

Device Identifier when a notification

code is not provided.

Product Number UNO Text 23 Condition

al

The product's product number/barcode

number.

When you want to make a return with

individual product information and the

notification code or unique device

identifier is not provided, the product

number must be provided.

Page 47: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

47 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Lot/Batch

Number LNO Text 20

Condition

al

If a notification code or unique device

identifier is not provided the product

number must be provided when you

want to receivea return with the

individual product information.

Required to submit for products tracked

by lot.

Serial/Order

Number SNO Text 20

Condition

al

If a notification code or unique device

identifier is not provided the product

number must be provided when you

want to receive a return with the

individual product information.

Required to submit for products tracked

individually.

3.1.9.3 Retrieve from Consumer Notification Sample Request

Sample1 Retrieve from Consumer notification with Delivery to Consumer notification ID request:

{

"TID" : "5d59e861-0ecc-11e7-a708-f52ed20ddd29",

"ADT" : 15

}

Sample 2 Retrieve notification request made with lot/batch no and series/order no request:

{

"UNO" : "1111111110324",

"LNO" : "250515186001",

"ADT" : 5

}

Sample 3 request to make Retrieve notification from a different organization:

Page 48: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

48 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

{

"UNO" : "1111111110324",

"LNO" : "250515186001",

"ADT" : 5,

"VKN" : 7

}

3.1.9.4 Retrieve from Consumer Notification with Unique Device Identifier Information Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/tuketicidenIadeAlma/ekle/essizKimlik

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/tuketicidenIadeAlma/ekle/essizKimlik

3.1.9.5 Retrieve from Consumer Notification with Unique Device Identifier Information Data Fields

Table 16. Retrieve from Consumer Notification with Unique Device Identifier Information Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Unique Device

Identifier UDI Text - Required

This must be provided to make a

receive notification with a Unique

Device Identifier when a notification

code is not provided.

Number of

Organization

that Gave

Product to

Consumer

VKN Number - Condition

al

Not required if the organization that

gave the product to the consumer is

taking back from the consumer but

require if the return is from a different

organization.

Item ADT Number - No

Not given for products tracked

individually.

Specifies how many were taken from

the same lot/series/batch for products

tracked by lot.

Used when an amount of individual

products less than what was given is

taken.

The item amount information in the

default value Delivery Notification.

Page 49: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

49 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

3.1.9.6 Retrieve from Consumer Notification with Unique Device Identifier Information Sample Request

{

"UDI" : "0151022222233336111603021719030210A213B1211234",

"ADT" : 5

}

Request to make Retrieve from Consumer notification with unique device identifier from a different organization:

{

"UDI" : "0151022222233336111603021719030210A213B1211234",

"ADT" : 5,

“VKN” : 7

}

3.1.10 Delivery for Temporary Usage Notification

An organization/company makes a Delivery for Temporary Usage Notification for individual product that they have

given to a person for temporary use.

3.1.10.1 Delivery for Temporary Usage Notification Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/geciciKullanimaVerme/ekle

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/geciciKullanimaVerme/ekle

3.1.10.2 Delivery for Temporary Usage Notification Data Fields

Table 17 . Delivery for Temporary Usage Notification Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Product Number UNO Text 23 Yes The product's product number/barcode

number.

Lot/Batch

Number LNO Text 20

Condition

al

Required to submit for products tracked

by lot.

Serial/Order

Number SNO Text 20

Condition

al

Required to submit for products tracked

individually.

Page 50: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

50 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Item ADT Number - Condition

al

Not given for products tracked

individually.

Specifies how many were produced

from the same lot/series/batch for

products tracked by lot.

Required to submit for products tracked

by lot.

Consumer

Name TUA Text 50 Yes

The name of the person to whom the

individual product has been given.

Consumer Last

Name TUS Text 50 Yes

The last name of the person to whom

the individual product has been given.

T.R.

Identification No TKN Number -

Condition

al

Required if the individual product has

been given to a Republic of Turkey

citizen.

Foreign

Identification No YKN Number -

Condition

al

Required if the individual product has

been given to a consumer with a foreign

identification number.

Passport No PAN Text 20 Condition

al

Required if the individual product has

been given to a foreign patient without a

foreign identification number.

Delivery for

Temporary Use

Date

GIT Date 10 Yes In YYYY-MM-DD format. Y: Year, M:

Month and D: Means day.

3.1.10.3 Delivery for Temporary Usage Notification Sample Request

{

"UNO" : "1111111110324",

"LNO" : "250515186001",

"ADT" : 25,

"GIT" : "2017-11-22",

Page 51: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

51 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

"TKN" : "11223344678",

"TUA" : "Ali",

"TUS" : "Yılmaz"

}

3.1.10.4 Delivery for Temporary Usage Notification with Unique Device Identifier Information Service

Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/geciciKullanimaVerme/ekle/essizKimlik

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/geciciKullanimaVerme/ekle/essizKimlik

3.1.10.5 Delivery for Temporary Usage Notification with Unique Device Identifier Information Data Fields

Table 18. Delivery for Temporary Usage Notification with Unique Device Identifier Information Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Unique Device

Identifier UDI Text - Required

Must be provided when you want to

make a notification with Unique Device

Identifier.

Item ADT Number - Condition

al

Not given for products tracked

individually.

Specifies how many were produced

from the same lot/series/batch for

products tracked by lot.

Required to submit for products tracked

by lot.

Consumer

Name TUA Text 50 Yes

The name of the person to whom the

individual product has been given.

Consumer Last

Name TUS Text 50 Yes

The last name of the person to whom

the individual product has been given.

T.R.

Identification No TKN Number -

Condition

al

Required if the individual product has

been given to a Republic of Turkey

citizen.

Page 52: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

52 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Foreign

Identification No YKN Number -

Condition

al

Required if the individual product has

been given to a consumer with a foreign

identification number.

Passport No PAN Text 20 Condition

al

Required if the individual product has

been given to a foreign patient without a

foreign identification number.

Delivery for

Temporary Use

Date

GIT Date 10 Yes In YYYY-MM-DD format. Y: Year, M:

Month and D: Means day.

3.1.10.6 Delivery for Temporary Usage Notification with Unique Device Identifier Information Sample

Request

{

"UDI" : "0151022222233336111603021719030210A213B1211234",

"ADT" : 25,

"GIT" : "2017-11-22",

"TKN" : "11223344678",

"TUA" : "Ali",

"TUS" : "Yılmaz"

}

3.1.11 Retrieve from Usage Notification

An organization/company makes a Retrieve from Usage Notification for an individual product that they have given

to a patient/consumer for temporary use.

3.1.11.1 Retrieve from Usage Notification Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/kullanimdanAlma/ekle

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/kullanimdanAlma/ekle

3.1.11.2 Retrieve from Usage Notification Data Fields

Table 19. Retrieve from Usage Notification Data Fields

Page 53: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

53 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Delivery for

Temporary

Usage

Notification ID

GKI Number - Yes

Expresses which Delivery for

Temporary Usage Notification the

remove from use process is being made

against.

Item ADT Number - Condition

al

Not given for products tracked

individually.

Specifies how many were produced

from the same lot/series/batch for

products tracked by lot.

Required to submit for products tracked

by lot.

Unique Device

Identifier UDI Text -

Condition

al

This must be provided to make a

receive notification with a Unique

Device Identifier when a notification

code is not provided.

Product Number UNO Text 23 Condition

al

The product's product number/barcode

number.

When you want to make a return with

individual product information and the

notification code or unique device

identifier is not provided, the product

number must be provided.

Lot/Batch

Number LNO Text 20

Condition

al

If a notification code or unique device

identifier is not provided the product

number must be provided when you

want to receive a return with the

individual product information.

Required to submit for products tracked

by lot.

Page 54: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

54 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Serial/Order

Number SNO Text 20

Condition

al

If a notification code or unique device

identifier is not provided the product

number must be provided when you

want to receive a return with the

individual product information.

Required to submit for products tracked

individually.

3.1.11.3 Retrieve from Usage Notification Sample Request

Sample 1 Retrieve from Usage Notification with temporary deliver to Usage Notification ID:

{

"GKI" : "5d59e861-0ecc-11e7-a708-f52ed20ddd29",

"ADT" : 15

}

Sample 2 Retrieve from Usage Notification request made with lot/batch no and series/order no:

{

"UNO" : "1111111110324",

"LNO" : "250515186001",

"ADT" : 5

}

3.1.11.4 Retrieve from Usage Notification with Unique Device Identifier Information Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/kullanimdanAlma/ekle/essizKimlik

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/kullanimdanAlma/ekle/essizKimlik

3.1.11.5 Retrieve from Usage Notification with Unique Device Identifier Information Data Fields

Table 20. Retrieve from Usage Notification with Unique Device Identifier Information Data Fields

Page 55: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

55 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Unique Device

Identifier UDI Text - Required

This must be provided to make a

receive notification with a Unique

Device Identifier when a notification

code is not provided.

Item ADT Number - No

Not given for products tracked

individually.

Specifies how many were taken from

the same lot/series/batch for products

tracked by lot.

Used when an amount of individual

products less than what was given is

taken.

The item amount information in the

default value Delivery Notification.

3.1.11.6 Retrieve from Usage Notification with Unique Device Identifier Information Sample Request

{

"UDI" : "0151022222233336111603021719030210A213B1211234",

"ADT" : 5

}

3.1.12 Reprocessing Notification

An organization/company that uses the individual product assigned on the ÜTS as raw material in its products

makes a Reprocessing notification.

3.1.12.1 Reprocessing Notification Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/yenidenIsleme/ekle

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/yenidenIsleme/ekle

3.1.12.2 Reprocessing Notification Data Fields

Table 21. Reprocessing Notification Data Fields

Page 56: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

56 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Product Number UNO Text 23 Yes The product's product number/barcode

number.

Lot/Batch

Number LNO Text 20

Condition

al

Required to submit for products tracked

by lot.

Serial/Order

Number SNO Text 20

Condition

al

Required to submit for products tracked

individually.

Item ADT Number - Condition

al

Not given for products tracked

individually.

Specifies how many were reprocessed

from the same lot/series/batch for

products tracked by lot.

Required to submit for products tracked

by lot.

3.1.12.3 Reprocessing Notification Sample Request

{

"UNO" : "2451643000007",

"LNO" : "250515186001",

"ADT" : 25

}

3.1.12.4 Reprocessing Notification with Unique Device Identifier Information Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/yenidenIsleme/ekle/essizKimlik

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/yenidenIsleme/ekle/essizKimlik

3.1.12.5 Reprocessing Notification with Unique Device Identifier Information Data Fields

Table 22. Reprocessing Notification with Unique Device Identifier Information Data Fields

Page 57: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

57 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Unique Device

Identifier UDI Text - Required

Must be provided when you want to

make a notification with Unique Device

Identifier.

Item ADT Number - Condition

al

Not given for products tracked

individually.

Specifies how many were used from the

same lot/series/batch for products

tracked by lot.

Required to submit for products tracked

by lot.

3.1.12.6 Reprocessing Notification with Unique Device Identifier Information Sample Request

{

"UDI" : "0151022222233336111603021719030210A213B1211234",

"ADT" : 25

}

3.1.13 Export Notification

An Exporter makes an Export Notification for the individual products they export.

3.1.13.1 Export Notification Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/ihracat/ekle

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/ihracat/ekle

3.1.13.2 Export Notification Data Fields

Table 23. Export Notification Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Product Number UNO Text 23 Yes The product's product number/barcode

number.

Page 58: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

58 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Lot/Batch

Number LNO Text 20

Condition

al

Required to submit for products tracked

by lot.

Serial/Order

Number SNO Text 20

Condition

al

Required to submit for products tracked

individually.

Item ADT Number - Condition

al

Not given for products tracked

individually.

Specifies how many were exported from

the same lot/series/batch for products

tracked by lot.

Required to submit for products tracked

by lot.

Free Sample BEN Single Option

List 5 No

Specifies whether the given individual

products were free samples or not.

They may take on the values below.

The default value is NO.

YES: Yes

NO: No

Customs

Declaration

Number

GBN Text 16 Yes -

3.1.13.3 Export Notification Sample Request

{

"UNO" : "2451643000007",

"LNO" : "250515186001",

"ADT" : 25,

"GBN" : "15343100IM003176",

"BEN" : "NO"

}

Page 59: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

59 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

3.1.13.4 Export Notification with Unique Device Identifier Information Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/ihracat/ekle/essizKimlik

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/ihracat/ekle/essizKimlik

3.1.13.5 Export Notification with Unique Device Identifier Information Data Fields

Table 24. Export Notification with Unique Device Identifier Information Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Unique Device

Identifier UDI Text - Required

Must be provided when you want to

make a notification with Unique Device

Identifier.

Item ADT Number - Condition

al

Not given for products tracked

individually.

Specifies how many were used from the

same lot/series/batch for products

tracked by lot.

Required to submit for products tracked

by lot.

Free Sample BEN Single Option

List 5 No

Specifies whether the given individual

products were free samples or not.

They may take on the values below.

The default value is NO.

YES: Yes

NO: No

Customs

Declaration

Number

GBN Text 16 Yes -

3.1.13.6 Export Notification with Unique Device Identifier Information Sample Request

{

"UDI" : "0151022222233336111603021719030210A213B1211234",

"ADT" : 25,

"GBN" : "15343100IM003176",

"BEN" : "NO"

Page 60: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

60 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

}

3.1.14 Return to Country of Origin Notification

An Importer makes a Return to Country of Origin Notification for the individual products they return.

3.1.14.1 Return to Country of Origin Notification Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/mahrecineIadeEtme/ekle

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/mahrecineIadeEtme/ekle

3.1.14.2 Return to Country of Origin Data Fields

Table 25. Return to Country of Origin Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Product Number UNO Text 23 Yes The product's product number/barcode

number.

Lot/Batch

Number LNO Text 20

Condition

al

Required to submit for products tracked

by lot.

Serial/Order

Number SNO Text 20

Condition

al

Required to submit for products tracked

individually.

Item ADT Number - Condition

al

Not given for products tracked

individually.

Specifies how many were returned to

origin from the same lot/series/batch for

products tracked by lot.

Required to submit for products tracked

by lot.

Customs

Declaration

Number

GBN Text 16 Yes -

3.1.14.3 Return to Country of Origin Notification Sample Request

{

"UNO" : "1111111110058",

"LNO" : "250515186001",

"ADT" : 25,

Page 61: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

61 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

"GBN" : "15343100IM003176"

}

3.1.14.4 Return to Country of Origin Notification with Unique Device Identifier Information Service

Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/mahrecineIadeEtme/ekle/essizKimlik

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/mahrecineIadeEtme/ekle/essizKimlik

3.1.14.5 Return to Country of Origin Notification with Unique Device Identifier Information Data Fields

Table 26. Return to Country of Origin Notification with Unique Device Identifier Information Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Unique Device

Identifier UDI Text - Required

Must be provided when you want to

make a notification with Unique Device

Identifier.

Item ADT Number - Condition

al

Not given for products tracked

individually.

Specifies how many were returned to

origin from the same lot/series/batch for

products tracked by lot.

Required to submit for products tracked

by lot.

Customs

Declaration

Number

GBN Text 16 Yes -

3.1.14.6 Return to Country of Origin Notification with Unique Device Identifier Information Sample

Request

{

"UDI" : "0151022222233336111603021719030210A213B1211234",

"ADT" : 25,

"GBN" : "15343100IM003176"

}

Page 62: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

62 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

3.1.15 SOU / Loss Notification

An organization/company makes a SOU / Loss notification for individual products that have completed their

economic life or are a loss.

3.1.15.1 SOU / Loss Notification Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/SOUZayiat/ekle

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/SOUZayiat/ekle

3.1.15.2 SOU / Loss Notification Data Fields

Table 27 .SOU / Loss Notification Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Product Number UNO Text 23 Yes The product's product number/barcode

number.

Lot/Batch

Number LNO Text 20

Condition

al

Required to submit for products tracked

by lot.

Serial/Order

Number SNO Text 20

Condition

al

Required to submit for products tracked

individually.

Item ADT Number - Condition

al

Not given for products tracked

individually.

Specifies how many were SOU / Loss

from the same lot/series/batch for

products tracked by lot.

Required to submit for products tracked

by lot.

Type TUR Text 20 Yes

It can take on one of the values below.

SOU: SOU

NATURAL DISASTER: Natural

Disaster

FIRE: Fire

THEFT: Theft

OTHER: Other

Page 63: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

63 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Other Type

Explanation DTA Text 50

Condition

al

This field is required if the type field is

Other.

The reason is defined with free text.

3.1.15.3 SOU / Loss Notification Sample Request

{

"UNO" : "2451643000007",

"LNO" : "250515186001",

"ADT" : 25,

"TUR" : "NATURAL DISASTER"

}

3.1.15.4 SOU / Loss Notification with Unique Device Identifier Information Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/SOUZayiat/ekle/essizKimlik

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/SOUZayiat/ekle/essizKimlik

3.1.15.5 SOU / Loss Notification with Unique Device Identifier Information Data Fields

Table 28. SOU / Loss Notification with Unique Device Identifier Information Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Unique Device

Identifier UDI Text - Required

Must be provided when you want to

make a notification with Unique Device

Identifier.

Item ADT Number - Condition

al

Not given for products tracked

individually.

Specifies how many were SOU / Loss

from the same lot/series/batch for

products tracked by lot.

Required to submit for products tracked

by lot.

Page 64: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

64 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Type TUR Text 20 Yes

It can take on one of the values below.

SOU: SOU

NATURAL DISASTER: Natural

Disaster

FIRE: Fire

THEFT: Theft

OTHER: Other

Other Type

Explanation DTA Text 50

Condition

al

This field is required if the type field is

Other.

The reason is defined with free text.

3.1.15.6 SOU / Loss Notification with Unique Device Identifier Information Sample Request

{

“UDI” : “0151022222233336111603021719030210A213B1211234”,

"ADT" : 25,

"TUR" : "NATURAL DISASTER"

}

3.1.16 Recall/Withdrawal Delivery Notification

When the organization/company gives the individual products in the scope of withdrawal to another

organization/company they make a Withdraw Notification.

3.1.16.1 Recall/Withdrawal Delivery Notification Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/geriCekmeVerme/ekle

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/geriCekmeVerme/ekle

3.1.16.2 Recall/Withdrawal Delivery Notification Data Fields

Table 29. Recall/Withdrawal Delivery Notification Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Page 65: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

65 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Product Number UNO Text 23 Yes The product's product number/barcode

number.

Lot/Batch

Number LNO Text 20

Condition

al

Required to submit for products tracked

by lot.

Serial/Order

Number SNO Text 20

Condition

al

Required to submit for products tracked

individually.

Item ADT Number - Condition

al

Not given for products tracked

individually.

Specifies how many were given from

the same lot/series/batch for products

tracked by lot.

Required to submit for products tracked

by lot.

Organization No KUN Number - Yes

The number of the

organization/company assigned on the

ÜTS that the individual product was

given to.

Document

Number BNO Text 50 Yes

The invoice and/or Dispatch note

number.

3.1.16.3 Recall/Withdrawal Delivery Notification Sample Request

{

"UNO" : "2451643000007",

"LNO" : "250515186001",

"ADT" : 25,

"KUN" : 7,

"BNO" : "123B"

}

3.1.16.4 Recall/Withdrawal Delivery Notification with Unique Device Identifier Information Service

Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/geriCekmeVerme/ekle/essizKimlik

Page 66: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

66 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/geriCekmeVerme/ekle/essizKimlik

3.1.16.5 Recall/Withdrawal Delivery Notification with Unique Device Identifier Information Data Fields

Table 30. Recall/Withdrawal Delivery Notification with Unique Device Identifier Information Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Unique Device

Identifier UDI Text - Required

Must be provided when you want to

make a notification with Unique Device

Identifier.

Item ADT Number - Condition

al

Not given for products tracked

individually.

Specifies how many were given from

the same lot/series/batch for products

tracked by lot.

Required to submit for products tracked

by lot.

Organization No KUN Number - Yes

The number of the

organization/company assigned on the

ÜTS that the individual product was

given to.

Document

Number BNO Text 50 Yes

The invoice and/or Dispatch note

number.

3.1.16.6 Recall/Withdrawal Delivery Notification with Unique Device Identifier Information Sample

Request

{

“UDI” : “0151022222233336111603021719030210A213B1211234”,

"ADT" : 25,

"KUN" : 7,

"BNO" : "123B"

}

Page 67: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

67 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

3.1.17 Recall/Withdrawal Receive Notification

The organization/company makes a Recall/Withdrawal Receive Notification to accept individual products given to

them in the scope of withdrawal.

3.1.17.1 Recall/Withdrawal Receive Notification Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/geriCekmeAlma/ekle

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/geriCekmeAlma/ekle

3.1.17.2 Recall/Withdrawal Receive Notification Data Fields

Table 31. Recall/Withdrawal Receive Notification Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Recall/Withdraw

al Receive

Notification ID

GVI Text 36 Yes Expresses which Delivery Notification

the product is being taken against.

Item ADT Number - Condition

al

Not given for products tracked

individually.

Specifies how many were taken from

the same lot/series/batch for products

tracked by lot.

Required to submit for products tracked

by lot.

Sending

Organization

Number

GKK Number - Condition

al

The number of the notifying

organization that is assigned on the

ÜTS.

If Delivery Notifications have been

made by different organizations for the

individual products that have the same

individual product information in an

organization this is necessary to specify

the Delivery Notification from which

organization you want to make a

receive notification against.

Page 68: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

68 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Unique Device

Identifier UDI Text -

Condition

al

This must be provided to make a

receive notification with a Unique

Device Identifier when a notification

code is not provided.

Product Number UNO Text 23 Condition

al

The product's product number/barcode

number.

If a notification code or unique device

identifier is not provided the product

number must be provided when you

want to receive with the individual

product information.

Lot/Batch

Number LNO Text 20

Condition

al

If a notification code or unique device

identifier is not provided the product

number must be provided when you

want to receive with the individual

product information.

Required to submit for products tracked

by lot.

Serial/Order

Number SNO Text 20

Condition

al

If a notification code or unique device

identifier is not provided the product

number must be provided when you

want to receive with the individual

product information.

Required to submit for products tracked

individually.

3.1.17.3 Recall/Withdrawal Receive Notification Sample Request

Sample 1 Recall/Withdrawal Receive Notification request made with Recall/Withdrawal Delivery Notification ID:

{

"GVI" : "5d59e861-0ecc-11e7-a708-f52ed20ddd29",

"ADT" : 15

Page 69: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

69 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

}

Sample 2 Recall/Withdrawal Receive Notification request made with lot/batch no and series/order no:

{

"UNO" : "1111111110324",

"LNO" : "250515186001",

"ADT" : 5,

“GKK” : 10

}

3.1.17.4 Recall/Withdrawal Receive Notification with Unique Device Identifier Information Service

Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/geriCekmeAlma/ekle/essizKimlik

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/geriCekmeAlma/ekle/essizKimlik

3.1.17.5 Recall/Withdrawal Receive Notification with Unique Device Identifier Information Data Fields

Table 32. Recall/Withdrawal Receive Notification with Unique Device Identifier Information Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Unique Device

Identifier UDI Text - Required

This must be provided to make a

receive notification with a Unique

Device Identifier when a notification

code is not provided.

Item ADT Number - No

Not given for products tracked

individually.

Specifies how many were taken from

the same lot/series/batch for products

tracked by lot.

Used when an amount of individual

products less than what was given is

taken.

The item amount information in the

default value Delivery Notification.

Page 70: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

70 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Sending

Organization

Number

GKK Number - No

The number of the notifying

organization that is assigned on the

ÜTS.

If Delivery Notifications have been

made by different organizations for the

unique device identified individual

products that have the same individual

product information to an organization,

this is necessary to specify the Delivery

Notification from which organization you

want to make a receive notification

against.

3.1.17.3 Recall/Withdrawal Delivery Notification with Unique Device Identifier Information Sample

Request

{

“UDI” : “0151022222233336111603021719030210A213B1211234”,

"ADT" : 5,

"GKK" : 10

}

3.1.18 Improvement / Corrective Action Notification

When an organization/company makes the necessary adjustments in individual products that are withdrawn

because of being unsuitable or against technical regulations, they shall make an Amendment notification.

3.1.18.1 Improvement / Corrective Action Notification Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/islahDuzelticiFaaliyet/ekle

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/islahDuzelticiFaaliyet/ekle

3.1.18.2 Improvement / Corrective Action Notification Data Fields

Table 33 .Improvement / Corrective Action Notification Data Fields

Page 71: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

71 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Product Number UNO Text 23 Yes The product's product number/barcode

number.

Lot/Batch

Number LNO Text 20

Condition

al

Required to submit for products tracked

by lot.

Serial/Order

Number SNO Text 20

Condition

al

Required to submit for products tracked

individually.

Item ADT Number - Condition

al

Not given for products tracked

individually.

Specifies how many were amended

from the same lot/series/batch for

products tracked by lot.

Required to submit for products tracked

by lot.

Organization

Number KUN Number -

Condition

al

Given when the producer/Importer does

the Improvement / Corrective Action on

the individual product in the

organization where they are located

without taking it over.

3.1.18.3 Improvement / Corrective Action Notification Sample Request

{

"UNO" : "2451643000007",

"LNO" : "250515186001",

"ADT" : 25,

“UDI” : “0151022222233336111603021719030210A213B1211234”

}

3.1.18.4 Improvement / Corrective Action Notification with Unique Device Identifier Information Service

Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/islahDuzelticiFaaliyet/ekle/essizKimlik

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/islahDuzelticiFaaliyet/ekle/essizKimlik

Page 72: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

72 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

3.1.18.5 Improvement / Corrective Action Notification with Unique Device Identifier Information Data

Fields

Table 34. Improvement / Corrective Action Notification with Unique Device Identifier Information Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Unique Device

Identifier UDI Text - Required

Must be provided when you want to

make a notification with Unique Device

Identifier.

Item ADT Number - Condition

al

Not given for products tracked

individually.

Specifies how many were amended

from the same lot/series/batch for

products tracked by lot.

Required to submit for products tracked

by lot.

Organization

Number KUN Number -

Condition

al

Given when the producer/Importer does

the Improvement / Corrective Action on

the individual product in the

organization where they are located

without taking it over.

3.1.18.6 Improvement / Corrective Action Notification with Unique Device Identifier Information Sample

Request

{

“UDI” : “0151022222233336111603021719030210A213B1211234”,

"ADT" : 25

}

3.1.19 Destruction / Disposal Notification

When an organization/company destroys individual products for any reason they make a Destruction / Disposal

Notification

Page 73: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

73 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

3.1.19.1 Destruction / Disposal Notification Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/imhaBertaraf/ekle

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/imhaBertaraf/ekle

3.1.19.2 Destruction / Disposal Notification Data Fields

Table 35. Destruction / Disposal Notification Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Product Number UNO Text 23 Yes The product's product number/barcode

number.

Lot/Batch

Number LNO Text 20

Condition

al

Required to submit for products tracked

by lot.

Serial/Order

Number SNO Text 20

Condition

al

Required to submit for products tracked

individually.

Item ADT Number - Condition

al

Not given for products tracked

individually.

Specifies how many were destroyed

from the same lot/series/batch for

products tracked by lot.

Required to submit for products tracked

by lot.

Page 74: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

74 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Reason GRK Single Option

List 50 Yes

It can take on one of the values below.

ORGANIZATION_DECISION:

Organization Decision

VOLUNTARY_WITHDRAWAL:

Voluntary Withdrawal

EXPIRATION_DATE_PASSED:

Expiry Date Passed

FRAUD_SMUGGLED: Fraud

Smuggled

TRANSPORT_AND_STORAGE_

CONDITIONS_COMPROMISE

D: Transport and Storage

Conditions Compromised

REMOVAL_FROM_PATIENT’

BODY: Removal From Patient’s

Body

OTHER: Other

Explanation of

Other Reason DGA Text 50

Condition

al

Required if the reason field is specified

as Other.

Destroy/Disposa

l Certificate

Number

BNO Text 50 Yes

The certificate number that must be

entered when making a

Destroy/Disposal Notification.

3.1.19.3 Destruction / Disposal Notification Sample Request

{

"UNO" : "2451643000007",

"LNO" : "250515186001",

"ADT" : 25,

"GRK" : "TRANSPORT_AND_STORAGE_CONDITIONS_COMPROMISED",

"BNO" : "123B"

}

Page 75: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

75 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

3.1.19.4 Destruction / Disposal Notification with Unique Device Identifier Information Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/imhaBertaraf/ekle/essizKimlik

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/imhaBertaraf/ekle/essizKimlik

3.1.19.5 Destruction / Disposal Notification with Unique Device Identifier Information Data Fields

Table 36. Destruction / Disposal Notification with Unique Device Identifier Information Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Unique Device

Identifier UDI Text - Required

Must be provided when you want to

make a notification with Unique Device

Identifier.

Item ADT Number - Condition

al

Not given for products tracked

individually.

Specifies how many were destroyed

from the same lot/series/batch for

products tracked by lot.

Required to submit for products tracked

by lot.

Page 76: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

76 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Reason GRK Single Option

List 50 Yes

It can take on one of the values below.

ORGANIZATION_DECISION:

Organization Decision

VOLUNTARY_WITHDRAWAL:

Voluntary Withdrawal

EXPIRATION_DATE_PASSED:

Expiry Date Passed

FRAUD_SMUGGLED: Fraud

Smuggled

TRANSPORT_AND_STORAGE_

CONDITIONS_COMPROMISE

D: Transport and Storage

Conditions Compromised

REMOVED_FROM_PATIENT

BODY: Removed From Patient

Body

OTHER: Other

Explanation of

Other Reason DGA Text 50

Condition

al

Required if the reason field is specified

as Other.

Destroy/Disposa

l Certificate

Number

BNO Text 50 Yes

The certificate number that must be

entered when making a

Destroy/Disposal Notification.

3.1.19.6 Destruction / Disposal Notification with Unique Device Identifier Information Sample Request

{

“UDI” : “0151022222233336111603021719030210A213B1211234”,

"ADT" : 25,

"GRK" : "TRANSPORT_AND_STORAGE_CONDITIONS_COMPROMISED",

"BNO" : "123B"

}

Page 77: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

77 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

3.1.20 Removal from Patient’s Body Notification

If medical devices that are being withdrawn, expired or have completed their job are being taken back from the

consumer the Recall from Patient Notification is made.

3.1.20.1 Removal from Patient’s Body Notification Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/hastaninVucudundanCikarma/ekle

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/hastaninVucudundanCikarma/ekle

3.1.20.2 Removal from Patient’s Body Notification Data Fields

Table 37. Removal from Patient’s Body Notification Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Product Number UNO Text 23 Yes The product's product number/barcode

number.

Lot/Batch

Number LNO Text 20

Condition

al

Required to submit for products tracked

by lot.

Serial/Order

Number SNO Text 20

Condition

al

Required to submit for products tracked

individually.

Patient Name HAA Text 50 Condition

al

Required for products that need an

identification number during use.

Patient Last

Name HAS Text 50

Condition

al

Required for products that need an

identification number during use.

T.R.

Identification No TKN Number -

Condition

al

Required to be given when a product

that needs an identification number

during use is used on a Republic of

Turkey citizen.

Page 78: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

78 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Foreign

Identification No YKN Number -

Condition

al

Required to be given when a product

that needs an identification number

during use is used on a patient with a

foreign identification number.

Passport No PAN Text 20 Condition

al

Required to be given when a product

that needs an identification number

during use is used on a patient without

a foreign identification number.

Reason GRK Single Option

List - Yes

It can take on one of the values below.

TISSUE_INCOMPATIBILITY

RECALL

USEFUL_LIFE_COMPLETED

REVISION

OTHER

Explanation of

Other Reason DGA Text 50

Condition

al

Required if the reason field is specified

as Other.

Remove from

Patient Body

Date

GIT Date 10 Yes In YYYY-MM-DD format. Y: Year, M:

Month and D: Means day.

3.1.20.3 Removal from Patient’s Body Notification Sample Request

{

"UNO" : "1111111110010",

"SNO" : "KYY012345678999",

"GIT" : "2017-11-22",

"TKN" : "11223344678",

"HAA" : "Ali",

"HAS" : "Yılmaz",

"GRK" : "TISSUE_INCOMPATIBILITY"

}

Page 79: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

79 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

3.1.20.4 Removal from Patient’s Body Notification with Unique Device Identifier Information Service

Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/hastaninVucudundanCikarma/ekle/essizKimlik

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/hastaninVucudundanCikarma/ekle/essizKimlik

3.1.20.5 Removal from Patient’s Body Notification with Unique Device Identifier Information Data Fields

Table 38. Removal from Patient’s Body Notification with Unique Device Identifier Information Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Unique Device

Identifier UDI Text - Required

Must be provided when you want to

make a notification with Unique Device

Identifier.

Patient Name HAA Text 50 Condition

al

Required for products that need an

identification number during use.

Patient Last

Name HAS Text 50

Condition

al

Required for products that need an

identification number during use.

T.R.

Identification No TKN Number -

Condition

al

Required to be given when a product

that needs an identification number

during use is used on a Republic of

Turkey citizen.

Foreign

Identification No YKN Number -

Condition

al

Required to be given when a product

that needs an identification number

during use is used on a patient with a

foreign identification number.

Passport No PAN Text 20 Condition

al

Required to be given when a product

that needs an identification number

during use is used on a patient without

a foreign identification number.

Page 80: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

80 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Reason GRK Single Option

List - Yes

It can take on one of the values below.

TISSUE_INCOMPATIBILITY

RECALL

USEFUL_LIFE_COMPLETED

REVISION

OTHER

Explanation of

Other Reason DGA Text 50

Condition

al

Required if the reason field is specified

as Other.

Remove from

Patient Body

Date

GIT Date 10 Yes In YYYY-MM-DD format. Y: Year, M:

Month and D: Means day.

3.1.20.6 Removal from Patient’s Body Notification with Unique Device Identifier Information Sample

Request

{

"UDI" : "3456",

"GIT" : "2017-11-22",

"TKN" : "11223344678",

"HAA" : "Ali",

"HAS" : "Yılmaz",

"GRK" : "TISSUE_INCOMPATIBILITY"

}

3.1.21 Lend Notification

When an Organization/Company provides a medical device they own to a hospital for temporary use they make a

Lend Notification. Lend Notifications can only be made for products tracked individually.

3.1.21.1 Lend Notification Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/oduncVerme/ekle

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/oduncVerme/ekle

Page 81: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

81 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

3.1.21.2 Lend Notification Data Fields

Table 39 . Lend Notification Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Product Number UNO Text 23 Yes The product's product number/barcode

number.

Lot/Batch

Number LNO Text 20

Condition

al

Required to submit for products tracked

by lot.

Serial/Order

Number SNO Text 20

Condition

al

Required to submit for products tracked

individually.

Item ADT Number - Condition

al

Not given for products tracked

individually.

Specifies how many were amended

from the same lot/series/batch for

products tracked by lot.

Required to submit for products tracked

by lot.

Organization

Number KUN Number - Yes

The number of the

organization/company assigned on the

ÜTS that the individual product was

loaned to.

Lending Date GIT Date 10 Yes In YYYY-MM-DD format. Y: Year, M:

Month and D: Means day.

3.1.21.3 Lend Notification Sample Request

{

"UNO" : "1111111110010",

"SNO" : "KYY012345678999",

"GIT" : "2017-11-22",

"KUN" : 7

}

Page 82: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

82 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

3.1.21.4 Lend Notification with Unique Device Identifier Information Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/oduncVerme/ekle/essizKimlik

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/oduncVerme/ekle/essizKimlik

3.1.21.5 Lend Notification with Unique Device Identifier Information Data Fields

Table 40. Lend Notification with Unique Device Identifier Information Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Unique Device

Identifier UDI Text - Required

Must be provided when you want to

make a notification with Unique Device

Identifier.

Item ADT Number - Condition

al

Not given for products tracked

individually.

Specifies how many were amended

from the same lot/series/batch for

products tracked by lot.

Required to submit for products tracked

by lot.

Organization

Number KUN Number - Yes

The number of the

organization/company assigned on the

ÜTS that the individual product was

loaned to.

Lending Date GIT Date 10 Yes In YYYY-MM-DD format. Y: Year, M:

Month and D: Means day.

3.1.21.6 Lend Notification with Unique Device Identifier Information Sample Request

{

“UDI” : “0151022222233336111603021719030210A213B1211234”,

"GIT" : "2017-11-22",

"KUN" : 7

}

Page 83: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

83 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

3.1.22 Borrow Notification

The organization/company makes a Borrow Notification to accept individual products loaned to them.

3.1.22.1 Borrow Notification Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/oduncAlma/ekle

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/oduncAlma/ekle

3.1.22.2 Borrow Notification Data Fields

Table 41. Borrow Notification Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Borrow

Notification ID VBI Number - Yes

Shows which lend notification the

product is being borrowed against.

Item ADT Number - No

No item number information is provided

since this notification is made only for

individually based products.

Sending

Organization

Number

GKK Number - Condition

al

The number of the notifying

organization that is assigned on the

ÜTS.

If Delivery Notifications have been

made by different organizations for the

individual products that have the same

individual product information in an

organization this is necessary to specify

the Delivery Notification from which

organization you want to make a

receive notification against.

Unique Device

Identifier UDI Text -

Condition

al

This must be provided to make a

receive notification with a Unique

Device Identifier when a notification

code is not provided.

Page 84: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

84 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Product Number UNO Text 23 Condition

al

The product's product number/barcode

number.

If a notification code or unique device

identifier is not provided the product

number must be provided when you

want to receive with the individual

product information.

Lot/Batch

Number LNO Text 20

Condition

al

If a notification code or unique device

identifier is not provided the product

number must be provided when you

want to receive with the individual

product information.

Required to submit for products tracked

by lot.

Serial/Order

Number SNO Text 20

Condition

al

If a notification code or unique device

identifier is not provided the product

number must be provided when you

want to receive with the individual

product information.

Required to submit for products tracked

individually.

3.1.22.3 Borrow Notification Sample Request

Sample 1 borrow notification request made with lend notification ID:

{

"VBI" : "5d59e861-0ecc-11e7-a708-f52ed20ddd29"

}

Sample 2 borrow notification request made with product no, lot/batch no and series/order no:

{

"UNO" : "1111111110324",

"SNO" : "KYY012345678999"

Page 85: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

85 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

}

3.1.22.4 Borrow Notification with Unique Device Identifier Information Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/oduncAlma/ekle/essizKimlik

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/oduncAlma/ekle/essizKimlik

3.1.22.5 Borrow Notification with Unique Device Identifier Information Data Fields

Table 42. Borrow Notification with Unique Device Identifier Information Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Unique Device

Identifier UDI Text - Required

This must be provided to make a

receive notification with a Unique

Device Identifier when a notification

code is not provided.

Item ADT Number - No

Not given for products tracked

individually.

Specifies how many were taken from

the same lot/series/batch for products

tracked by lot.

Used when an amount of individual

products less than what was given is

taken.

The item amount information in the

default value Delivery Notification.

Page 86: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

86 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Sending

Organization

Number

GKK Number - No

The number of the notifying

organization that is assigned on the

ÜTS.

If Delivery Notifications have been

made by different organizations for the

unique device identified individual

products that have the same individual

product information in an organization

this is necessary to specify the Delivery

Notification from which organization you

want to make a receive notification

against.

3.1.22.6 Borrow Notification with Unique Device Identifier Information Sample Request

{

“UDI” : “0151022222233336111603021719030210A213B1211234”

}

3.1.23 Borrow Return Notification

When a Hospital returns to an Organization/Company a medical device that they have borrowed from the

Organization/Company they make a Borrow Return Notification Borrow Return Notifications can only be made for

products tracked individually.

3.1.23.1 Borrow Return Notification Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/oduncGeriVerme/ekle

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/oduncGeriVerme/ekle

3.1.23.2 Borrow Return Notification Data Fields

Table 43. Borrow Return Notification Data Fields

Page 87: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

87 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Product Number UNO Text 23 Yes The product's product number/barcode

number.

Lot/Batch

Number LNO Text 20

Condition

al

Required to submit for products tracked

by lot.

Serial/Order

Number SNO Text 20

Condition

al

Required to submit for products tracked

individually.

Item ADT Number - Condition

al

Not given for products tracked

individually.

Specifies how many were amended

from the same lot/series/batch for

products tracked by lot.

Required to submit for products tracked

by lot.

3.1.23.3 Borrow Return Notification Sample Request

{

"UNO" : "1111111110010",

"SNO" : "KYY012345678999"

}

3.1.23.4 Borrow Return Notification with Unique Device Identifier Information Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/oduncGeriVerme/ekle/essizKimlik

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/oduncGeriVerme/ekle/essizKimlik

3.1.23.5 Borrow Return Notification with Unique Device Identifier Information Data Fields

Table 44. Borrow Return Notification with Unique Device Identifier Information Data Fields

Page 88: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

88 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Unique Device

Identifier UDI Text - Required

Must be provided when you want to

make a notification with Unique Device

Identifier.

Item ADT Number - Condition

al

Not given for products tracked

individually.

Specifies how many were amended

from the same lot/series/batch for

products tracked by lot.

Required to submit for products tracked

by lot.

3.1.23.6 Borrow Return Notification with Unique Device Identifier Information Sample Request

{

“UDI” : “0151022222233336111603021719030210A213B1211234”

}

3.1.24 Borrow Retrieve Notification

The organization/company makes a Borrow Retrieve Notification to accept individual products that have been lent

back to them.

3.1.24.1 Borrow Retrieve Notification Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/oduncGeriAlma/ekle

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/oduncGeriAlma/ekle

3.1.24.2 Borrow Retrieve Notification Data Fields

Table 45. Borrow Retrieve Notification Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Borrow Retrieve

Notification ID VBI Number - Yes

Shows which borrow return notification

the product is being borrowed retrieved

against.

Page 89: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

89 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Item ADT Number - No

No item number information is provided

since this notification is made only for

individually based products.

Sending

Organization

Number

GKK Number - Condition

al

The number of the notifying

organization that is assigned on the

ÜTS.

If Delivery Notifications have been

made by different organizations for the

individual products that have the same

individual product information in an

organization this is necessary to specify

the Delivery Notification from which

organization you want to make a

receive notification against.

Unique Device

Identifier UDI Text -

Condition

al

This must be provided to make a

receive notification with a Unique

Device Identifier when a notification

code is not provided.

Product Number UNO Text 23 Condition

al

The product's product number/barcode

number.

If a notification code or unique device

identifier is not provided the product

number must be provided when you

want to receive with the individual

product information.

Page 90: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

90 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Lot/Batch

Number LNO Text 20

Condition

al

If a notification code or unique device

identifier is not provided the product

number must be provided when you

want to receive with the individual

product information.

Required to submit for products tracked

by lot.

Serial/Order

Number SNO Text 20

Condition

al

If a notification code or unique device

identifier is not provided the product

number must be provided when you

want to receive with the individual

product information.

Required to submit for products tracked

individually.

3.1.24.3 Borrow Retrieve Notification Sample Request

Sample 1 borrow Retrieve notification request made with borrow return notification ID:

{

"VBI" : "5d59e861-0ecc-11e7-a708-f52ed20ddd29"

}

Sample 2 borrow Retrieve notification request made with product no, lot/batch no and series/order no:

{

"UNO" : "1111111110010",

"SNO" : "KYY012345678999"

}

3.1.24.4 Borrow Retrieve Notification with Unique Device Identifier Information Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/oduncGeriAlma/ekle/essizKimlik

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/oduncGeriAlma/ekle/essizKimlik

Page 91: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

91 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

3.1.24.5 Borrow Retrieve Notification with Unique Device Identifier Information Data Fields

Table 46. Borrow Retrieve Notification with Unique Device Identifier Information Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Unique Device

Identifier UDI Text - Required

This must be provided to make a

receive notification with a Unique

Device Identifier when a notification

code is not provided.

Item ADT Number - No

Not given for products tracked

individually.

Specifies how many were taken from

the same lot/series/batch for products

tracked by lot.

Used when an amount of individual

products less than what was given is

taken.

The item amount information in the

default value Delivery Notification.

Sending

Organization

Number

GKK Number - No

The number of the notifying

organization that is assigned on the

ÜTS.

If Delivery Notifications have been

made by different organizations for the

unique device identified individual

products that have the same individual

product information in an organization

this is necessary to specify the Delivery

Notification from which organization you

want to make a receive notification

against.

Page 92: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

92 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

3.1.24.6 Borrow Retrieve Notification with Unique Device Identifier Information Sample Request

{

“UDI” : “0151022222233336111603021719030210A213B1211234”

}

3.2 CANCELLATION NOTIFICATIONS

The organization / company makes a cancellation notification to cancel notifications they have made in error.

There are different cancellation notifications corresponding to each notification. The parameter types and return

data structures of all cancellation notifications are the same.

Note: There is no cancellation notification that corresponds to the Receive and Retrieve Withdrawal notifications.

3.2.1 Cancellation Notifications Service Addresses

Table 47. Cancellation Notifications Service Addresses

Cancellation Notification Name Service Address

Production Cancellation Notification

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/uretim/iptal

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/uretim/iptal

Import Cancellation Notification

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/ithalat/iptal

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/ithalat/iptal

Delivery Cancellation Notification

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/verme/iptal

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/verme/iptal

Delivery Notification to a Place

Undesignated on ÜTS Cancellation

Real Setting:

https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/utsdeTanimsizYereVerme/iptal

Test Setting:

https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/utsdeTanimsizYereVerme/iptal

Retrieve from undesignated place on ÜTS

Notification Cancellation

Real Setting:

https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/utsdeTanimsizYerdenIadeAlma/iptal

Test Setting:

https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/utsdeTanimsizYerdenIadeAlma/iptal

Use Cancellation Notification

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/kullanim/iptal

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/kullanim/iptal

Delivery to Consumer Notification

Cancellation

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/tuketiciyeVerme/iptal

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/tuketiciyeVerme/iptal

Receive Return from Consumer Notification

Cancellation

Real Setting:

https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/tuketicidenIadeAlma/iptal

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/tuketicidenIadeAlma/iptal

Page 93: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

93 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Cancellation Notification Name Service Address

Delivery for Temporary Usage Notification

Cancellation

Real Setting:

https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/geciciKullanimaVerme/iptal

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/geciciKullanimaVerme/iptal

Retrieve from Usage Notification

Cancellation

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/kullanimdanAlma/iptal

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/kullanimdanAlma/iptal

Reprocessing Notification Cancellation

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/yenidenIsleme/iptal

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/yenidenIsleme/iptal

Export Cancellation Notification

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/ihracat/iptal

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/ihracat/iptal

Return to Country of Origin Notification

Cancellation

Real Setting:

https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/mahrecineIadeEtme/iptal

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/mahrecineIadeEtme/iptal

SOU / Loss Notification Cancellation

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/SOUZayiat/iptal

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/SOUZayiat/iptal

Recall/Withdrawal Delivery Notification

Cancellation

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/geriCekmeVerme/iptal

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/geriCekmeVerme/iptal

Improvement / Corrective Action Notification

Cancellation

Real Setting:

https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/islahDuzelticiFaaliyet/iptal

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/islahDuzelticiFaaliyet/iptal

Destruction / Disposal Notification

Cancellation

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/imhaBertaraf/iptal

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/imhaBertaraf/iptal

Removal from Patient’s Body Notification

Cancellation

Real Setting:

https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/hastaninVucudundanCikarma/iptal

Test Setting:

https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/hastaninVucudundanCikarma/iptal

Lend Notification Cancellation

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/oduncVerme/iptal

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/oduncVerme/iptal

Borrow Return Notification Cancellation

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/oduncGeriVerme/iptal

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/oduncGeriVerme/iptal

3.2.1.1 Cancellation Notification Data Fields

Table 48. Cancellation Notification Data Fields

Page 94: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

94 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Notification ID BID Number - Yes The singular definer of the notification

being cancelled.

3.2.1.2 Cancellation Notifications Sample Request

{

"BID" : "d273e5e1-0dfc-11e7-a653-f52ed20ddd29"

}

3.3 NOTIFICATION RESPONSE

The data structure for the response given for all action notifications is common.

3.3.1 Notification Response Data Fields

Table 49. Notification Response Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

Result SNC Text 36 The ID of the notification made.

Message List MSJ List

(TIP, MET, KOD, MPA)

-

The list that is comprised of the Message Type,

Message Text, Message Code and Message

Parameters.

Message Type MSJ.

TIP Text 5

The message type. It can take on one of the values

below.

INFORMATION

WARNING

ERROR

Message Text MSJ.

MET Text 255 The text for an error message that people can read.

Page 95: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

95 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

Message Code MSJ.

CODE Number -

The message code that can be processed by

information systems.

Message

Parameters

MSJ.

MPA

Parameters

List -

While they are generally text, parameters in number

or date type can be rotated.

3.4 INQUIRING SERVICES

3.4.1 Individual Product Inquiry

Searches the individual products on organizations/companies.

3.4.1.1 Individual Product Inquiry Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/tekilUrun/sorgula

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/tekilUrun/sorgula

3.4.1.2 Individual Product Inquiry Request Data Fields

Table 50. Individual Product Inquiry Request Data Fields

Name JSON

Code

Data

Type

Maximum

Length

(Character)

Required?

Explanation

Product

Number UNO Text 23

Required The product's product number/barcode number.

Lot/Batch

Number LNO Text 36

Conditional Required to submit for products tracked by lot.

Serial/Order

Number SNO Text 36

Conditional Required to submit for products tracked by series.

3.4.1.3 Individual Product Inquiry Response Data Fields

Table 51. Individual Product Inquiry Response Data Fields

Page 96: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

96 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

Result SNC

List

(UTP, UNO, LNO, SNO, ADT, URT, SKT, ITT, UIK, UAK, SKG, KKG, UDI, MME)

- Rotated if the transaction is successful.

Product Type SNC.

UTP Text 20

It can take on one of the values below.

MEDICAL_DEVICE: Medical Device

COSMETIC_PRODUCT: Cosmetic Product

Product Number SNC.

UNO Text 23 The product's product number/barcode number.

Lot/Batch

Number

SNC.

LNO Text 20

Serial/Order

Number

SNC.

SNO Text 20

Item SNC.

ADT Number -

Production Date SNC.

URT Date 8

Expiry Date SNC.

SKT Date 10

Import Date SNC.

ITT Date 10

Producer/Import

er Company

Number

SNC.

UIK Number -

The number of the producer/importer of the

individual product

Page 97: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

97 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

Product Tree

Configuration

SNC.

UAK Text -

The tracking configuration of the individual product.

It can take on one of the values below.

INDIVIDUAL

LOT

Is the

Identification

Number

Necessary

During Sale?

SNC.

SKG Text -

It can take on one of the values below.

True

False

Is the

Identification

Number

Necessary

During Use?

SNC.

KKG Text -

It can take on one of the values below.

True

False

Unique Device

Identifier

SNC.

UDI Text -

This is the unique device identifier of the individual

product.

Brand Model

Label

SNC.

MME Text - The Brand - Model - Label name of the product.

Message List MSJ

List

(TIP, MET,

KOD, MPA)

-

Rotated if an error is received.

The list that is comprised of the Message Type,

Message Text, Message Code and Message

Parameters.

Message Type MSJ.

TIP Text 5

The message type. It can take on one of the values

below.

INFORMATION

WARNING

ERROR

Message Text MSJ.

MET Text 255 The text for an error message that people can read.

Page 98: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

98 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

Message Code MSJ.

CODE Number -

The message code that can be processed by

information systems.

Message

Parameters

MSJ.

MPA

Parameters

List -

While they are generally text, parameters in number

or date type can be rotated.

3.4.1.4 Individual Product Inquiry Sample Request

{

"UNO" : "1111111110027",

"LNO" : "250515186001",

"SAN" : 0

}

3.4.1.5 Individual Product Inquiry with Unique Device Identifier Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/tekilUrun/sorgula/essizKimlik

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/tekilUrun/sorgula/essizKimlik

3.4.1.6 Individual Product Inquiry with Unique Device Identifier Data Fields

Table 52. Individual Product Inquiry with Unique Device Identifier Data Fields

Name

JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

Unique Device

Identifier

UDI Text

Required for making an individual product inquiry

with a unique device identifier.

3.4.1.7 Individual Product Inquiry with Unique Device Identifier Sample Request

{

“UDI” : “0151022222233336111603021719030210A213B1211234”

}

Page 99: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

99 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

3.4.2 Producer/Importer Individual Product Inquiry

Searches the individual products according to organization/company ownership.

3.4.2.1 Producer/Importer Individual Product Inquiry Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/tekilUrun/uretici/sorgula

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/tekilUrun/uretici/sorgula

3.4.2.2 Producer/Importer Individual Product Inquiry Request Data Fields

If none of the request data fields in Table 37 is given as input the maximum 10 records that the organization owns

will come up as a response to the inquiry. If only the product number is given as criteria from these request data

fields; a maximum of 10 records of the individual products with the entered product number will come up as a

response. The serial number (for individually tracked numbers) or lot number (for products tracked by lot number)

must be provided in addition to the product number in order to do an inquiry according to a certain serial number

or lot number.

Table 53. Producer/Importer Individual Product Inquiry Request Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

Product Number UNO Text 23 The product's product number/barcode number.

Lot/Batch

Number LNO Text 20 Required to submit for products tracked by lot.

Serial/Order

Number SNO Text 20 Required to submit for products tracked individually.

Page Number SAN Number -

A maximum of 10 records are returned as a result of

the Inquiry. This field shows in which order the 10

results need to be returned .

3.4.2.3 Producer/Importer Individual Product Inquiry Response Data Fields

Table 54. Producer/Importer Individual Product Inquiry Response Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

Page 100: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

100 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

Result SNC

List

(UTP, UNO, LNO, SNO, ADT, URT, SKT, ITT, KUN, UIK,

KUU, MME)

- Rotated if the transaction is successful.

Product Type SNC.

UTP Text 20

It can take on one of the values below.

MEDICAL_DEVICE: Medical Device

COSMETIC_PRODUCT: Cosmetic Product

Product Number SNC.

UNO Text 23 The product's product number/barcode number.

Lot/Batch

Number

SNC.

LNO Text 20

Serial/Order

Number

SNC.

SNO Text 20

Item SNC.

ADT Number -

Production Date SNC.

URT Date 8

Expiry Date SNC.

SKT Date 10

Import Date SNC.

ITT Date 10

Organization

Number

SNC.

KUN Number -

The number of the organization that owns the

product.

Producer/Import

er Company

Number

SNC.

UIK Number -

The number of the producer/importer of the

individual product

Page 101: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

101 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

Organization

Name

SNC.

KUU Number -

The organization number of the individual product

owner assigned on the ÜTS.

Brand Model

Label

SNC.

MME Text - The Brand - Model - Label name of the product.

Message List MSJ

List

(TIP, MET,

KOD, MPA)

-

Rotated if an error is received.

The list that is comprised of the Message Type,

Message Text, Message Code and Message

Parameters.

Message Type MSJ.

TIP Text 5

The message type. It can take on one of the values

below.

INFORMATION

WARNING

ERROR

Message Text MSJ.

MET Text 255 The text for an error message that people can read.

Message Code MSJ.

CODE Number -

The message code that can be processed by

information systems.

Message

Parameters

MSJ.

MPA

Parameters

List -

While they are generally text, parameters in number

or date type can be rotated.

3.4.2.4 Producer/Importer Individual Product Inquiry Sample Request

{

"UNO" : "1111111110027",

"LNO" : "250515186001",

"SAN" : 0

}

3.4.3 Producer’s / Importer’s Query Service for an Individual Product That Went Out of the System

Searches about individual products that have exited the organization/company system and the notifications made

to these products.

Page 102: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

102 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

3.4.3.1 Producer’s / Importer’s Query Service for an Individual Product That Went Out of the System

Service Address

Real Setting:

https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/ureticiIthalatci/tekilUrun/sistemDisinaCikan/sorgula

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/ureticiIthalatci/tekilUrun/sistemDisinaCikan/sorgula

3.4.3.2 Producer’s / Importer’s Query Service for an Individual Product That Went Out of the System

Request Data Fields

Table 55. Producer’s / Importer’s Query Service for an Individual Product That Went Out of the System Request Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

Product Number UNO Text 23 The product's product number/barcode number.

Lot/Batch

Number LNO Text 20 Required to submit for products tracked by lot.

Serial/Order

Number SNO Text 20 Required to submit for products tracked individually.

Page Number SAN Number -

A maximum of 10 records are returned as a result of

the Inquiry. This field shows in which order the 10

results need to be returned .

3.4.3.3 Producer’s / Importer’s Query Service for an Individual Product That Went Out of the System

Response Data Fields

Table 56. Producer’s / Importer’s Query Service for an Individual Product That Went Out of the System Response Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

Page 103: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

103 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

Result SNC

List

(BID, UNO, LNO, SNO, ADT, GKK, KUN, BNO, BZA, BTI,

BDR, BEN, UIK, GIT,

BKU, DKU)

- Rotated if the transaction is successful.

Notification ID SNC.

BID Text 36 The notification code of the notification.

Product Number SNC.

UNO Text 23 The product's product number/barcode number.

Lot/Batch

Number

SNC.

LNO Text 20 Required to submit for products tracked by lot.

Serial/Order

Number

SNC.

SNO Text 20 Required to submit for products tracked individually.

Item SNC.

ADT Number - The individual product item amount.

Organization No SNC.

GKK Number -

The number of the organization making the

notification.

Other

Organization No

SNC.

KUN Number -

The number of the organization the individual

product has been given to.

Document No SNC.

BNO Text 50 The invoice and/or Dispatch note number.

Notification Time SNC.

BZA Date 10 The notification time.

Page 104: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

104 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

Notification Type SNC.

BTI Text -

The message type. They may take on the values

below.

DELIVERTO_CONSUMER

CANCEL_RETRIEVE_FROM_CONSUMER

USE

EXPORT

SOU_LOSS

DESTRUCTION_DISPOSAL

RETURN_TO_COUNTRY_OF_ORIGIN

REPROCESSING

DELIVER_TO_PLACE_UNDESIGNATED_O

N_UTS

CANCEL_RETRIEVE_FROM_PLACE_UNDE

SIGNATED_ON

REMOVAL_FROM_PATIENT’_ BODY

Notification

Status

SNC.

BDR Text -

It can take on one of the values below:

ACTIVE

PASSIVE

CANCELLATION

REMOVE_FROM_USAGE

GIVEN

TAKEN

TAKEN FROM CONSUMER

RETRIEVED_FROM_PLACE_UNDESIGNATED_ON_UTS

TEMPORARY_DELIVERY_RETRIEVED

Free Sample SNC.

BEN Boolean -

Specifies whether the given individual products

were free samples or not. If the value is "true" it is a

free sample, if "false" it is not a free sample.

Producer/Import

er Organization

Number

SNC.

UIK Number -

The organization number of the individual product

producer/importer assigned on the ÜTS.

Page 105: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

105 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

Real

Transaction

Date

SNC.

GIT Date 10

This date revolves in 5 notifications:

The "Date Given to Consumer" in the Delivery

to Consumer Notification of the individual

product.

The "Use Date" in the Usage Notification of

the individual product

The "Date Lent to Consumer" in the Lend to

Consumer Notification of the individual

product.

The "Temporary Use Date" of the individual

product in the Delivery for Temporary

Usage Notification

The "Remove From Patient Body Date" of the

individual product in the Removal from

Patient’s Body Notification

is how this date revolves.

Notifying

Organization

Name

SNC.

BKU Number -

The name of the organization making the

notification.

Other

Organization

Name

SNC.

DKU Number -

The name of the organization the notification is

made to.

Message List MSJ

List

(TIP, MET,

KOD, MPA)

-

Rotated if an error is received.

The list that is comprised of the Message Type,

Message Text, Message Code and Message

Parameters.

Page 106: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

106 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

Message Type MSJ.

TIP Text 5

The message type. It can take on one of the values

below.

INFORMATION

WARNING

ERROR

Message Text MSJ.

MET Text 255 The text for an error message that people can read.

Message Code MSJ.

CODE Number -

The message code that can be processed by

information systems.

Message

Parameters

MSJ.

MPA

Parameters

List -

While they are generally text, parameters in number

or date type can be rotated.

3.4.3.4 Producer’s / Importer’s Query Service for an Individual Product That Went Out of the System

Sample Request

{

"UNO" : " 1111111110010",

"LNO" : "250515186001",

"SAN" : 0

}

3.4.4 Pending Individual Product Inquiry

This Searched individual products that the organization/company has made a Delivery Notification for but not a

corresponding organization/company receive notification.

3.4.4.1 Pending Individual Product Inquiry Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/verme/askidakiler

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/verme/askidakiler

3.4.4.2 Pending Individual Product Inquiry Request Data Fields

Table 57. Pending Individual Product Inquiry Request Data Fields

Page 107: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

107 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

No of

Organization

Sent to

KUN Number - The number of the organization/company assigned

on the ÜTS that the individual product was given to.

Product Number UNO Text 23 The product's product number/barcode number.

Lot/Batch

Number LNO Text 20 Required to submit for products tracked by lot.

Serial/Order

Number SNO Text 20 Required to submit for products tracked individually.

Page Number SAN Number -

A maximum of 10 records are returned as a result of

the Inquiry. This field shows in which order the 10

results need to be returned .

If none of the request data fields in Table 39 is given as input the maximum 10 records of pending individual

products will come up as a response to the inquiry. If only the product number is given as criteria from these

request data fields; a maximum of 10 records of the pending individual products with the entered product number

will come up as a response. The serial number (for individually tracked numbers) or lot number (for products

tracked by lot number) must be provided in addition to the product number in order to do an inquiry according to a

certain serial number or lot number. If you want to Query according to the organization the individual product has

been sent to, the organization that the individual product was sent to must be provided in addition to the product

number and serial or lot number.

3.4.4.3 Pending Individual Product Inquiry Response Data Fields

Table 58. Pending Individual Product Inquiry Response Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

Page 108: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

108 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

Result SNC

List

(UNO, LNO, SNO, BRK, BNO, KUN, ADT, BID, BTI, BZA,

AKU, MME)

- Rotated if the transaction is successful.

Product Number SNC.

UNO Text 23 The product's product number/barcode number.

Lot/Batch

Number

SNC.

LNO Text 20

Serial/Order

Number

SNC.

SNO Text 20

Document

Number

SNC.

BNO Text 50 The invoice and/or Dispatch note number.

No of

Organization

Sent to

SNC.

KUN Number -

The number of the organization/company assigned

on the ÜTS that the individual product was given to.

Item SNC.

ADT Number -

Notification

Code

SNC.

BID Text 36 The notification code of the Delivery Notification.

Notification Type SNC.

BTI Text -

The message type. It can take on one of the values

below:

DELIVER

DELIVER_TEMPORARILY

RETRIEVE

Notification Time SNC.

BZA Date 19

In YYYY-MM-DD TT format. Y: Year, M: Month, D:

Day, T: Hour, M:Minute and s: Second.

Page 109: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

109 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

Field

Organization

Name

SNC.

AKU Text -

The name of the organization the individual product

has been given to.

Brand Model

Label

SNC.

MME Text - The Brand - Model - Label name of the product.

Message List MSJ

List

(TIP, MET,

KOD, MPA)

-

Rotated if an error is received.

The list that is comprised of the Message Type,

Message Text, Message Code and Message

Parameters.

Message Type MSJ.

TIP Text 5

The message type. It can take on one of the values

below.

INFORMATION

WARNING

ERROR

Message Text MSJ.

MET Text 255 The text for an error message that people can read.

Message Code MSJ.

CODE Number -

The message code that can be processed by

information systems.

Message

Parameters

MSJ.

MPA

Parameters

List -

While they are generally text, parameters in number

or date type can be rotated.

3.4.4.4 Pending Individual Product Inquiry Sample Request

{

"KUN" : 7,

"UNO" : "1111111110027",

"LNO" : "250515186001",

"SAN" : 0

}

Page 110: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

110 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

3.4.5 Query Borrowed Individual Product

Searches the individual products that the organization/company has made borrow notifications for.

3.4.5.1 Borrowed Individual Product Inquiry Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/tekilUrun/lokasyon/sorgula

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/tekilUrun/lokasyon/sorgula

3.4.5.2 Borrowed Individual Product Inquiry Request Data Fields

Table 59. Borrowed Individual Product Inquiry Request Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

Product Number UNO Text 23 The product's product number/barcode number.

Lot/Batch

Number LNO Text 20 Required to submit for products tracked by lot.

Serial/Order

Number SNO Text 20 Required to submit for products tracked individually.

Page Number SAN Number -

A maximum of 10 records are returned as a result of

the Inquiry. This field shows in which order the 10

results need to be returned .

If none of the request data fields in Table 41 is given as input the maximum 10 records of borrowed individual

products will come up as a response to the inquiry. If only the product number is given as criteria from these

request data fields; a maximum of 10 records of the individual products with the entered product number will

come up as a response. The serial number (for individually tracked numbers) or lot number (for products tracked

by lot number) must be provided in addition to the product number in order to do an inquiry according to a certain

serial number or lot number.

3.4.5.3 Borrowed Individual Product Inquiry Request Data Fields

Table 60. Borrowed Individual Product Inquiry Request Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

Page 111: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

111 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

Result SNC

List

(UTP, UNO, LNO, SNO, ADT, URT, SKT, ITT, UIK, UAK, SKG, KKG, UDI, UIK,

MME)

- Rotated if the transaction is successful.

Product Type SNC.

UTP Text 20

It can take on one of the values below.

MEDICAL_DEVICE: Medical Device

COSMETIC_PRODUCT: Cosmetic Product

Product Number SNC.

UNO Text 23 The product's product number/barcode number.

Lot/Batch

Number

SNC.

LNO Text 20

Serial/Order

Number

SNC.

SNO Text 20

Item SNC.

ADT Number -

Production Date SNC.

URT Date 8

Expiry Date SNC.

SKT Date 10

Import Date SNC.

ITT Date 10

Producer/Import

er Company

Number

SNC.

UIK Number -

The number of the producer/importer of the

individual product

Page 112: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

112 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

Product Tree

Configuration

SNC.

UAK Text -

The tracking configuration of the individual product.

It can take on one of the values below.

INDIVIDUAL

LOT

Is the

Identification

Number

Necessary

During Sale?

SNC.

SKG Text -

It can take on one of the values below.

True

False

Is the

Identification

Number

Necessary

During Use?

SNC.

KKG Text -

It can take on one of the values below.

True

False

Unique Device

Identifier

SNC.

UDI Text -

Brand Model

Label

SNC.

MME Text - The Brand - Model - Label name of the product.

Producer/Import

er Organization

Number

SNC.

UIK Number -

The organization number of the individual product

producer/importer assigned on the ÜTS.

Message List MSJ

List

(TIP, MET,

KOD, MPA)

-

Rotated if an error is received.

The list that is comprised of the Message Type,

Message Text, Message Code and Message

Parameters.

Page 113: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

113 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

Message Type MSJ.

TIP Text 5

The message type. It can take on one of the values

below.

INFORMATION

WARNING

ERROR

Message Text MSJ.

MET Text 255 The text for an error message that people can read.

Message Code MSJ.

CODE Number -

The message code that can be processed by

information systems.

Message

Parameters

MSJ.

MPA

Parameters

List -

While they are generally text, parameters in number

or date type can be rotated.

3.4.5.4 Borrowed Individual Product Inquiry Sample Request

{

"UNO" : "1111111110010",

"SNO" : "KYY012345678999",

"SAN" : 0

}

3.4.6 Query Notification

Searches the notifications made by the organization/company.

3.4.6.1 Query Notification Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/sorgula

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/sorgula

3.4.6.2 Query Notification Request Data Fields

Table 61. Query Notification Request Data Fields

Page 114: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

114 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

Product Number UNO Text 23 The product's product number/barcode number.

Lot/Batch

Number LNO Text 36 Required to submit for products tracked by lot.

Serial/Order

Number SNO Text 36 Required to submit for products tracked individually.

Page Number SAN Number -

A maximum of 10 records are returned as a result of

the Inquiry. This field shows in which order the 10

results need to be returned .

If none of the request data fields in Table 43 is given as input the maximum 10 records from the notifications

made by the organization will come up as a response to the inquiry. If only the product number is given as

criteria from these request data fields; a maximum of 10 records from the notifications with the entered product

number will come up as a response. The serial number (for individually tracked numbers) or lot number (for

products tracked by lot number) must be provided in addition to the product number in order to do an inquiry

according to a certain serial number or lot number.

3.4.6.3 Query Notification Response Data Fields

Table 62. Query Notification Response Data Fields

Name JSON

Code Data Type

Maximum

Length

(Character

)

Explanation

Result SNC

List

(BTI, UNO, LNO, SNO, ADT, BNO, BDR, BID, BZA, GKK, KUN, BEN, UIK, GIT,

BKU, DKU)

- Rotated if the transaction is successful.

Page 115: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

115 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Character

)

Explanation

Product Type SNC.

BTI Text -

It can take on one of the values below.

take

give-to-temporary-use

cancel-give-to-temporary-use

borrow

lend

cancel_lend

receive_withdraw

deliver_withdraw

cancel_retrieve_withdraw

remove-from-patient's-body

cancel-remove-from-patient's-body

SOU-loss

cancel-SOU-loss

export

cancel-export

destroy-disposal

cancel-destroy-disposal

amendment-corrective-action

cancel-amendment-corrective-action

import

cancel-import

use

cancel-use

take-from-use

cancel-take-from-use

return-to-origin

cancel-return-to-origin

take-back-from-consumer

cancel-take-back-from-consumer

give-to-consumer

cancel-give-to-consumer

Page 116: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

116 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Character

)

Explanation

Product Type SNC.

BTI Text -

production

cancel-production

give-to-place-undesignated-on-uts

cancel-give-to-place-not-assigned-on-uts

take-back-from-place-undesignated-on-uts

cancel-take-back-from-place-undesignated-

on-uts

deliver

cancel-deliver

reprocessing

cancel-reprocessing

Product Number SNC.

UNO Text 23 The product's product number/barcode number.

Lot/Batch

Number

SNC.

LNO Text 20

Serial/Order

Number

SNC.

SNO Text 20

Item SNC.

ADT Number -

Document

number

SNC.

BNO Text 50 The invoice and/or Dispatch note number.

Page 117: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

117 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Character

)

Explanation

Notification

Status BDR Text -

It can take on one of the values below:

ACTIVE

PASSIVE

CANCELLATION

REMOVED_FROM_USAGE

DELIVERED

RECEIVED

RECEIVED

FROM CONSUMER

RETRIEVED_FROM_PLACE_UNDESIGNATED_ON_UTS

TEMPORARY_DELIVERY_RETRIEVED

Notification

Code

SNC.

BID Text 36 The notification code of the notification.

Notification Time SNC.

BZA Date 19

In YYYY-MM-DD TT format. Y: Year, M: Month, D:

Day, T: Hour, M:Minute and s: Second.

Notifying

Organization No

SNC.

GKK Number -

The number of the notifying organization that is

assigned on the ÜTS.

Other

Organization No

SNC.

KUN Number -

The other number of the notifying organization that

is assigned on the ÜTS.

Free Sample SNC.

BEN Boolean -

Specifies whether the given individual products were

free samples or not. If the value is "true" it is a free

sample, if "false" it is not a free sample.

Producer/Import

er Organization

Number

SNC.

UIK Number -

The organization number of the individual product

producer/importer assigned on the ÜTS.

Page 118: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

118 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Character

)

Explanation

Real

Transaction

Date

SNC.

GIT Date 10

This date revolves in 5 notifications:

The "Date Given to Consumer" in the Delivery

to Consumer Notification of the individual

product.

The "Use Date" in the Usage Notification of

the individual product

The "Date Lent to Consumer" in the Lend to

Consumer Notification of the individual

product.

The "Temporary Use Date" of the individual

product in the Delivery for Temporary Usage

Notification

The "Remove From Patient Body Date" of the

individual product in the Removal from

Patient’s Body Notification

is how this date revolves.

Notifying

Organization

Name

SNC.

BKU Number -

The name of the organization making the

notification.

Other

Organization

Name

SNC.

DKU Number -

The name of the organization the notification is

made to.

Message List MSJ

List

(TIP, MET,

KOD, MPA)

-

Rotated if an error is received.

The list that is comprised of the Message Type,

Message Text, Message Code and Message

Parameters.

Page 119: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

119 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Character

)

Explanation

Message Type MSJ.

TIP Text 5

The message type. It can take on one of the values

below.

INFORMATION

WARNING

ERROR

Message Text MSJ.

MET Text 255 The text for an error message that people can read.

Message Code MSJ.

CODE Number -

The message code that can be processed by

information systems.

Message

Parameters

MSJ.

MPA

Parameters

List -

While they are generally text, parameters in number

or date type can be rotated.

3.4.6.4 Query Notification Sample Request

{

"UNO" : "1111111110010",

"SNO" : "KYY012345678999",

"SAN" : 0

}

3.4.7 Query Individual Product to be Accepted

The organization/company Searches the Delivery Notifications made to them.

3.4.7.1 Query Individual Product to be Accepted Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/alma/bekleyenler/sorgula

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/alma/bekleyenler/sorgula

3.4.7.2 Query Individual Product to be Accepted Request Data Fields

Table 63. Query Individual Product to be Accepted Request Data Fields

Page 120: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

120 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

Sending

Organization

Number

GKK Number - The number of the organization making the Delivery

Notification that is assigned on the ÜTS.

Page Number SAN Number -

A maximum of 10 records are returned as a result of

the Inquiry. This field shows in which order the 10

results need to be returned .

3.4.7.3 Query Individual Product to be Accepted Response Data Fields

Table 64. Query Individual Product to be Accepted Response Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

Result SNC

List

(GKK, UNO, LNO, SNO, ADT, BID, BNO, BZA, BTI, UIK,

GNU, MME)

- Rotated if the transaction is successful.

Sending

Organization

Number

SNC.

GKK Number -

The number of the organization making the Delivery

Notification that is assigned on the ÜTS.

Product Number SNC.

UNO Text 23 The product's product number/barcode number.

Lot/Batch

Number

SNC.

LNO Text 20

Serial/Order

Number

SNC.

SNO Text 20

Page 121: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

121 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

Item SNC.

ADT Number -

Notification

Code

SNC.

BID Text 36 The notification code of the notification.

Document

Number

SNC.

BNO Text 50 The invoice and/or Dispatch note number.

Notification Time SNC.

BZA Date 19

In YYYY-MM-DD TT format. Y: Year, M: Month, D:

Day, T: Hour, M:Minute and s: Second.

Notification Type SNC.

BTI Text

The message type. They may take on the values

below.

GIVE

Producer/Import

er Company

Number

SNC.

UIK Number -

The number of the producer/importer of the

individual product on the ÜTS.

Sender

Organization

Name

SNC.

GKU Number -

The name of the organization making the Delivery

Notification.

Brand Model

Label

SNC.

MME Text - The Brand - Model - Label name of the product.

Message List MSJ

List

(TIP, MET,

KOD, MPA)

-

Rotated if an error is received.

The list that is comprised of the Message Type,

Message Text, Message Code and Message

Parameters.

Message Type MSJ.

TIP Text 5

The message type. It can take on one of the values

below.

INFORMATION

WARNING

ERROR

Page 122: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

122 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

Message Text MSJ.

MET Text 255 The text for an error message that people can read.

Message Code MSJ.

CODE Number -

The message code that can be processed by

information systems.

Message

Parameters

MSJ.

MPA

Parameters

List -

While they are generally text, parameters in number

or date type can be rotated.

3.4.7.4 Individual Product to be Accepted Inquiry Sample Request

{

"GKK" : 7,

"SAN" : 0

}

3.4.8 Query Individual Product to be Borrowed

The organization/company Searches the deliver for borrowing notifications made to them.

3.4.8.1 Individual Product to be Borrowed Inquiry Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/oduncAlma/bekleyenler/sorgula

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/oduncAlma/bekleyenler/sorgula

3.4.8.2 Individual Product to be Borrowed Inquiry Request Data Fields

Table 65. Individual Product to be Borrowed Inquiry Request Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

Sending

Organization

Number

GKK Number - The number of the organization making the lend

notification, that is assigned on the ÜTS.

Page 123: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

123 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

Page Number SAN Number -

A maximum of 10 records are returned as a result of

the Inquiry. This field shows in which order the 10

results need to be returned .

3.4.8.3 Individual Product to be Borrowed Inquiry Request Data Fields

Table 66. Individual Product to be Borrowed Inquiry Request Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

Result SNC

List

(GKK, UNO, LNO, SNO, ADT, BID, BNO, BZA, BTI, UIK,

GKU, MME, GIT)

- Rotated if the transaction is successful.

Sending

Organization

Number

SNC.

GKK Number -

The number of the organization making the lend

notification, that is assigned on the ÜTS.

Product Number SNC.

UNO Text 23 The product's product number/barcode number.

Lot/Batch

Number

SNC.

LNO Text 20

Serial/Order

Number

SNC.

SNO Text 20

Item SNC.

ADT Number -

Page 124: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

124 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

Notification

Code

SNC.

BID Text 36 The notification code of the notification.

Document

Number

SNC.

BNO Text 50 The invoice and/or Dispatch note number.

Notification Time SNC.

BZA Date 19

In YYYY-MM-DD TT format. Y: Year, M: Month, D:

Day, T: Hour, M:Minute and s: Second.

Notification Type SNC.

BTI Text

The message type. They may take on the values

below.

LEND

Producer/Import

er Company

Number

SNC.

UIK Number -

The number of the producer/importer of the

individual product on the ÜTS.

Sender

Organization

Name

SNC.

GKU Number -

The name of the organization making the lend

notification.

Brand Model

Label

SNC.

MME Text - The Brand - Model - Label name of the product.

Page 125: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

125 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

Real

Transaction

Date

SNC.

GIT Date 10

This date revolves in 5 notifications:

The "Date Given to Consumer" in the Delivery

to Consumer Notification of the individual

product.

The "Use Date" in the Usage Notification of

the individual product

The "Date Lent to Consumer" in the Lend to

Consumer Notification of the individual

product.

The "Temporary Use Date" of the individual

product in the Delivery for Temporary

Usage Notification

The "Remove From Patient Body Date" of the

individual product in the Removal from

Patient’s Body Notification

is how this date revolves.

Message List MSJ

List

(TIP, MET,

KOD, MPA)

-

Rotated if an error is received.

The list that is comprised of the Message Type,

Message Text, Message Code and Message

Parameters.

Message Type MSJ.

TIP Text 5

The message type. It can take on one of the values

below.

INFORMATION

WARNING

ERROR

Message Text MSJ.

MET Text 255 The text for an error message that people can read.

Message Code MSJ.

CODE Number -

The message code that can be processed by

information systems.

Page 126: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

126 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

Message

Parameters

MSJ.

MPA

Parameters

List -

While they are generally text, parameters in number

or date type can be rotated.

3.4.8.4 Individual Product to be Borrowed Inquiry Sample Request

{

"GKK" : 7,

"SAN" : 0

}

3.4.9 Query Withdrawn Individual Product to be Accepted

The organization/company Searches the withdraw notifications made to them.

3.4.9.1 Query Withdrawn Individual Product to be Accepted Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/bildirim/geriCekmeAlma/bekleyenler

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/bildirim/geriCekmeAlma/bekleyenler

3.4.9.2 Query Withdrawn Individual Product to be Accepted Request Data Fields

Table 67. Query Withdrawn Individual Product to be Accepted Request Data Fields

Name JSON

Code Data Type

Maximum

Length

(Character

)

Explanation

Sending

Organization

Number

GKK Number - The number of the organization making the withdraw

notification, that is assigned on the ÜTS.

Page Number SAN Number -

A maximum of 10 records are returned as a result of

the Inquiry. This field shows in which order the 10

results need to be returned.

3.4.9.3 Query Withdrawn Individual Product to be Accepted Request Data Fields

Table 68. Query Withdrawn Individual Product to be Accepted Request Data Fields

Page 127: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

127 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Character

)

Explanation

Result SNC

List

(GKK, UNO, LNO, SNO, ADT, BID, BNO, BZA, BTI, UIK,

GKU, MME)

- Rotated if the transaction is successful.

Sending

Organization

Number

SNC.

GKK Number -

The number of the organization making the

withdraw notification, that is assigned on the ÜTS.

Product Number SNC.

UNO Text 23 The product's product number/barcode number.

Lot/Batch

Number

SNC.

LNO Text 20

Serial/Order

Number

SNC.

SNO Text 20

Item SNC.

ADT Number -

Notification

Code

SNC.

BID Text 36 The notification code of the notification.

Document

Number

SNC.

BNO Text 50 The invoice and/or Dispatch note number.

Notification Time SNC.

BZA Date 19

In YYYY-MM-DD TT format. Y: Year, M: Month, D:

Day, T: Hour, M:Minute and s: Second.

Notification Type SNC.

BTI Text

The message type. They may take on the values

below.

DELIVERY-RETRIEVE

Page 128: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

128 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Character

)

Explanation

Producer/Import

er Company

Number

SNC.

UIK Number -

The number of the producer/importer of the

individual product on the ÜTS.

Sender

Organization

Name

SNC.

GKU Number -

The name of the organization making the withdraw

notification.

Brand Model

Label

SNC.

MME Text - The Brand - Model - Label name of the product.

Message List MSJ

List

(TIP, MET,

KOD, MPA)

-

Rotated if an error is received.

The list that is comprised of the Message Type,

Message Text, Message Code and Message

Parameters.

Message Type MSJ.

TIP Text 5

The message type. It can take on one of the values

below.

INFORMATION

WARNING

ERROR

Message Text MSJ.

MET Text 255 The text for an error message that people can read.

Message Code MSJ.

CODE Number -

The message code that can be processed by

information systems.

Message

Parameters

MSJ.

MPA

Parameters

List -

While they are generally text, parameters in number

or date type can be rotated.

3.4.9.4 Query Withdrawn Individual Product to be Accepted

{

"GKK" : 7,

"SAN" : 0

}

Page 129: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

129 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

3.5 PACKET TRANSFER SYSTEM (PTS) SERVICES

3.5.1 Add Packet

The organization/company uses this service to create a packet. If the organization has assigned a packet with

the same name before the old packet is deleted and replaced with this packet.

3.5.1.1 Add Packet Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/pts/paket/ekle

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/pts/paket/ekle

3.5.1.2 Add Packet Request Data Fields

Table 69. Add Packet Request Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Required

? Explanation

Packet

Number PNO Text 255 Yes

This is the packet number of the packet

to be added.

Packet Type TIP Single

Option List 1 No

This specifies the type of the packet to

be added. They may take on the values

below.

P: Pallet

C: Cargo

S: Shrink

The Number of

the Recipient

Organization

KNO Number - Yes The number of the assigned packet

recipient that is assigned on ÜTS.

Packet List PLI

List

(PNO, TIP, KNO, PLI,

TUL)

- No The packet list included in the assigned

packet

Individual

Product List TUL

List

(UNO,

SNO, LNO,

ADT, UDI)

- No The individual product list included in the

assigned packet

Page 130: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

130 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Required

? Explanation

Product

Number

TUL.

UNO Text - No

The product number of the individual

product included in the packet

Serial/Order

Number

TUL.

SNO Text - No

The serial/order number of the individual

product included in the packet

Lot/Batch

Number

TUL.

LNO Text - No

The lot/batch number of the individual

product included in the packet

Item TUL.

ADT Number - No

The number of items of the individual

product included in the packet

Unique Device

Identifier

TUL.

UDI Text - No

The unique device identifier of the

individual product included in the packet

3.5.1.3 Add Packet Response Data Fields

Table 70. Add Packet Response Data Fields

Name JSON

Code Data Type

Maximum

Length

(Character

)

Explanation

Result SNC Text - The added packet number. Rotated if the

transaction is successful.

Message List MSJ

List

(TIP, MET,

KOD, MPA)

-

Rotated if an error is received.

The list that is comprised of the Message Type,

Message Text, Message Code and Message

Parameters.

Page 131: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

131 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Character

)

Explanation

Message Type MSJ.

TIP Text 5

The message type. It can take on one of the values

below.

INFORMATION

WARNING

ERROR

Message Text MSJ.

MET Text 255 The text for an error message that people can read.

Message Code MSJ.

CODE Number -

The message code that can be processed by

information systems.

Message

Parameters

MSJ.

MPA

Parameters

List -

While they are generally text, parameters in number

or date type can be rotated.

3.5.1.4 Add Packet Sample Request

{

"PNO":"packet1",

"KNO" : 7,

"TIP" : "P",

"TUL " : [

{

"UNO ":"productNo",

"SNO ":"serialNo1",

"LNO ":"lotNo1",

"UDI" : "890b7",

"ADT ":1

}

],

"PLI ":[

{

"PNO":"packet2",

"KNO" : 7,

"TIP" : "P",

Page 132: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

132 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

"TUL ":[

{

"UNO ":"productNo2",

"SNO ":"serialNo2",

"LNO ":"lotNo2",

"UDI" : "99",

"ADT ":100

}

]

}

]

}

3.5.2 Delete Packet

The organization deletes the product they have created.

3.5.2.1 Delete Packet Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/pts/paket/sil

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/pts/paket/sil

3.5.2.2 Delete Packet Request Data Fields

Table 71. Delete Packet Request Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Required

? Explanation

Packet

Number PNO Text 255 Yes

This is the packet number of the packet

to be deleted.

3.5.2.3 Delete Packet Response Data Fields

Table 72. Delete Packet Response Data Fields

Name JSON

Code Data Type

Maximum

Length

(Character

)

Explanation

Page 133: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

133 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Character

)

Explanation

Result SNC Text - The deleted packet number. Rotated if the

transaction is successful.

Message List MSJ

List

(TIP, MET,

KOD, MPA)

-

Rotated if an error is received.

The list that is comprised of the Message Type,

Message Text, Message Code and Message

Parameters.

Message Type MSJ.

TIP Text 5

The message type. It can take on one of the values

below.

INFORMATION

WARNING

ERROR

Message Text MSJ.

MET Text 255 The text for an error message that people can read.

Message Code MSJ.

CODE Number -

The message code that can be processed by

information systems.

Message

Parameters

MSJ.

MPA

Parameters

List -

While they are generally text, parameters in number

or date type can be rotated.

3.5.2.4 Delete Packet Sample Request

{

"PNO":"packet1"

}

3.5.3 Query Packet

Used to see the content of the system packets added by the organization.

3.5.3.1 Query Packet Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/pts/paket/getir

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/pts/paket/getir

Page 134: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

134 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

3.5.3.2 Query Packet Request Data Fields

Table 73. Query Packet Request Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Required

? Explanation

Packet

Number PNO Text 255 Yes

This is the packet number of the packet

to show the contents of.

3.5.3.3 Query Packet Response Data Fields

Table 74. Query Packet Response Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

Packet Number PNO Text 255 This is the packet number of the packet to show the

contents of.

Packet Type TIP Single Option

List 1

Specifies the type of the packet for which the

contents will be shown. They may take on the

values below.

P: Pallet

C: Cargo

S: Shrink

The Number of

the Recipient

Organization

KNO Number -

The number of the recipient organization that is

assigned on ÜTS for the packet that the content will

be shown for.

Packet List PLI

List

(PNO, TIP, KNO, PLI,

TUL)

- The packet list of the packet for which the content

will be shown

Individual

Product List TUL

List

(UNO, SNO,

LNO, ADT,

UDI)

- The individual product list of the packet for which

the content will be shown

Page 135: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

135 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

Product Number TUL.

UNO Text -

The product number of the individual product

included in the packet

Serial/Order

Number

TUL.

SNO Text -

The serial/order number of the individual product

included in the packet

Lot/Batch

Number

TUL.

LNO Text -

The lot/batch number of the individual product

included in the packet

Item TUL.

ADT Number -

The number of items of the individual product

included in the packet

Unique Device

Identifier

TUL.

UDI Text -

The unique device identifier of the individual

product included in the packet

3.5.3.4 Query Packet Sample Request

{

"PNO":"packet1"

}

3.5.4 Mark as Read the Packet that Arrived at the Organization

This service is used to mark the packet that arrives at the organization read. The packets marked read can be

filtered in the inquiry results (see 3.5.6 Query Packets Arrived at Organization).

3.5.4.1 Mark as Read the Packet that Arrived at the Organization Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/pts/gelenPaket/oku

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/pts/gelenPaket/oku

3.5.4.2 Mark as Read the Packet that Arrives at the Organization Request Data Fields

Table 75. Mark as Read the Packet that Arrives at the Organization Request Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Required

? Explanation

Page 136: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

136 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Required

? Explanation

Packet

Number PNO Text 255 Yes

This is the packet number of the packet

to be marked read.

Sending

Organization

Number

KNO Number - Yes

The number of the organization sending

the system packet that is assigned on

the ÜTS.

3.5.4.3 Mark as Read the Packet that Arrives at the Organization Response Data Fields

Table 76. Mark as Read the Packet that Arrives at the Organization Response Data Fields

Name JSON

Code Data Type

Maximum

Length

(Character

)

Explanation

Result SNC Text - This is the packet number of the packet marked

read. Rotated if the transaction is successful.

Message List MSJ

List

(TIP, MET,

KOD, MPA)

-

Rotated if an error is received.

The list that is comprised of the Message Type,

Message Text, Message Code and Message

Parameters.

Message Type MSJ.

TIP Text 5

The message type. It can take on one of the values

below.

INFORMATION

WARNING

ERROR

Message Text MSJ.

MET Text 255 The text for an error message that people can read.

Message Code MSJ.

CODE Number -

The message code that can be processed by

information systems.

Page 137: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

137 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Character

)

Explanation

Message

Parameters

MSJ.

MPA

Parameters

List -

While they are generally text, parameters in number

or date type can be rotated.

3.5.4.4 Mark as Read the Packet that Arrived at the Organization Sample Request

{

"PNO":"packet1",

"KNO" :7

}

3.5.5 Bring the Packet that Arrived at the Organization

Used to see the contents of the packet that arrived at the organization.

3.5.5.1 Bring the Packet that Arrived at the Organization Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/pts/gelenPaket/getir

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/pts/gelenPaket/getir

3.5.5.2 Bring the Packet that Arrived at the Organization Request Data Fields

Table 77. Bring the Packet that Arrived at the Organization Request Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Required

? Explanation

Packet

Number PNO Text 255 Yes

This is the packet number of the packet

to show the contents of.

Sending

Organization

Number

KNO Number - Yes

The number of the organization sending

the system packet that is assigned on

the ÜTS.

3.5.5.3 Bring the Packet that Arrived at the Organization Response Data Fields

Table 78. Bring the Packet that Arrives at the Organization Response Data Fields

Page 138: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

138 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

Packet Number PNO Text 255 This is the packet number of the packet to show the

contents of.

Packet Type TIP Single Option

List 1

Specifies the type of the packet for which the

contents will be shown. They may take on the

values below.

P: Pallet

C: Cargo

S: Shrink

The Number of

the Recipient

Organization

KNO Number -

The number of the recipient organization that is

assigned on ÜTS for the packet that the content will

be shown for.

Packet List PLI

List

(PNO, TIP, KNO, PLI,

TUL)

- The packet list of the packet for which the content

will be shown

Individual

Product List TUL

List

(UNO, SNO,

LNO, ADT,

UDI)

- The individual product list of the packet for which

the content will be shown

Product Number TUL.

UNO Text -

The product number of the individual product

included in the packet

Serial/Order

Number

TUL.

SNO Text -

The serial/order number of the individual product

included in the packet

Lot/Batch

Number

TUL.

LNO Text -

The lot/batch number of the individual product

included in the packet

Item TUL.

ADT Number -

The number of items of the individual product

included in the packet

Page 139: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

139 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

Unique Device

Identifier

TUL.

UDI Text -

The unique device identifier of the individual

product included in the packet

3.5.5.4 Query Packet that Arrived at Organization Sample Request

{

"PNO":"packet1",

"KNO" :7

}

3.5.6 Query Packets that Arrived at Organization

This service is used to Query the system packets that arrived in the organization.

3.5.6.1 Query the Packets that Arrived at the Organization Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/uh/rest/pts/gelenPaket/sorgula

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/pts/gelenPaket/sorgula

3.5.6.2 Query the Packet that Arrived at the Organization Request Data Fields

Table 79. Query the Packet that Arrived at the Organization Request Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Required

? Explanation

The Smallest

Date EKT Date 10 No

In YYYY-MM-DD format. Y: Year, M:

Month, D: Day.

The default value is 10 days before.

The Largest

Date EBT Date 10 No

In YYYY-MM-DD format. Y: Year, M:

Month, D: Day.

The day that is found inside the default

value. It can only be a maximum of 10

days from the smallest date.

Page 140: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

140 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Required

? Explanation

Read

Notification OKB

Single

Option List 5 No

Information about whether or not the

packet has been read

true: read

false: not read

The default value is false.

Organization

Number KNO Number - No

The number assigned on the ÜTS of the

organization that created the packet.

3.5.6.3 Query the Packets that Arrived at the Organization Response Data Fields

Table 80. Query the Packets that Arrived at the Organization Response Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

Result SNC

List

(PNO, KNO,

OKB, TRH)

- The packet list that comes up as a result of the

inquiry

Packet Number SNC.

PNO Text - System Packet number

Organization

Number

SNC.

KNO Number -

The number assigned on the ÜTS of the

organization that created the packet.

Read

Notification

SNC.

OKB

Single Option

List -

Information about whether or not the packet has

been read

true: read

false: not read

Page 141: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

141 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Explanation

Date Created SNC.

TRH Date - Packet creation date

Message List MSJ

List

(TIP, MET,

KOD, MPA)

-

Rotated if an error is received.

The list that is comprised of the Message

Type, Message Text, Message Code and

Message Parameters.

Message Type MSJ.

TIP Text 5

The message type. It can take on one of the values

below.

INFORMATION

WARNING

ERROR

Message Text MSJ.

MET Text 255 The text for an error message that people can read.

Message Code MSJ.

CODE Number -

The message code that can be processed by

information systems.

Message

Parameters

MSJ.

MPA

Parameters

List -

While they are generally text, parameters in number

or date type can be rotated.

3.5.6.4 Query Packets that Arrived at Organization Sample Request

{

"EKT" : "2016-10-25",

"EBT" : "2016-10-29",

"OKB" : true,

"KNO" : 7

}

3.6 QUERY COMPANY SERVICE

The service that enables company information including company assignment number with MERSIS number, tax

number, ÇKYS number and/or company name

Page 142: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

142 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

3.6.1 Query Company Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/rest/kurum/firmaSorgula

Test Setting: https://utstest.saglik.gov.tr/UTS/rest/kurum/firmaSorgula

3.6.2 Query Company Service Data Fields

Table 81. Query Company Service Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

MERSİS

Number MRS Text 16 No The MERSIS Number of the Company

Tax Number VRG Number 10-11 No The ÜTS Company Number of the

Company

Name UNV Text No The ÜTS Company Name of the

Company

ÇKYS No CKY Number No The ÇKYS Number of the Company

At least one of the MRS, VRG, and CKY parameters required.

A maximum of 20 records are listed.

3.6.3 Product Inquiry Service Sample Request

Sample service call:

Request

{

" VRG " : " 9999999999",

}

Result

[{

" KRN ": company assignment number (Long),

" GAD ": company name (String)

Page 143: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

143 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

" DRM ": company status (ACTIVE/PASSIVE),

" MRS ": company Mersis number (String)

" VRG " : company tax number (String)

}]

3.7 SEARCH PRODUCT DEFINITION SERVICE

The service that enables product information to be Searched with primary product number and producer ÜTS

company number.

3.7.1 Search Product Definition Service Address

Real Setting: https://utsuygulama.saglik.gov.tr/UTS/rest/tibbiCihaz/urunSorgula

Test Setting: https://utstest.saglik.gov.tr/UTS/uh/rest/tibbiCihaz/urunSorgula

3.7.2 Search Product Definition Service Data Fields

The service that enables product information to be Searched with primary product number and producer ÜTS

company number.

Table 82. Search Product Definition Service Data Fields

Name JSON

Code Data Type

Maximum

Length

(Characte

r)

Require

d? Explanation

Product Number UNO Text 100 Yes The primary product number of the

product being Searched

Company

Number FNO Number - Yes

The ÜTS Company Number of the

Producer Company

3.7.3 Search Product Definition Service Sample Request

Sample service call:

Request

{

"UNO" : "048327885764",

"FNO" : 2667268000001

}

Result

Page 144: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

144 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

{

"result": 1 (product found) / 0 (product not found) (Integer),

"resultsMessage": Product found. Product not found. (String),

{

"primaryProductNumber": (String),

"brandName": (String),

"versionModel": (String),

"labelName": (String),

"SubjecttoCalibration": Yes / No (String),

"calibrationPeriod": The calibration period (Integer) in months,

SubjecttoCalibration Yes / No (String),

"maintenancePeriod": The maintenance period (Integer) in months,

"trackingStatus": Individual Tracking / Lot Based Tracking / Not Tracked (String)

}

}

Page 145: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

145 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

4 ANNEXES

4.1 ANNEX-A SERVICE MESSAGES

Table 83. Service Messages

Message

Code

Message Explanation

UTS-H001 Not a usable amount.

UTS-H002 Individual Product not found.

UTS-H003 Recall/Withdrawal Delivery Notification not found.

UTS-H004 Deliver Withdrawal (Packet) Notification not found.

UTS-H005 The organization can only deletes their own notifications.

UTS-H006 The production date of individual products with the same lot number cannot be different.

UTS-H007 The Expiry Date format is not suitable.

UTS-H008 The number received cannot be more than the number sent in the Delivery Notification.

UTS-H009 This individual product is currently pending. No new notification can be made.

UTS-H010 The Notification must be Active.

UTS-H011 There isn't enough of the product in stock for the concerned transaction.

UTS-H012 The organization making the notification must be active.

UTS-H013 The product must have a unique device identifier for the concerned notification to be made.

UTS-H014 There is no product on the system according to the entered unique device identifier.

UTS-H015 Either ESBİS or MERNİS from the company type options must be entered.

UTS-H016 There is no Delivery for Temporary Usage Notification notified before for the concerned

product.

UTS-H017 This individual product has currently been given for temporary use. No new notification can

be made.

UTS-H018 No notification can be made for a Recalled Individual Product.

UTS-H019 No Import Notification can be made for Production products.

UTS-H020 No Production Notification can be made for Import products.

UTS-H021 There cannot be two packets in an organization with the same number.

Page 146: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

146 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

UTS-H022 The item number must be more than zero.

UTS-H023 MERNİS verification failed.

UTS-H024 Consumer identification number is required when selling.

UTS-H025 The entered serial number has been previously assigned.

UTS-H026 The lot number cannot be blank.

UTS-H027 A medical device used in a limited number must have a limited use number.

UTS-H028 The Expiry Date must be after the production date.

UTS-H029 The Expiry Date cannot be before today.

UTS-H030 This notification cannot be made because there is another notification on the individual

product.

UTS-H031 The product must be active.

UTS-H032 The product's documents must be valid on the production date.

UTS-H033 The number of items sent on the Delivery Notification must be more than zero.

UTS-H034 The Delivery Notification does not belong to the authorized organization. It has been made to

another organization.

UTS-H035 The Recall/Withdrawal Delivery Notification does not belong to the authorized organization. It

has been made to another organization.

UTS-H036 The individual product withdrawal must be in pending status.

UTS-H037 The Delivery Notification is not in the database.

UTS-H038 The packet notification is not in the database.

UTS-H039 The use number is not sufficient.

UTS-H040 No Usage Notification can be made for cosmetic products.

UTS-H041 Parameters missing.

UTS-H042 The organization is not active.

UTS-H043 The product is not on the database.

UTS-H044 Product not found.

UTS-H045 The product cannot be tracked.

UTS-H046 No notification can be made for a product with an expired shelf life.

Page 147: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

147 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

UTS-H047 No notification can be made for pending products.

UTS-H048 No notification can be made for a product given for temporary use.

UTS-H049 No notification can be made for an Inactive Individual Product.

UTS-H050 The Individual Product Expiry Date cannot be in the past.

UTS-H051 The individual product Expiry Date has passed.

UTS-H052 The parameters sent for the request made are incomplete.

UTS-H053 The notification you want to cancel is not on the database.

UTS-H054 The individual product is not in your organization.

UTS-H055 The cancel notification period has expired. The notification cannot be made.

UTS-H056 The notification is not on the database.

UTS-H057 The lot is being tracked the number of items field cannot be blank.

UTS-H058 If the SOU (Scrap-Old-Unusable Loss) type is Other the Explanation field must be filled out.

UTS-H059 If the reason is Other in the Removal from Patient’s Body Notification the Other Reason

Explanation field must be filled out.

UTS-H060 The production date cannot be after today.

UTS-H061 The production date can go as far back as the shelf life from the notification date.

UTS-H062 The number of items cannot be blank.

UTS-H063 The serial number cannot be blank.

UTS-H064 The lot number must be more than zero.

UTS-H065 The lot number must be entered.

UTS-H066 The consumer identification number must be entered.

UTS-H067 No Usage Notification is made for products that have unlimited use.

UTS-H068 The production date cannot be after the notification date.

UTS-H069 The production date cannot be before the shelf life.

UTS-H070 The notification amount cannot be less than zero or blank.

UTS-H071 The organization making the notification must be active.

UTS-H072 The product is not connected to the country of import.

UTS-H073 The product is not connected to the country of origin.

Page 148: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

148 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

UTS-H074 There is no Delivery to Consumer Notification notified before for the concerned product.

UTS-H075 The amount taken back from the consumer in the Delivery to Consumer notification cannot be

more than the amount given to the consumer.

UTS-H076 The amount taken back on the Retrieve from Consumer Notification must be larger than zero.

UTS-H077 More than the total individual product amount cannot be added to the packet.

UTS-H078 The individual product amount must be larger than zero.

UTS-H079 Withdrawal must be assigned to make the notification.

UTS-H080 The reason for Withdrawal cannot be "Unsafe".

UTS-H081 This individual product is currently withdraw pending. No new notification can be made.

UTS-H082 The provided organization is not on the system.

UTS-H083 The packet is not on the system.

UTS-H084 The packet is not at the giving organization.

UTS-H085 The packet is not at the organization that made the Return to Country of Origin notification.

UTS-H086 The notification type is incorrect.

UTS-H087 The amount entered for products with configuration type of individual tracking must be 1 or

blank.

UTS-H088 The packet must be active in order to make a notification.

UTS-H089 The notification code that was sent does not belong to the deliver packet notification.

UTS-H090 The provided organization does not exist on the system.

UTS-H091 The individual product must be with the consumer or in use.

UTS-H092 The individual products with the serial number {0} are in another packet. Individual products

that are tracked individually can only be in a single packet.

UTS-H093 The notification cannot be made because the product has been withdrawn.

UTS-H094 The notification cannot be made because the individual product has been withdrawn.

UTS-H095 An ordered medical device can only be given to person on the product.

UTS-H096 The company cannot withdraw an unsafe product themselves.

UTS-H097 The amounts of the sub products in the system transaction packet are insufficient.

UTS-H098 No amount has been entered for the products being tracked by lot in the system transaction

packet.

Page 149: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

149 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

UTS-H099 The individual product is not at the organization or the organization is not the producer or the

importer.

UTS-H100 The amounts of the sub products in the cosmetic product set are insufficient.

UTS-H101 No amount has been entered for the products being tracked by lot in the cosmetic product

set.

UTS-H102 A Delivery for Temporary Usage Notification cannot be made for ordered medical devices.

UTS-H103 Delivery to Undesignated Place on the ÜTS notification cannot be made for ordered medical

devices.

UTS-H104 A Reprocessing notification cannot be made for ordered medical devices.

UTS-H105 Other organization must be active.

UTS-H106 Other organization number is missing.

UTS-H107 The product/products tracked individually in the system transaction packet have been added

into another system transaction packet.

UTS-H108 The company cannot make a Delivery Notification to itself.

UTS-H109 The company cannot make a Recall/Withdrawal Delivery Notification to itself.

UTS-H110 The product/products being tracked individually in the cosmetic product set have been added

into another cosmetic product set.

UTS-H111 This company is assigned on the ÜTS. Delivery to Undesignated Place on the ÜTS

Notifications cannot be to companies that are assigned on the ÜTS. A Delivery Notification

can be made.

UTS-H112 All notifications in the packet contents have failed. The packet notification could not be added.

UTS-H113 No one other than the organization that created the packet can update the packet number.

UTS-H114 No Return to Country of Origin notification can be made for production products.

UTS-H115 A Delivery Notification for which a receive notification has been made cannot be cancelled.

UTS-H116 The country of import code is not valid.

UTS-H117 A cancel notification cannot be made against a notification for which a Retrieve from Usage

Notification has been made.

UTS-H118 A withdrawal decision could not have been made for products in the SİP.

UTS-H119 An unsafe withdrawal decision could not have been made for products in the SİP.

UTS-H120 The Expiry Date or shelf life could not be exceeded for individual products in the SİP.

Page 150: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

150 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

UTS-H121 Different lots for the same individual product cannot be added in SİP.

UTS-H122 Cannot be deleted because the packet is pending.

UTS-H123 Cannot be deleted because the packet withdrawal is pending.

UTS-H124 The individual products inside are missing according to the SİP assignment.

UTS-H125 The product must have been withdrawn in order to select the Recall option on the reason for

removing from the patient's body.

UTS-H126 This packet is currently pending. No new notification can be made.

UTS-H127 The import date must be after the production date.

UTS-H128 The import date cannot be before the shelf life.

UTS-H129 At least one of the production or import dates must be entered.

UTS-H130 The import date cannot be after the notification date.

UTS-H131 The Expiry Date must be after the production and import date.

UTS-H132 The amount taken back on the Delivery to Undesignated Place on the ÜTS cannot be more

than the amount given.

UTS-H133 There is no previous Delivery to Undesignated Place on the ÜTS for the concerned product.

UTS-H134 The individual product can only be returned to the organization a notification has been made

to.

UTS-H135 A receive notification can only be made for the pending individual products.

UTS-H136 This notification cannot be made because the individual product has been removed from the

patient's body.

UTS-H137 Only packets that are on the organization can be added to the packet.

UTS-H138 Only individual products that are on the organization can be added to the packet.

UTS-H139 There isn't enough of the product in stock for the concerned transaction. There are {0} items

of the individual product in stock.

UTS-H140 No Delivery for Temporary Usage Notification can be made for cosmetic products.

UTS-H141 No serial/order number can be given for products tracked by lot.

UTS-H144 A packet that is inside the packet cannot be placed in the packet.

UTS-H145 The packet you want to update must be on the organization.

UTS-H146 Medical Devices cannot be given to a Cosmetic company.

Page 151: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

151 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

UTS-H147 A Production date must be entered for Medical Devices.

UTS-H148 A Removal from Patient’s Body Notification cannot be made for cosmetic products.

UTS-H149 The packet can only be returned to the organization a notification has been made to.

UTS-H150 Passive organizations cannot make a lend notification.

UTS-H151 The company cannot make a Delivery Notification to itself.

UTS-H152 No lend notification can be made to a cosmetic company for Medical Devices.

UTS-H153 No lend notification can be made for cosmetic products.

UTS-H154 No lend notification can be made for medical devices tracked by lot.

UTS-H155 No notification can be made for Lend Pending products.

UTS-H156 A lend notification for which a borrow notification has been made cannot be cancelled.

UTS-H157 No borrow notification can be made for cosmetic products.

UTS-H158 No borrow notification can be made for medical devices tracked by lot.

UTS-H159 No borrow notification can be made for packets.

UTS-H160 This individual product is currently with the consumer. No new notification can be made.

UTS-H161 Ordered medical device notifications have not started yet.

UTS-H162 Cosmetic product set notifications have not started yet

UTS-H163 System transaction packet notifications have not started yet

UTS-H164 The identification information must be entered.

UTS-H165 The serial number's number of characters is incorrect.

UTS-H166 The lot number's number of characters is incorrect.

UTS-H168 The notification you want to return is not on the database.

UTS-H169 The packet number has been assigned already.

UTS-H170 No notification matching the provided Individual Product information could be found!

UTS-H171 More than one notification matching the provided Individual Product information was found!

UTS-H172 The system packet to be marked read must have arrived at the organization.

UTS-H173 Products that have been seized cannot be moved.

UTS-H174 The packet to be deleted cannot be deleted because it is in another package

UTS-H175 The entered packet number cannot be added to the same packet because it already exists

Page 152: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

152 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

UTS-H176 The packet you want to add to the packet cannot be added again because it was already

added previously.

UTS-H177 The packet cannot be added inside itself

UTS-H178 The individual products inside are missing according to the SET assignment.

UTS-H179 In taking returns from places not assigned on the ÜTS the amount taken back must more

than zero

UTS-H180 No notification can be made for return borrowed products that are pending

UTS-H181 The provided organization must be a product owner

UTS-H182 The individual product cannot be previously lent

UTS-H183 The product with unique device identifier is not on the system

UTS-H184 The packet belonging to the notification you want to cancel cannot be cancelled because it is

inside another packet

UTS-H185 The packet to be deleted cannot be deleted because there is a notification on the package

UTS-H186 An inactive packet cannot be updated

UTS-H187 A tax identification number must be entered

UTS-H188 The company is not assigned on VEDOP

UTS-H189 The individual product is not at the organization a notification has been made to. The

individual product is at the organization with number: {0} and name : {1}.

UTS-H190 Movement notifications have been frozen because a problem was detected concerning the

individual product's number of items. Please contact the administration.

UTS-H191 Products with different unique device identifiers cannot be produced / imported with the same

lot number.

UTS-H192 A packet notification could not be made because all of the individual product notifications in

the packet failed.

UTS-H193 Since the organization that made the Delivery to Consumer Notification is SGK the

organization making this notification must also be SGK.

UTS-H194 Since the organization that made the Delivery to Consumer Notification is not SGK the

organization making this notification cannot be SGK.

UTS-H195 The organization taking a return from the consumer must have the same tax number as the

organization that made the Delivery to Consumer notification.

Page 153: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

153 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

UTS-H196 Cosmetic Products cannot be given to a Medical Device company.

UTS-H197 The Delivery to Consumer date cannot be after today.

UTS-H198 The remove from patient body date cannot be after today.

UTS-H199 The use date cannot be after today.

UTS-H200 {0} date cannot be before {1}.

UTS-H201 The deliver to temporary use date cannot be after today.

UTS-H202 The lend date cannot be after today.

UTS-H203 The individual product is outside of the ÜTS.

UTS-H204 Voluntary tracking cannot be done because there is a valid configuration on the Production /

Import date.

UTS-B001 A cancel Reprocessing notification has been made.

UTS-B002 An import notification has been made.

UTS-B003 An export notification has been made.

UTS-B004 An Usage Notification has been made.

UTS-B005 A Delivery for Temporary Usage Notification has been made.

UTS-B006 A receive notification has been made.

UTS-B007 A withdraw notification has been made.

UTS-B008 A receive withdrawal (packet) notification has been made.

UTS-B009 A cancel Delivery for Temporary Usage Notification has been made.

UTS-B010 A remove from patient's body notification has been made.

UTS-B011 A cancel remove from patient's body notification has been made.

UTS-B012 packet number {0} has been added.

UTS-B013 packet number {0} has been updated.

UTS-B014 packet number {0} has been deleted.

UTS-B015 An cancel import notification has been made.

UTS-B016 A Delivery to Undesignated Place on ÜTS notification has been made.

UTS-B017 A cancel Delivery to Undesignated Place on ÜTS notification has been made.

UTS-B018 A cancel Usage Notification has been made.

Page 154: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

154 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

UTS-B019 A Retrieve from Usage Notification has been made.

UTS-B020 A cancel Retrieve from Usage Notification has been made.

UTS-B021 A cancel Delivery to Consumer notification has been made.

UTS-B022 An cancel production notification has been made.

UTS-B023 A Delivery to Consumer notification has been made.

UTS-B024 A production notification has been made.

UTS-B025 A cancel Delivery Notification has been made.

UTS-B026 A Reprocessing notification has been made.

UTS-B027 A Delivery Notification has been made.

UTS-B028 A Return to Country of Origin notification has been made.

UTS-B029 A cancel Return to Country of Origin notification has been made.

UTS-B030 A SOU (Scrap-Old-Unusable) Loss notification has been made.

UTS-B031 A cancel SOU (Scrap-Old-Unusable) Loss notification has been made.

UTS-B032 A cancel export notification has been made.

UTS-B033 A delivery withdraw notification has been made.

UTS-B034 A Retrieve from Consumer notification has been made.

UTS-B035 A Destruction / Disposal notification has been made.

UTS-B036 A cancel Destruction / Disposal notification has been made.

UTS-B037 An Improvement / Corrective Action notification has been made.

UTS-B038 A cancel Improvement / Corrective Action notification has been made.

UTS-B039 A cancel Retrieve from Consumer notification has been made.

UTS-B040 A cancel Recall/Withdrawal Delivery Notification has been made.

UTS-B041 A deliver(packet) notification has been made.

UTS-B042 A Return to Country of Origin (packet) notification has been made.

UTS-B043 A cancel delivery(packet) notification has been made.

UTS-B044 A delivery withdrawal (packet) notification has been made.

UTS-B045 A receive (packet) notification has been made.

UTS-B046 An export (packet) notification has been made.

Page 155: TRACKING AND MONITORING WEB SERVICE ... - uts… · unclassified tÜbİtak – bİlgem – yte Üts project tracking and monitoring web service definitions document document unclassified

UNCLASSIFIED

TÜBİTAK – BİLGEM – YTE

ÜTS PROJECT

TRACKING AND MONITORING WEB

SERVICE DEFINITIONS DOCUMENT

DOCUMENT

UNCLASSIFIED Rev. No: 31 Date: 13.01.2016

155 / 155 UTS-PRJ-TakipVeIzlemeWebServisTanimlariDokumani

UTS-B047 A Delivery to Undesignated Place on ÜTS (packet) notification has been made.

UTS-B048 A cancel Delivery to Undesignated Place on ÜTS (packet) notification has been made.

UTS-B049 A cancel export (packet) notification has been made.

UTS-B050 A cancel Return to Country of Origin (packet) notification has been made.

UTS-B051 A cancel delivery withdrawal (packet) notification has been made.

UTS-B052 A retrieve from place Undesignated on ÜTS notification has been made.

UTS-B053 A cancel retrieve from place Undesignated on ÜTS notification has been made.

UTS-B054 A retrieve from undesignated place on ÜTS (packet) notification has been made.

UTS-B055 A cancel retrieve from undesignated place on ÜTS (packet) notification has been made.

UTS-B056 A lend to consumer notification has been made.

UTS-B057 A cancel lend to consumer notification has been made.

UTS-B058 A borrow notification has been made.

UTS-B059 A Delivery to Consumer notification can be made.

UTS-B060 system packet no {0} has been marked as read.

UTS-B061 A borrow Retrieve notification has been made.

UTS-U001 The individual product has been withdrawn.

UTS-U002 The product has been withdrawn.

UTS-U003 Individual products that have not been withdrawn have been removed from the packet.

UTS-U004 Warning: A notification could not be made for the individual product {1} in packet no {0}

because of error {2}.

UTS-U005 Warning: A notification could not be made for the individual product {1} and notification no {2}

in packet no {0} because of error {3}.

TÜBİTAK – BİLGEM – YTE