FHIR Extensions Pack
5.3.0-ballot-tc1 - (September 2025 Ballot) International flag

FHIR Extensions Pack, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 5.3.0-ballot-tc1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-extensions/ and changes regularly. See the Directory of published versions

Extension: Entry format

Official URL: http://hl7.org/fhir/StructureDefinition/entryFormat Version: 5.3.0-ballot-tc1
Standards status: Trial-use Maturity Level: 3 Computable Name: EntryFormat
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1513

Additional instructions for the user to guide their input (i.e. a human readable version of a regular expression like "nnn-nnn-nnn"). In most UIs this is the placeholder (or 'ghost') text placed directly inside the edit controls and that disappear when the control gets the focus.

Context of Use

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

This extension only defines 'ghost' or similar prompt text. It does NOT enforce format rules, nor does it enable transformation from an entry format to the exchange format. To enforce rules on entry format for strings, use the constraint mechanism with a regular expression. There is no standard extension to manage transformation between entry and exchange format.

This extension is primarily intended for use with 'string' elements. Its use is not prohibited for other types of elements (e.g. dates, decimals, etc.) However, caution should be used when asserting 'ghost' text for such elements as the form filler may change the entry or display format for the item based on locale and, unlike strings, where the exchange format can be dictated by the questionnaire, for dates, numerics, and most other types, the exchange syntax is fixed, meaning that expecting an alternate entry or display format will require the form filler to perform a transformation.

Usage info

Usages:

  • This Extension is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Changes since version 5.2.0:

  • The data elements list has changed
  • One or more text definitions, invariants or bindings have changed

    • Formal Views of Extension Content

    Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

    This structure is derived from Extension

    Summary

    Simple Extension with the type string: Additional instructions for the user to guide their input (i.e. a human readable version of a regular expression like "nnn-nnn-nnn"). In most UIs this is the placeholder (or 'ghost') text placed directly inside the edit controls and that disappear when the control gets the focus.

    Maturity: 3

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension User prompt for format
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/entryFormat"
    ... value[x] 1..1 string Value of extension

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension User prompt for format
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/entryFormat"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Simple Extension with the type string: Additional instructions for the user to guide their input (i.e. a human readable version of a regular expression like "nnn-nnn-nnn"). In most UIs this is the placeholder (or 'ghost') text placed directly inside the edit controls and that disappear when the control gets the focus.

    Maturity: 3

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension User prompt for format
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/entryFormat"
    ... value[x] 1..1 string Value of extension

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension User prompt for format
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/entryFormat"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Constraints

    IdGradePath(s)DetailsRequirements
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    R4B

    The extension is not used in R4B

    • Duplicate Resource http://hl7.org/fhir/StructureDefinition/entryFormat of type StructureDefinition (existing version 4.3.0, new version 5.3.0-ballot-tc1)

    R4

    The extension is not used in R4

    • Duplicate Resource http://hl7.org/fhir/StructureDefinition/entryFormat of type StructureDefinition (existing version 4.0.1, new version 5.3.0-ballot-tc1)

    R3

    The extension is not used in R3

    • Duplicate Resource http://hl7.org/fhir/StructureDefinition/entryFormat of type StructureDefinition (existing version null, new version 5.3.0-ballot-tc1)

    Search Parameters for this Extension

    (none found)