US Public Health Profiles Library
​2.0.0 - United States of America flag

US Public Health Profiles Library, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-us-ph-library/ and changes regularly. See the Directory of published versions

Extension: US Public Health Data Encrypted Extension

Official URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encrypted-extension Version: 2.0.0
Standards status: Trial-use Active as of 2025-10-23 Maturity Level: 3 Computable Name: USPublicHealthDataEncryptedExtension
Other Identifiers: OID:2.16.840.1.113883.4.642.40.58.42.13

This Extension profile indicates whether or not the data in the content bundle is encrypted.

Context of Use

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

Usage info

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Extension Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..1 Extension(4.0.1) US Public Health Data Encrypted Extension
... extension 0..0
... url 1..1 uri "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encrypted-extension"
... value[x] 0..1 boolean Value of extension

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..1 Extension(4.0.1) US Public Health Data Encrypted Extension
Constraints: ext-1
... id 0..1 string Unique id for inter-element referencing
... extension 0..0
... url 1..1 uri "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encrypted-extension"

doco Documentation for this format

Constraints

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

Summary

Simple Extension with the type boolean: This Extension profile indicates whether or not the data in the content bundle is encrypted.

Maturity: 3

Differential ViewDifferential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..1 Extension(4.0.1) US Public Health Data Encrypted Extension
... extension 0..0
... url 1..1 uri "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encrypted-extension"
... value[x] 0..1 boolean Value of extension

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..1 Extension(4.0.1) US Public Health Data Encrypted Extension
Constraints: ext-1
... id 0..1 string Unique id for inter-element referencing
... extension 0..0
... url 1..1 uri "http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-data-encrypted-extension"

doco Documentation for this format

Constraints

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

Summary

Simple Extension with the type boolean: This Extension profile indicates whether or not the data in the content bundle is encrypted.

Maturity: 3

 

Other representations of profile: CSV, Excel, Schematron