Release 4 5 Snapshot #1

This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ) in it's permanent home (it will always be available at this URL). (v5.0.0-snapshot1: Release 5 Snapshot #1). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R4B R4 R3 R2

Extension: regex

FHIR Infrastructure Work Group   Maturity Level : 1 Informative Use Context : Any

URL for this extension: 


http://hl7.org/fhir/StructureDefinition/regex

Status: draft. Extension maintained by: Health Level Seven International (FHIR Infrastructure)

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

Comment :

For questionnaires, see additional guidance and examples in the SDC implementation guide .

Context of Use: Use on Element ID Questionnaire.item or Element ID ElementDefinition

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . regex 0..1 string URL = http://hl7.org/fhir/StructureDefinition/regex
regex: A regular expression that defines the syntax for the data element to be considered valid.


Use on Element ID Questionnaire.item or Element ID ElementDefinition

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/regex
regex: A regular expression that defines the syntax for the data element to be considered valid.


Use on Element ID Questionnaire.item or Element ID ElementDefinition
. . . Slices for extension I 0..0
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/regex"
. . . value[x] I 1..1 string Value of extension

doco Documentation for this format

XML Template 

<!-- regex -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/regex" >
  <!-- from Element: extension -->
 <

 <valueString value="[string]"/><!-- ?? 1..1 Value of extension -->

</extension>

JSON Template 

{ // regex
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/regex", // R! 
    "

    "valueString" : "<string>" // C? R! Value of extension

  }

Summary

Name Flags Card. Type Description & Constraints doco
. . regex 0..1 string URL = http://hl7.org/fhir/StructureDefinition/regex
regex: A regular expression that defines the syntax for the data element to be considered valid.


Use on Element ID Questionnaire.item or Element ID ElementDefinition

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/regex
regex: A regular expression that defines the syntax for the data element to be considered valid.


Use on Element ID Questionnaire.item or Element ID ElementDefinition
. . . Slices for extension I 0..0
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/regex"
. . . value[x] I 1..1 string Value of extension

doco Documentation for this format

XML Template 

<!-- regex -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/regex" >
  <!-- from Element: extension -->
 <

 <valueString value="[string]"/><!-- ?? 1..1 Value of extension -->

</extension>

JSON Template 

{ // regex
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/regex", // R! 
    "

    "valueString" : "<string>" // C? R! Value of extension

  }

 

Constraints

  • ele-1 : All FHIR elements must have a @value or children (xpath: @value|f:*|h:div )
  • ext-1 : Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) )
  • ele-1 : On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div )
  • ext-1 : On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]) )
  • ele-1 : On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div )

Examples of this extension