changeset 222:997b6c308e28

Added FAQ entry about the origin instance Metadata
author Benjamin Golinvaux <bgo@osimis.io>
date Mon, 04 Mar 2019 14:49:31 +0100
parents 26441131d725
children 9ccafca945d2
files Sphinx/source/faq.rst Sphinx/source/faq/orthanc-dicom-origin.rst
diffstat 2 files changed, 45 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/Sphinx/source/faq.rst	Mon Mar 04 12:19:01 2019 +0100
+++ b/Sphinx/source/faq.rst	Mon Mar 04 14:49:31 2019 +0100
@@ -31,6 +31,7 @@
    faq/video.rst
    faq/worklist.rst
    faq/viewers.rst
+   faq/orthanc-dicom-origin.rst
 
 
 Specific FAQs
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Sphinx/source/faq/orthanc-dicom-origin.rst	Mon Mar 04 14:49:31 2019 +0100
@@ -0,0 +1,44 @@
+.. highlight:: bash
+.. _orthanc-dicom-origin:
+
+How to find out where a DICOM instance originates from?
+========================================================
+
+Information about the origin of the instances is stored as Metadata, which can be accessed using the REST API::
+
+
+    $ curl http://localhost:8042/instances/19816330-cb02e1cf-df3a8fe8-bf510623-ccefe9f5/metadata
+    [
+    "IndexInSeries",
+    "ReceptionDate",
+    "RemoteAET",
+    "Origin",
+    "TransferSyntax",
+    "SopClassUid",
+    "RemoteIP",
+    "CalledAET"
+    ]
+
+
+The relevant metadata about the origin of an instance is:
+
+- ``Origin``: Whether the instance was received from the REST API, the DICOM protocol, some plugin or some Lua script.
+- ``RemoteAET``: The remote AET (for DICOM).
+- ``RemoteIP`` (in Orthanc ≥ 1.4.0): The IP address of the remote server (for REST API and DICOM).
+- ``CalledAET`` (in Orthanc ≥ 1.4.0): The called AET (for DICOM).
+- ``HttpUsername`` (in Orthanc ≥ 1.4.0): The username that created the instance (for REST API).
+
+Please note that adding ``?expand`` to the REST endpoint will result in expanding the actual Metadata values::
+
+    $ curl http://localhost:8042/instances/cab76369-429ce4d8-6ed415e7-7a3c9482-50f3b1b4/metadata?expand
+    {
+    "CalledAET" : "ORTHANCTMP1",
+    "IndexInSeries" : "1",
+    "Origin" : "DicomProtocol",
+    "ReceptionDate" : "20190225T143257",
+    "RemoteAET" : "ORTHANC",
+    "RemoteIP" : "127.0.0.1",
+    "SopClassUid" : "1.2.840.10008.5.1.4.1.1.1",
+    "TransferSyntax" : "1.2.840.10008.1.2"
+    }
+