Anonymization-on-FHIR
0.0.1 - draft

Anonymization-on-FHIR, published by . This guide is not an authorized publication; it is the continuous build for version 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/ErwanBrunelliere/Anonymization-on-FHIR/ and changes regularly. See the Directory of published versions

Logical Model: AnonymizationOperation - Detailed Descriptions

Draft as of 2024-09-10

Definitions for the AnonymizationOperation logical model.

Guidance on how to interpret the contents of this table can be found here

0. AnonymizationOperation
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. AnonymizationOperation.purpose
Definition

Defines what is the goal of this operation.

ShortPurpose of the operation.
Control0..*
Typestring
Primitive ValueThis primitive type must have a value (the value must be present, and cannot be replaced by an extension)
Value Requiredtrue
4. AnonymizationOperation.request
Control1..1
Typestring
Primitive ValueThis primitive type must have a value (the value must be present, and cannot be replaced by an extension)
Value Requiredtrue
Example<br/><b>All Patient resources.</b>:Patient/ <br/><b>All active Patient resources.</b>:Patient/?active=true
6. AnonymizationOperation.element
Definition

Values that the anonymization process will keep and possibly modify with the specified rules.

ShortValues kept by the anonymization (and only ones).
Control0..*
TypeBackboneElement
8. AnonymizationOperation.element.path
Definition

A FHIRPath string that points the value being kept and might be modified.

ShortFHIRPath pointing the value.
Control1..1
Typestring
Primitive ValueThis primitive type must have a value (the value must be present, and cannot be replaced by an extension)
Value Requiredtrue
10. AnonymizationOperation.element.defaultValue[x]
Definition

A new value that will be taken by all of the elements. Should be used alone.

ShortA new value that will be taken by all of the elements.
Control0..1
TypeChoice of: url, uri, string, code, markdown, id, canonical, positiveInt, integer, boolean, dateTime, unsignedInt
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. AnonymizationOperation.element.noise[x]
Definition

A noise that will be applied randomly on all elements.

ShortNoise added to values.
Control0..1
TypeChoice of: integer, decimal, date, time, instant
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. AnonymizationOperation.element.shuffle
Definition

All elements will be shuffled, none of the resources will keep their original value, but will get one from another resource.

ShortShuffle elements from resources.
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Default Valuefalse
16. AnonymizationOperation.element.encryptionAlgorithm
Definition

Encryption algorithm supported, depending from the anonymizer.

ShortEncryption algorithm.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. AnonymizationOperation.element.hashFunction
Definition

Hashing algorithm supported, depending from the anonymizer.

ShortHashing algorithm.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. AnonymizationOperation.element.rank
Definition

Every value will get unique value unrelated from his original value.

ShortDefines if the value is replaced with a not related id.
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. AnonymizationOperation.element.aggregation
Definition

If the value is a int (k), ll the value will be in a group with at least k value. If the value is a ConceptMap, all values will get their target value.

ShortDefines an aggregation, automatic with a k value or with a ConceptMap.
Control0..1
TypeChoice of: unsignedInt, ConceptMap
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. AnonymizationOperation.element.diversity
Definition

In addition with the k-anonymization (aggregation) of another element, the l-diversity indicate how much of

ShortDefines l diversity for the element.
Control0..1
TypeunsignedInt
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Default Value0
26. AnonymizationOperation.element.closeness
Definition

If t-closeness is set, each group from k-anonymization will get the same distribution as the whole dataset.

ShortDefines the use of t-closeness.
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. AnonymizationOperation
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. AnonymizationOperation.purpose
Definition

Defines what is the goal of this operation.

ShortPurpose of the operation.
Control0..*
Typestring
Primitive ValueThis primitive type must have a value (the value must be present, and cannot be replaced by an extension)
Value Requiredtrue
4. AnonymizationOperation.request
Control1..1
Typestring
Primitive ValueThis primitive type must have a value (the value must be present, and cannot be replaced by an extension)
Summarytrue
Value Requiredtrue
Example<br/><b>All Patient resources.</b>:Patient/ <br/><b>All active Patient resources.</b>:Patient/?active=true
6. AnonymizationOperation.element
Definition

Values that the anonymization process will keep and possibly modify with the specified rules.

ShortValues kept by the anonymization (and only ones).
Control0..*
TypeBackboneElement
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. AnonymizationOperation.element.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
10. AnonymizationOperation.element.path
Definition

A FHIRPath string that points the value being kept and might be modified.

ShortFHIRPath pointing the value.
Control1..1
Typestring
Primitive ValueThis primitive type must have a value (the value must be present, and cannot be replaced by an extension)
Summarytrue
Value Requiredtrue
12. AnonymizationOperation.element.defaultValue[x]
Definition

A new value that will be taken by all of the elements. Should be used alone.

ShortA new value that will be taken by all of the elements.
Control0..1
TypeChoice of: url, uri, string, code, markdown, id, canonical, positiveInt, integer, boolean, dateTime, unsignedInt
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. AnonymizationOperation.element.noise[x]
Definition

