STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). 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

Extension: Mark a warning invariant as 'best practice'

(No assigned work group)   Maturity Level : 0 Context: Any

URL for this extension: 


http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice

Status: draft. Extension maintained by: Health Level Seven, Inc. - FHIR Core WG

Mark that an invariant represents 'best practice' rule - a rule that implementers may choose to enforce at error level in some or all circumstances.

Context of Use: Use on data type: ElementDefinition.constraint

usage info: insert a list of places where this extension is used

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 boolean , CodeableConcept URL = http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice
Mark a warning invariant as 'best practice': Mark that an invariant represents 'best practice' rule - a rule that implementers may choose to enforce at error level in some or all circumstances.
Use on data type: ElementDefinition.constraint

doco Documentation for this format

Fulle Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice
Mark a warning invariant as 'best practice': Mark that an invariant represents 'best practice' rule - a rule that implementers may choose to enforce at error level in some or all circumstances.
Use on data type: ElementDefinition.constraint
. . . extension 0 .. 0
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice"
. . . value[x] 1..1 boolean , CodeableConcept Value of extension
Binding: Context of Use ValueSet ( extensible )

doco Documentation for this format

XML Template 

<!-- Mark a warning invariant as 'best practice' -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice" >
  <!-- from Element: extension -->
 <value[x]><!-- 1..1 boolean|CodeableConcept Value of extension --></value[x]>
</extension>

JSON Template 

{ // Mark a warning invariant as 'best practice'
  // from Element: extension
    "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice", // R! 
// value[x]: Value of extension. One of these 2:
    "valueBoolean" : <boolean> // R! Value of extension
    "valueCodeableConcept" : { CodeableConcept }, // R! Value of extension
  }

Summary

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 boolean , CodeableConcept URL = http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice
Mark a warning invariant as 'best practice': Mark that an invariant represents 'best practice' rule - a rule that implementers may choose to enforce at error level in some or all circumstances.
Use on data type: ElementDefinition.constraint

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice
Mark a warning invariant as 'best practice': Mark that an invariant represents 'best practice' rule - a rule that implementers may choose to enforce at error level in some or all circumstances.
Use on data type: ElementDefinition.constraint
. . . extension 0 .. 0
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice"
. . . value[x] 1..1 boolean , CodeableConcept Value of extension
Binding: Context of Use ValueSet ( extensible )

doco Documentation for this format

XML Template 

<!-- Mark a warning invariant as 'best practice' -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice" >
  <!-- from Element: extension -->
 <value[x]><!-- 1..1 boolean|CodeableConcept Value of extension --></value[x]>
</extension>

JSON Template 

{ // Mark a warning invariant as 'best practice'
  // from Element: extension
    "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice", // R! 
// value[x]: Value of extension. One of these 2:
    "valueBoolean" : <boolean> // R! Value of extension
    "valueCodeableConcept" : { CodeableConcept }, // 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')]) )