Release 5 Preview #1

This page is part of the FHIR Specification (v4.2.0: R5 Preview #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

Extension: Ordinal Value

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use Context: Any

URL for this extension:

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

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

A numeric value that allows the comparison (less than, greater than) or other numerical manipulation of a concept (e.g. Adding up components of a score). Scores are usually a whole number, but occasionally decimals are encountered in scores.

Comment:

Scores are commonly encountered in various clinical assessment scales. Assigning a value to a concept should generally be done in a formal code system that defines the value, or in an applicable value set for the concept, but some concepts do not have a formal definition (or are not even represented as a concept formally, especially in Questionnaires, so this extension is allowed to appear ouside those preferred contexts. Scores may even be assigned arbitrarily during use (hence, on Coding). The value may be constrained to an integer in some contexts of use. Todo: Scoring algorithms may also be defined directly, but how this is done is not yet defined.

Context of Use: Use on Element ID Coding, Element ID Questionnaire.item.answerOption, Element ID CodeSystem.concept or Element ID ValueSet.compose.include.concept

Summary

Name	Flags	Card.	Type	Description & Constraints
Ordinal Value		0..1	decimal	URL = http://hl7.org/fhir/StructureDefinition/ordinalValue Ordinal Value: A numeric value that allows the comparison (less than, greater than) or other numerical manipulation of a concept (e.g. Adding up components of a score). Scores are usually a whole number, but occasionally decimals are encountered in scores. Use on Element ID Coding, Element ID Questionnaire.item.answerOption, Element ID CodeSystem.concept or Element ID ValueSet.compose.include.concept
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/ordinalValue Ordinal Value: A numeric value that allows the comparison (less than, greater than) or other numerical manipulation of a concept (e.g. Adding up components of a score). Scores are usually a whole number, but occasionally decimals are encountered in scores. Use on Element ID Coding, Element ID Questionnaire.item.answerOption, Element ID CodeSystem.concept or Element ID ValueSet.compose.include.concept
extension	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/ordinalValue"
value[x]	I	1..1	decimal	Value of extension
Documentation for this format

XML Template

<!-- Ordinal Value -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/ordinalValue" >
  <!-- from Element: extension -->
 <valueDecimal value="[decimal]"/><!--  1..1 Value of extension -->
</extension>

JSON Template

{ // Ordinal Value
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/ordinalValue", // R! 
    "valueDecimal" : <decimal> // C? R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
Ordinal Value		0..1	decimal	URL = http://hl7.org/fhir/StructureDefinition/ordinalValue Ordinal Value: A numeric value that allows the comparison (less than, greater than) or other numerical manipulation of a concept (e.g. Adding up components of a score). Scores are usually a whole number, but occasionally decimals are encountered in scores. Use on Element ID Coding, Element ID Questionnaire.item.answerOption, Element ID CodeSystem.concept or Element ID ValueSet.compose.include.concept
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/ordinalValue Ordinal Value: A numeric value that allows the comparison (less than, greater than) or other numerical manipulation of a concept (e.g. Adding up components of a score). Scores are usually a whole number, but occasionally decimals are encountered in scores. Use on Element ID Coding, Element ID Questionnaire.item.answerOption, Element ID CodeSystem.concept or Element ID ValueSet.compose.include.concept
extension	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/ordinalValue"
value[x]	I	1..1	decimal	Value of extension
Documentation for this format

XML Template

<!-- Ordinal Value -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/ordinalValue" >
  <!-- from Element: extension -->
 <valueDecimal value="[decimal]"/><!--  1..1 Value of extension -->
</extension>

JSON Template

{ // Ordinal Value
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/ordinalValue", // R! 
    "valueDecimal" : <decimal> // 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)