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

• Narrative Content
• XML
• JSON
• TTL

: pseudonymize - XML Representation

Active as of 2025-07-17

Raw xml | Download

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="Pseudonymize"/>
  <text>
    <status value="generated"/>
    <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>
</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>
</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>
</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>
</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>
</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>
</div></td></tr></table></div>
  </text>
  <url
       value="https://medizininformatik-initiative.de/fhir/fhir-pseudonymization/OperationDefinition/Pseudonymize"/>
  <version value="1.1.0"/>
  <name value="Pseudonymize"/>
  <title value="pseudonymize"/>
  <status value="active"/>
  <kind value="operation"/>
  <experimental value="false"/>
  <date value="2025-07-17T06:57:11+00:00"/>
  <publisher value="Medizininformatik Initiative"/>
  <contact>
    <name value="Medizininformatik Initiative"/>
    <telecom>
      <system value="url"/>
      <value value="https://www.medizininformatik-iniitative.de"/>
    </telecom>
  </contact>
  <description
               value="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 value="true"/>
  <code value="pseudonymize"/>
  <system value="true"/>
  <type value="false"/>
  <instance value="false"/>
  <parameter>
    <extension
               url="http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type">
      <valueUri value="string"/>
    </extension>
    <extension
               url="http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type">
      <valueUri value="Identifier"/>
    </extension>
    <name value="target"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="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 value="Element"/>
  </parameter>
  <parameter>
    <name value="original"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="Specification of the original identifier to be pseudonymised"/>
    <type value="Element"/>
  </parameter>
  <parameter>
    <name value="allowCreate"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="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 value="boolean"/>
  </parameter>
  <parameter>
    <name value="target"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="Pseudonymisation context (identical with Request)"/>
    <type value="Element"/>
  </parameter>
  <parameter>
    <name value="original"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="Original-identifier (identical with Request)"/>
    <type value="Element"/>
  </parameter>
  <parameter>
    <name value="pseudonym"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="Personal pseudonym."/>
    <type value="Element"/>
  </parameter>
</OperationDefinition>