Implementation Guide Pseudonymization Interface for the MII
1.1.0 - ci-build

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

: pseudonymize-multiple - XML Representation

Active as of 2025-07-17

Raw xml | Download



<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="PseudonymizeMultiple"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition PseudonymizeMultiple</b></p><a name="PseudonymizeMultiple"> </a><a name="hcPseudonymizeMultiple"> </a><a name="PseudonymizeMultiple-en-US"> </a><p>URL: [base]/$pseudonymize-multiple</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#Element">Element</a></td><td/><td><div><p>Specification of the pseudonymisation context on the basis of which multiple personal pseudonyms are generated or (if available) searched for the specified original identifiers. Requires a multi-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 a single original identifier for which one or more pseudonyms are to be generated.</p>
</div></td></tr><tr><td>IN</td><td>count</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#integer">integer</a></td><td/><td><div><p>Number of to be generated pseudonyms</p>
</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>
</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>Pseudonymisation context (identical with Request)</p>
</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-identifier (identical with Request)</p>
</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>Personal or secondary pseudonym.</p>
</div></td></tr></table><div><p>Generation of a specific number of pseudonyms in an existing pseudonymisation context with simultaneous assignment to the given original value. For use in multi-pseudonym-domains.</p>
</div></div>
  </text>
  <url
       value="https://medizininformatik-initiative.de/fhir/fhir-pseudonymization/OperationDefinition/PseudonymizeMultiple"/>
  <version value="1.1.0"/>
  <name value="Pseudonymize-multiple"/>
  <title value="pseudonymize-multiple"/>
  <status value="active"/>
  <kind value="operation"/>
  <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="Generation of a specific number of pseudonyms in an existing pseudonymisation context with simultaneous assignment to the given original value. A typical use case is the creation of secondary pseudonyms. For use in multi-pseudonym-domains."/>
  <affectsState value="false"/>
  <code value="pseudonymize-multiple"/>
  <comment
           value="Generation of a specific number of pseudonyms in an existing pseudonymisation context with simultaneous assignment to the given original value. For use in multi-pseudonym-domains."/>
  <system value="true"/>
  <type value="false"/>
  <instance value="false"/>
  <parameter>
    <name value="target"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="Specification of the pseudonymisation context on the basis of which multiple personal pseudonyms are generated or (if available) searched for the specified original identifiers. Requires a multi-pseudonym-domain."/>
    <type value="Element"/>
  </parameter>
  <parameter>
    <name value="original"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="Specification of a single original identifier for which one or more pseudonyms are to be generated."/>
    <type value="Element"/>
  </parameter>
  <parameter>
    <name value="count"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="Number of to be generated pseudonyms"/>
    <type value="integer"/>
  </parameter>
  <parameter>
    <name value="pseudonym"/>
    <use value="out"/>
    <min value="1"/>
    <max value="*"/>
    <documentation
                   value="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 value="target"/>
      <use value="out"/>
      <min value="0"/>
      <max value="1"/>
      <documentation
                     value="Pseudonymisation context (identical with Request)"/>
      <type value="Element"/>
    </part>
    <part>
      <name value="original"/>
      <use value="out"/>
      <min value="0"/>
      <max value="1"/>
      <documentation value="Original-identifier (identical with Request)"/>
      <type value="Element"/>
    </part>
    <part>
      <name value="value"/>
      <use value="out"/>
      <min value="1"/>
      <max value="1"/>
      <documentation value="Personal or secondary pseudonym."/>
      <type value="Element"/>
    </part>
  </parameter>
</OperationDefinition>