FHIR Extensions Pack
5.2.0 - February 2025 International flag

This page is part of the FHIR Core Extensions Registry (v5.2.0: Release 5.2) based on FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Extension: Regex

Official URL: http://hl7.org/fhir/StructureDefinition/regex Version: 5.2.0
Standards status: Deprecated Maturity Level: 1 Computable Name: Regex

A regular expression that defines the syntax for the data element to be considered valid.

Context of Use

This extension is deprecated and should no longer be used

This was deprecated in favor of using a constraint on the element using FHIRPath, since constraints allow for the provision of a human readable message associated with the regex

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

Usage info

Usage:

Changes since version 1.0.0:

  • New Content

    • 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 of type string: A regular expression that defines the syntax for the data element to be considered valid.

    Maturity: 1

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Regular expression pattern
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/regex"
    ... value[x] 1..1 string Value of extension

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Regular expression pattern
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/regex"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Simple Extension of type string: A regular expression that defines the syntax for the data element to be considered valid.

    Maturity: 1

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Regular expression pattern
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/regex"
    ... value[x] 1..1 string Value of extension

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Regular expression pattern
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/regex"

    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()

    Search Parameters for this Extension

    (none found)