Implementation Guide Pseudonymization Interface for the MII
2026.0.0-ballot.1 - ci-build

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

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Operation Definitions

These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide.

anonymize-original

Anonymises a single original entry within the specified domain. The reference of original value and pseudonym is permanently and irreversibly deleted.

de-pseudonymize

Returns the original value for a given pseudonym.

delete-pseudonym

Deletes a single pseudonym-entry (identified by the original value) in the specified domain, if the configuration of this domain allows this.

get-pseudonym

Get an existing single pseudonym for a single given original value (Read Only). For use in single-pseudonym-domains only. In the response, the repetition of the input values (pseudonymisation context, original identifier) is possible, but is not binding. When returning these input values, however, it is mandatory to ensure that the output values of target or orginal are identical to the input values of target or orignal.

pseudonymize

Creates a single pseudonym for a single given original value. For use in single-pseudonym-domains only. In the response, the repetition of the input values (pseudonymisation context, original identifier) is possible, but is not binding. When returning these input values, however, it is mandatory to ensure that the output values of target or orginal are identical to the input values of target or orignal.

pseudonymize-multiple

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.

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

0ee863aa-1fe7-4d5f-6666-8f5edc7981d9
DePseudonymizeRequestWithStringExample

An example of a $de-pseudonymize request using a pseudonym value of type string

DePseudonymizeResponseWithStringExample

An example of a $de-pseudonymize request response

GetPseudonymIdentifierResponseExample

An example of a response to a $get-pseudonym request within a single-pseudonym-domain

GetPseudonymRequestWithIdentifierExample

An example of a $get-pseudonym request within a single-pseudonym-domain using an original value of type identifier

GetPseudonymRequestWithStringExample

An example of a $get-pseudonym request within a single-pseudonym-domain using an original value of type string

GetPseudonymStringResponseExample

An example of a response to a $get-pseudonym request within a single-pseudonym-domain

OperationOutcome-AnonymizeOriginal-response-example-1

An example of a $anonymize-original response with success code

OperationOutcome-DeletePseudonym-response-example-1

An example of a $delete-pseudonym response with success

OperationOutcome-DeletePseudonym-response-example-2

An example of a $delete-pseudonym response with error

Parameters-AnonymizeOriginal-request-example-1

An example of a $anonymize-original request using a original value of type string

Parameters-DeletePseudonym-request-example-1

An example of a $delete-pseudonym request using two original values of type string

Parameters-PseudonymizeMultiple-request-example-1

An example of a $pseudonymize-multiple request to create 3 (secondary) pseudonyms for one existing pseudonym within a multi-psn-domain

Parameters-PseudonymizeMultiple-response-example-1

An example of a $pseudonymize response to create 3 secondary pseudonyms for one existing pseudonym within a multi-psn-domain

PseudonymizeIdentifierResponseExample

An example of a response to a $pseudonymize request within a single-pseudonym-domain

PseudonymizeRequestWithIdentifierExample

An example of a $pseudonymize request within a single-pseudonym-domain using an original value of type identifier

PseudonymizeRequestWithStringExample

An example of a $pseudonymize request within a single-pseudonym-domain using an original value of type string

PseudonymizeStringResponseExample

An example of a response to a $pseudonymize request within a single-pseudonym-domain

anonymize-original-example-bundle-batch-request

An example batch bundle to anonymize multiple pseudonyms in a single psn domain using opdef $anonymize-original

anonymize-original-example-bundle-batch-response

An example response bundle for the anonymize-original batch request in a single psn domain using opdef $anonymize-original

de-pseudonymize-example-bundle-batch-request

An example batch bundle to depseudonymize multiple pseudonyms in a single psn domain using opdef $de-pseudonymize

de-pseudonymize-example-bundle-batch-response

An example response bundle for the de-pseudonymize batch request in a single psn domain using opdef $de-pseudonymize

delete-pseudonym-example-bundle-batch-request

An example batch bundle to delete multiple pseudonyms in a single psn domain using opdef $delete-pseudonym

delete-pseudonym-example-bundle-batch-response

An example response bundle for the delete-pseudonym batch request in a single psn domain using opdef $delete-pseudonym

get-pseudonym-example-bundle-batch-request

An example batch bundle to read multiple pseudonyms in a single psn domain using opdef $get-pseudonym

get-pseudonym-example-bundle-batch-response

An example response bundle for the get-pseudonym batch request in a single psn domain using opdef $pseudonymize

pseudonymize-example-bundle-batch-request

An example batch bundle to create multiple pseudonyms in a single psn domain using opdef $pseudonymize

pseudonymize-example-bundle-batch-response

An example response bundle for the pseudonymize batch request in a single psn domain using opdef $pseudonymize

pseudonymize-multiple-example-bundle-batch-request

An example batch bundle to create multiple pseudonyms in a multi psn domain using opdef $pseudonymize-multiple

pseudonymize-multiple-example-bundle-batch-response

An example response bundle for the pseudonymize batch request in a multi psn domain using opdef $pseudonymize-multiple