Implementation Guide MII Schnittstelle Pseudonymisierung
1.1.0 - ci-build

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

: pseudonymize - JSON Representation

Active as of 2025-07-14

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>target</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a> | <a href=\"http://hl7.org/fhir/R4/datatypes.html#Identifier\">Identifier</a></td><td/><td><div><p>Specification of the pseudonymisation context on the basis of which a personal pseudonym is generated or (if available) searched for the specified original identifiers. Requires a single-pseudonym-domain.</p>\n</div></td></tr><tr><td>IN</td><td>original</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Element\">Element</a></td><td/><td><div><p>Specification of the original identifier to be pseudonymised</p>\n</div></td></tr><tr><td>IN</td><td>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>Optional Parameter: true=A new pseudonym is generated for unknown original values. False=if an assignment is already known, the existing pseudonym is returned. Default value depends on implementation.</p>\n</div></td></tr><tr><td>OUT</td><td>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>Pseudonymisation context (identical with Request)</p>\n</div></td></tr><tr><td>OUT</td><td>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-identifier (identical with Request)</p>\n</div></td></tr><tr><td>OUT</td><td>pseudonym</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Element\">Element</a></td><td/><td><div><p>Personal pseudonym.</p>\n</div></td></tr></table></div>"
  },
  "url" : "https://medizininformatik-initiative.de/fhir/fhir-pseudonymization/OperationDefinition/Pseudonymize",
  "version" : "1.1.0",
  "name" : "Pseudonymize",
  "title" : "pseudonymize",
  "status" : "active",
  "kind" : "operation",
  "experimental" : false,
  "date" : "2025-07-14T09:12:24+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 single pseudonym for the given single original value. For use in single-pseudonym-domains only. 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" : [
    {
      "extension" : [
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
          "valueUri" : "string"
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
          "valueUri" : "Identifier"
        }
      ],
      "name" : "target",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "Specification of the pseudonymisation context on the basis of which a personal pseudonym is generated or (if available) searched for the specified original identifiers. Requires a single-pseudonym-domain.",
      "type" : "Element"
    },
    {
      "name" : "original",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "Specification of the original identifier to be pseudonymised",
      "type" : "Element"
    },
    {
      "name" : "allowCreate",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Optional Parameter: true=A new pseudonym is generated for unknown original values. False=if an assignment is already known, the existing pseudonym is returned. Default value depends on implementation.",
      "type" : "boolean"
    },
    {
      "name" : "target",
      "use" : "out",
      "min" : 0,
      "max" : "1",
      "documentation" : "Pseudonymisation context (identical with Request)",
      "type" : "Element"
    },
    {
      "name" : "original",
      "use" : "out",
      "min" : 0,
      "max" : "1",
      "documentation" : "Original-identifier (identical with Request)",
      "type" : "Element"
    },
    {
      "name" : "pseudonym",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "Personal pseudonym.",
      "type" : "Element"
    }
  ]
}