Implementation Guide MII Schnittstelle Pseudonymisierung
0.9.0 - ci-build

Implementation Guide MII Schnittstelle Pseudonymisierung - Local Development build (v0.9.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

: pseudonymize - JSON Representation

Active as of 2025-01-24

Raw json | Download


{
  "resourceType" : "OperationDefinition",
  "id" : "Pseudonymize",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition Pseudonymize</b></p><a name=\"Pseudonymize\"> </a><a name=\"hcPseudonymize\"> </a><a name=\"Pseudonymize-en-US\"> </a><p>URL: [base]/$pseudonymize</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>original</td><td/><td>1..1</td><td></td><td/><td><div><p>Originalwerte</p>\n</div></td></tr><tr><td>IN</td><td>original.target</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Element\">Element</a></td><td/><td><div><p>Angabe des Pseudonymisierungs-kontextes auf Basis dessen für die angegebenen Original-Identifikatoren jeweils ein Personen-Pseudonym erzeugt oder (sofern vorhanden) gesucht wird</p>\n</div></td></tr><tr><td>IN</td><td>original.value</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Element\">Element</a></td><td/><td><div><p>Angabe des zu pseudonymisierenden Original-Identifikators</p>\n</div></td></tr><tr><td>IN</td><td>original.allowCreate</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#boolean\">boolean</a></td><td/><td><div><p>Optionaler Parameter: true=für unbekannte Original-Werte wird ein neues Pseudonym erzeugt. False=wenn bereits eine Zuordnung bekannt ist, wird das vorhandene Pseudonym zurückgegeben.</p>\n</div></td></tr><tr><td>IN</td><td>original.count</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#integer\">integer</a></td><td/><td><div><p>Anzahl der zu erzeugenden Sekundärpseudonyme. Default 1.</p>\n</div></td></tr><tr><td>OUT</td><td>pseudonym</td><td/><td>1..*</td><td></td><td/><td><div><p>In the return value, the repetition of the input values (pseudonymisation context, original identifier) is provided, but is not binding. When returning these input values, however, it is mandatory to ensure that pseudonym.target or pseudonym.orginal are identical to the original input values original.target or original.value.</p>\n</div></td></tr><tr><td>OUT</td><td>pseudonym.target</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Element\">Element</a></td><td/><td><div><p>Pseudonymisierungskontext (identical with Request)</p>\n</div></td></tr><tr><td>OUT</td><td>pseudonym.original</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Element\">Element</a></td><td/><td><div><p>Original-Identifikator (identical with Request)</p>\n</div></td></tr><tr><td>OUT</td><td>pseudonym.value</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Element\">Element</a></td><td/><td><div><p>Personen-Pseudonym.</p>\n</div></td></tr></table></div>"
  },
  "url" : "https://medizininformatik-initiative.de/fhir/fhir-pseudonymization/OperationDefinition/Pseudonymize",
  "version" : "0.9.0",
  "name" : "Pseudonymize",
  "title" : "pseudonymize",
  "status" : "active",
  "kind" : "operation",
  "experimental" : false,
  "date" : "2025-01-24T14:19:47+00:00",
  "publisher" : "Medizininformatik Initiative",
  "contact" : [
    {
      "name" : "Medizininformatik Initiative",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://www.medizininformatik-iniitative.de"
        }
      ]
    }
  ],
  "description" : "Searches or generates (if allowCreate=true) a pseudonym for the given value. Use count to specify the number of requested pseudonyms to generate for the given value. The pseudonymization algorithm to be used is left to the implementers of the operation. Errors during the execution of the operation must be returned as OperationOutcome.",
  "affectsState" : true,
  "code" : "pseudonymize",
  "system" : true,
  "type" : false,
  "instance" : false,
  "parameter" : [
    {
      "name" : "original",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "Originalwerte",
      "part" : [
        {
          "name" : "target",
          "use" : "in",
          "min" : 1,
          "max" : "1",
          "documentation" : "Angabe des Pseudonymisierungs-kontextes auf Basis dessen für die angegebenen Original-Identifikatoren jeweils ein Personen-Pseudonym erzeugt oder (sofern vorhanden) gesucht wird",
          "type" : "Element"
        },
        {
          "name" : "value",
          "use" : "in",
          "min" : 1,
          "max" : "1",
          "documentation" : "Angabe des zu pseudonymisierenden Original-Identifikators",
          "type" : "Element"
        },
        {
          "name" : "allowCreate",
          "use" : "in",
          "min" : 0,
          "max" : "1",
          "documentation" : "Optionaler Parameter: true=für unbekannte Original-Werte wird ein neues Pseudonym erzeugt. False=wenn bereits eine Zuordnung bekannt ist, wird das vorhandene Pseudonym zurückgegeben.",
          "type" : "boolean"
        },
        {
          "name" : "count",
          "use" : "in",
          "min" : 0,
          "max" : "1",
          "documentation" : "Anzahl der zu erzeugenden Sekundärpseudonyme. Default 1.",
          "type" : "integer"
        }
      ]
    },
    {
      "name" : "pseudonym",
      "use" : "out",
      "min" : 1,
      "max" : "*",
      "documentation" : "In the return value, the repetition of the input values (pseudonymisation context, original identifier) is provided, but is not binding. When returning these input values, however, it is mandatory to ensure that pseudonym.target or pseudonym.orginal are identical to the original input values original.target or original.value.",
      "part" : [
        {
          "name" : "target",
          "use" : "out",
          "min" : 0,
          "max" : "1",
          "documentation" : "Pseudonymisierungskontext (identical with Request)",
          "type" : "Element"
        },
        {
          "name" : "original",
          "use" : "out",
          "min" : 0,
          "max" : "1",
          "documentation" : "Original-Identifikator (identical with Request)",
          "type" : "Element"
        },
        {
          "name" : "value",
          "use" : "out",
          "min" : 1,
          "max" : "1",
          "documentation" : "Personen-Pseudonym.",
          "type" : "Element"
        }
      ]
    }
  ]
}