annotate Sphinx/source/faq/orthanc-dicom-origin.rst @ 998:bd7fbe3042f7

recycling/protection
author Alain Mazy <am@osimis.io>
date Mon, 18 Dec 2023 09:47:49 +0100
parents 997b6c308e28
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
222
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
1 .. highlight:: bash
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
2 .. _orthanc-dicom-origin:
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
3
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
4 How to find out where a DICOM instance originates from?
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
5 ========================================================
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
6
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
7 Information about the origin of the instances is stored as Metadata, which can be accessed using the REST API::
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
8
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
9
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
10 $ curl http://localhost:8042/instances/19816330-cb02e1cf-df3a8fe8-bf510623-ccefe9f5/metadata
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
11 [
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
12 "IndexInSeries",
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
13 "ReceptionDate",
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
14 "RemoteAET",
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
15 "Origin",
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
16 "TransferSyntax",
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
17 "SopClassUid",
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
18 "RemoteIP",
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
19 "CalledAET"
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
20 ]
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
21
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
22
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
23 The relevant metadata about the origin of an instance is:
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
24
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
25 - ``Origin``: Whether the instance was received from the REST API, the DICOM protocol, some plugin or some Lua script.
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
26 - ``RemoteAET``: The remote AET (for DICOM).
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
27 - ``RemoteIP`` (in Orthanc ≥ 1.4.0): The IP address of the remote server (for REST API and DICOM).
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
28 - ``CalledAET`` (in Orthanc ≥ 1.4.0): The called AET (for DICOM).
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
29 - ``HttpUsername`` (in Orthanc ≥ 1.4.0): The username that created the instance (for REST API).
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
30
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
31 Please note that adding ``?expand`` to the REST endpoint will result in expanding the actual Metadata values::
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
32
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
33 $ curl http://localhost:8042/instances/cab76369-429ce4d8-6ed415e7-7a3c9482-50f3b1b4/metadata?expand
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
34 {
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
35 "CalledAET" : "ORTHANCTMP1",
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
36 "IndexInSeries" : "1",
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
37 "Origin" : "DicomProtocol",
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
38 "ReceptionDate" : "20190225T143257",
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
39 "RemoteAET" : "ORTHANC",
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
40 "RemoteIP" : "127.0.0.1",
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
41 "SopClassUid" : "1.2.840.10008.5.1.4.1.1.1",
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
42 "TransferSyntax" : "1.2.840.10008.1.2"
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
43 }
997b6c308e28 Added FAQ entry about the origin instance Metadata
Benjamin Golinvaux <bgo@osimis.io>
parents:
diff changeset
44