Release 5 Draft Ballot

This page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot). 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: bestpractice

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use 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.

Comment:

Validators may/should offer implementers the choice to enforce invariants labeled as 'best practice' as errors not warnings.

Context of Use: Use on Element ID ElementDefinition.constraint

Summary

Name	Flags	Card.	Type	Description & Constraints
bestpractice		0..1	boolean, CodeableConcept	URL = http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice bestpractice: Mark that an invariant represents 'best practice' rule - a rule that implementers may choose to enforce at error level in some or all circumstances. Binding: ConformanceUseContext (extensible) Use on Element ID ElementDefinition.constraint
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice bestpractice: 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 Element ID ElementDefinition.constraint
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice"
value[x]	1..1		Value of extension Binding: ConformanceUseContext (extensible)
valueBoolean		boolean
valueCodeableConcept		CodeableConcept
Documentation for this format

XML Template

<!-- bestpractice -->

<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

{ // bestpractice
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice", // R! 
// value[x]: Value of extension. One of these 2:
    "valueBoolean" : <boolean> // C? R! Value of extension
    "valueCodeableConcept" : { CodeableConcept }, // C? R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
bestpractice		0..1	boolean, CodeableConcept	URL = http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice bestpractice: Mark that an invariant represents 'best practice' rule - a rule that implementers may choose to enforce at error level in some or all circumstances. Binding: ConformanceUseContext (extensible) Use on Element ID ElementDefinition.constraint
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice bestpractice: 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 Element ID ElementDefinition.constraint
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice"
value[x]	1..1		Value of extension Binding: ConformanceUseContext (extensible)
valueBoolean		boolean
valueCodeableConcept		CodeableConcept
Documentation for this format

XML Template

<!-- bestpractice -->

<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

{ // bestpractice
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice", // R! 
// value[x]: Value of extension. One of these 2:
    "valueBoolean" : <boolean> // C? R! Value of extension
    "valueCodeableConcept" : { CodeableConcept }, // 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)