A noise that will be applied randomly on all elements.

ShortNoise added to values.
Control0..1
TypeChoice of: integer, decimal, date, time, instant
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. AnonymizationOperation.element.shuffle
Definition

All elements will be shuffled, none of the resources will keep their original value, but will get one from another resource.

ShortShuffle elements from resources.
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Default Valuefalse
18. AnonymizationOperation.element.encryptionAlgorithm
Definition

Encryption algorithm supported, depending from the anonymizer.

ShortEncryption algorithm.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. AnonymizationOperation.element.hashFunction
Definition

Hashing algorithm supported, depending from the anonymizer.

ShortHashing algorithm.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. AnonymizationOperation.element.rank
Definition

Every value will get unique value unrelated from his original value.

ShortDefines if the value is replaced with a not related id.
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. AnonymizationOperation.element.aggregation
Definition

If the value is a int (k), ll the value will be in a group with at least k value. If the value is a ConceptMap, all values will get their target value.

ShortDefines an aggregation, automatic with a k value or with a ConceptMap.
Control0..1
TypeChoice of: unsignedInt, ConceptMap
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. AnonymizationOperation.element.diversity
Definition

In addition with the k-anonymization (aggregation) of another element, the l-diversity indicate how much of

ShortDefines l diversity for the element.
Control0..1
TypeunsignedInt
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Default Value0
28. AnonymizationOperation.element.closeness
Definition

If t-closeness is set, each group from k-anonymization will get the same distribution as the whole dataset.

ShortDefines the use of t-closeness.
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. AnonymizationOperation
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. AnonymizationOperation.purpose
Definition

Defines what is the goal of this operation.

ShortPurpose of the operation.
Control0..*
Typestring
Primitive ValueThis primitive type must have a value (the value must be present, and cannot be replaced by an extension)
Value Requiredtrue
4. AnonymizationOperation.request
Control1..1
Typestring
Primitive ValueThis primitive type must have a value (the value must be present, and cannot be replaced by an extension)
Summarytrue
Value Requiredtrue
Example<br/><b>All Patient resources.</b>:Patient/ <br/><b>All active Patient resources.</b>:Patient/?active=true
6. AnonymizationOperation.element
Definition

Values that the anonymization process will keep and possibly modify with the specified rules.

ShortValues kept by the anonymization (and only ones).
Control0..*
TypeBackboneElement
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. AnonymizationOperation.element.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typeid
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
10. AnonymizationOperation.element.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on AnonymizationOperation.element.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 12. AnonymizationOperation.element.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content, modifiers
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    14. AnonymizationOperation.element.path
    Definition

    A FHIRPath string that points the value being kept and might be modified.

    ShortFHIRPath pointing the value.
    Control1..1
    Typestring
    Primitive ValueThis primitive type must have a value (the value must be present, and cannot be replaced by an extension)
    Summarytrue
    Value Requiredtrue
    16. AnonymizationOperation.element.defaultValue[x]
    Definition

    A new value that will be taken by all of the elements. Should be used alone.

    ShortA new value that will be taken by all of the elements.
    Control0..1
    TypeChoice of: url, uri, string, code, markdown, id, canonical, positiveInt, integer, boolean, dateTime, unsignedInt
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    18. AnonymizationOperation.element.noise[x]
    Definition

    A noise that will be applied randomly on all elements.

    ShortNoise added to values.
    Control0..1
    TypeChoice of: integer, decimal, date, time, instant
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    20. AnonymizationOperation.element.shuffle
    Definition

    All elements will be shuffled, none of the resources will keep their original value, but will get one from another resource.

    ShortShuffle elements from resources.
    Control0..1
    Typeboolean
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Default Valuefalse
    22. AnonymizationOperation.element.encryptionAlgorithm
    Definition

    Encryption algorithm supported, depending from the anonymizer.

    ShortEncryption algorithm.
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    24. AnonymizationOperation.element.hashFunction
    Definition

    Hashing algorithm supported, depending from the anonymizer.

    ShortHashing algorithm.
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    26. AnonymizationOperation.element.rank
    Definition

    Every value will get unique value unrelated from his original value.

    ShortDefines if the value is replaced with a not related id.
    Control0..1
    Typeboolean
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    28. AnonymizationOperation.element.aggregation
    Definition

    If the value is a int (k), ll the value will be in a group with at least k value. If the value is a ConceptMap, all values will get their target value.

    ShortDefines an aggregation, automatic with a k value or with a ConceptMap.
    Control0..1
    TypeChoice of: unsignedInt, ConceptMap
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    30. AnonymizationOperation.element.diversity
    Definition

    In addition with the k-anonymization (aggregation) of another element, the l-diversity indicate how much of

    ShortDefines l diversity for the element.
    Control0..1
    TypeunsignedInt
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Default Value0
    32. AnonymizationOperation.element.closeness
    Definition

    If t-closeness is set, each group from k-anonymization will get the same distribution as the whole dataset.

    ShortDefines the use of t-closeness.
    Control0..1
    Typeboolean
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension