This page is part of the HL7 Belgium FHIR Implementation Guide - Infrastructure and Security Profiles profiles (v1.3.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON

Extension: Pseudonymized content Extension

This is a marker interface. This extension allows to encrypt FHIR primitive elements.

Context of Use

This extension may be used on the following element(s)

• Element ID: Element

Usage info

Usages:

• Examples for this Extension: Patient/patient3

You can also check for usages in the FHIR IG Statistics

Formal Views of Extension Content

Description Differentials, Snapshots, and other representations.

• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Extension		0..*	Extension	Pseudonymization data
extension		2..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:encryptedValue	S	1..1	Extension	Extension
extension		0..0		Extension
url		1..1	uri	"encryptedValue"
value[x]	S	0..1	string	FHIR primitive element that needs to be encrypted.
extension:marker	S	1..1	Extension	Extension
extension		0..0		Extension
url		1..1	uri	"marker"
value[x]		0..1	boolean	Value of extension Required Pattern: true
extension:format	S	0..1	Extension	Extension
extension		0..0		Extension
url		1..1	uri	"format"
value[x]	S	0..1	code	provide encrypted only in case of Blinded Pseudonymization Cookbook, Annex: Processing of input data exceeding 32 bytes Binding: Types of pseudonymization ValueSet (required)
extension:version	S	0..1	Extension	Extension
extension		0..0		Extension
url		1..1	uri	"version"
value[x]	S	0..1	positiveInt	version of the pseudonym encoding
url		1..1	uri	"https://www.ehealth.fgov.be/standards/fhir/infsec/StructureDefinition/be-ext-pseudonymized-content"
value[x]		0..0		Value of extension
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Extension.extension:format.​value[x]	Base	required	Types of pseudonymization ValueSet	📦1.3.0	This IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Extension		0..*	Extension	Pseudonymization data
id		0..1	string	Unique id for inter-element referencing
Slices for extension		2..*	Extension	Extension Slice: Unordered, Open by value:url
extension:encryptedValue	S	1..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"encryptedValue"
value[x]	S	0..1	string	FHIR primitive element that needs to be encrypted.
extension:marker	S	1..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"marker"
value[x]		0..1	boolean	Value of extension Required Pattern: true
extension:format	S	0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"format"
value[x]	S	0..1	code	provide encrypted only in case of Blinded Pseudonymization Cookbook, Annex: Processing of input data exceeding 32 bytes Binding: Types of pseudonymization ValueSet (required)
extension:version	S	0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"version"
value[x]	S	0..1	positiveInt	version of the pseudonym encoding
url		1..1	uri	"https://www.ehealth.fgov.be/standards/fhir/infsec/StructureDefinition/be-ext-pseudonymized-content"
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Extension.extension:format.​value[x]	Base	required	Types of pseudonymization ValueSet	📦1.3.0	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()

Summary

Complex Extension: This is a marker interface. This extension allows to encrypt FHIR primitive elements.

• encryptedValue: string: An Extension
• marker: boolean: An Extension
• format: code: An Extension
• version: positiveInt: An Extension

Differential ViewDifferential View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Extension		0..*	Extension	Pseudonymization data
extension		2..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:encryptedValue	S	1..1	Extension	Extension
extension		0..0		Extension
url		1..1	uri	"encryptedValue"
value[x]	S	0..1	string	FHIR primitive element that needs to be encrypted.
extension:marker	S	1..1	Extension	Extension
extension		0..0		Extension
url		1..1	uri	"marker"
value[x]		0..1	boolean	Value of extension Required Pattern: true
extension:format	S	0..1	Extension	Extension
extension		0..0		Extension
url		1..1	uri	"format"
value[x]	S	0..1	code	provide encrypted only in case of Blinded Pseudonymization Cookbook, Annex: Processing of input data exceeding 32 bytes Binding: Types of pseudonymization ValueSet (required)
extension:version	S	0..1	Extension	Extension
extension		0..0		Extension
url		1..1	uri	"version"
value[x]	S	0..1	positiveInt	version of the pseudonym encoding
url		1..1	uri	"https://www.ehealth.fgov.be/standards/fhir/infsec/StructureDefinition/be-ext-pseudonymized-content"
value[x]		0..0		Value of extension
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Extension.extension:format.​value[x]	Base	required	Types of pseudonymization ValueSet	📦1.3.0	This IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Extension		0..*	Extension	Pseudonymization data
id		0..1	string	Unique id for inter-element referencing
Slices for extension		2..*	Extension	Extension Slice: Unordered, Open by value:url
extension:encryptedValue	S	1..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"encryptedValue"
value[x]	S	0..1	string	FHIR primitive element that needs to be encrypted.
extension:marker	S	1..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"marker"
value[x]		0..1	boolean	Value of extension Required Pattern: true
extension:format	S	0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"format"
value[x]	S	0..1	code	provide encrypted only in case of Blinded Pseudonymization Cookbook, Annex: Processing of input data exceeding 32 bytes Binding: Types of pseudonymization ValueSet (required)
extension:version	S	0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0		Extension Slice: Unordered, Open by value:url
url		1..1	uri	"version"
value[x]	S	0..1	positiveInt	version of the pseudonym encoding
url		1..1	uri	"https://www.ehealth.fgov.be/standards/fhir/infsec/StructureDefinition/be-ext-pseudonymized-content"
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Extension.extension:format.​value[x]	Base	required	Types of pseudonymization ValueSet	📦1.3.0	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()

Summary

Complex Extension: This is a marker interface. This extension allows to encrypt FHIR primitive elements.

• encryptedValue: string: An Extension
• marker: boolean: An Extension
• format: code: An Extension
• version: positiveInt: An Extension

Other representations of profile: CSV, Excel, Schematron