FHIR Tooling Extensions IG
1.1.2 - Release 1.1 International flag

This page is part of the HL7 Tools Extension IG (v1.1.2: Release - Informative) based on FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions

Extension: Json Property Key Extension

Official URL: http://hl7.org/fhir/tools/StructureDefinition/json-property-key Version: 1.1.2
Standards status: Informative Active as of 2026-03-24 Maturity Level: 4 Computable Name: JsonPropertyKey
Other Identifiers: OID:2.16.840.1.113883.4.642.40.1.42.30

If true, indicates that in a JSON representation, the indicated child element is the json property key for the value. Implies that this is a property with max = * that has two children, one of which is the key and the other is the value

Context of Use

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..* Extension Indicates that this repeating element is represented as an object in json and the named one of the two sub-elements is the key for the other one
... extension 0..0 Extension
... url 1..1 uri "http://hl7.org/fhir/tools/StructureDefinition/json-property-key"
... value[x] 1..1 code Value of extension

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Indicates that this repeating element is represented as an object in json and the named one of the two sub-elements is the key for the other one
... id 0..1 id Unique id for inter-element referencing
... extension 0..0 Extension
Slice: Unordered, Open by value:url
... url 1..1 uri "http://hl7.org/fhir/tools/StructureDefinition/json-property-key"

doco Documentation for this format

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

Simple Extension with the type code: If true, indicates that in a JSON representation, the indicated child element is the json property key for the value. Implies that this is a property with max = * that has two children, one of which is the key and the other is the value

Maturity: 4

Differential ViewDifferential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Indicates that this repeating element is represented as an object in json and the named one of the two sub-elements is the key for the other one
... extension 0..0 Extension
... url 1..1 uri "http://hl7.org/fhir/tools/StructureDefinition/json-property-key"
... value[x] 1..1 code Value of extension

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Indicates that this repeating element is represented as an object in json and the named one of the two sub-elements is the key for the other one
... id 0..1 id Unique id for inter-element referencing
... extension 0..0 Extension
Slice: Unordered, Open by value:url
... url 1..1 uri "http://hl7.org/fhir/tools/StructureDefinition/json-property-key"

doco Documentation for this format

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

Simple Extension with the type code: If true, indicates that in a JSON representation, the indicated child element is the json property key for the value. Implies that this is a property with max = * that has two children, one of which is the key and the other is the value

Maturity: 4

 

Other representations of profile: CSV, Excel, Schematron