Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Extension: logicDefinition

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use Context: Any

Summary

Defining URL: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition

Version: 5.0.0-ballot

Name: logicDefinition

Title: null

Modifier: This extension is not a modifier extension

Status: draft

Definition: Represents a specific logic definition used by the artifact.

Committee: FHIR Infrastructure Work Group

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

Represents a specific logic definition used by the artifact.

Context of Use: Use on Element ID Element

Summary

Name	Card.	Type	Description & Constraints
logicDefinition	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition logicDefinition: Represents a specific logic definition used by the artifact. Use on Element ID Element
libraryName	1..1	string	The name of the library that contains this definition. This is the library name, not the library alias within any particular library usage, and SHOULD be the fully qualified name of the library (i.e. namespace included).
name	1..1	string	The name of the definition, e.g. Initial Population. For function definitions, this SHOULD include the function parameters (e.g. "Measure Observation"(Encounter Encounter)).
statement	1..1	string	The complete declaration statement for the definition. For example, define "Initial Population": [Encounter: "Inpatient"] E where duration in days of E.period > 2.
displayCategory	0..1	string	A string value providing a display category for the logic definition displayed in any human readable representation.
displaySequence	0..1	integer	An integer value indicating the order in which this definition should be displayed in any human readable representation.
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition logicDefinition: Represents a specific logic definition used by the artifact. Use on Element ID Element
Slices for extension	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:libraryName	1..1	Extension	Which library
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"libraryName"
value[x]	1..1	string	Value of extension
extension:name	1..1	Extension	Which definition
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"name"
value[x]	1..1	string	Value of extension
extension:statement	1..1	Extension	Complete declaration statement
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"statement"
value[x]	1..1	string	Value of extension
extension:displayCategory	0..1	Extension	What category?
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"displayCategory"
value[x]	1..1	string	Value of extension
extension:displaySequence	0..1	Extension	What order?
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"displaySequence"
value[x]	1..1	integer	Value of extension
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
value[x]	0..0
valueBase64Binary		base64Binary
valueBoolean		boolean
valueCanonical		canonical(Any)
valueCode		code
valueDate		date
valueDateTime		dateTime
valueDecimal		decimal
valueId		id
valueInstant		instant
valueInteger		integer
valueInteger64		integer64
valueMarkdown		markdown
valueOid		oid
valuePositiveInt		positiveInt
valueString		string
valueTime		time
valueUnsignedInt		unsignedInt
valueUri		uri
valueUrl		url
valueUuid		uuid
valueAddress		Address
valueAge		Age
valueAnnotation		Annotation
valueAttachment		Attachment
valueCodeableConcept		CodeableConcept
valueCodeableReference		CodeableReference
valueCoding		Coding
valueContactPoint		ContactPoint
valueCount		Count
valueDistance		Distance
valueDuration		Duration
valueHumanName		HumanName
valueIdentifier		Identifier
valueMoney		Money
valuePeriod		Period
valueQuantity		Quantity
valueRange		Range
valueRatio		Ratio
valueRatioRange		RatioRange
valueReference		Reference(Any)
valueSampledData		SampledData
valueSignature		Signature
valueTiming		Timing
valueContactDetail		ContactDetail
valueDataRequirement		DataRequirement
valueExpression		Expression
valueParameterDefinition		ParameterDefinition
valueRelatedArtifact		RelatedArtifact
valueTriggerDefinition		TriggerDefinition
valueUsageContext		UsageContext
valueAvailability		Availability
valueExtendedContactDetail		ExtendedContactDetail
valueDosage		Dosage
valueMeta		Meta
Documentation for this format

XML Template

<!-- logicDefinition -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="libraryName"> I 1..1 Extension  <!-- I 1..1 Which library -->
  <valueString value="[string]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="name"> I 1..1 Extension  <!-- I 1..1 Which definition -->
  <valueString value="[string]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="statement"> I 1..1 Extension  <!-- I 1..1 Complete declaration statement -->
  <valueString value="[string]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="displayCategory"> I 0..1 Extension  <!-- I 0..1 What category? -->
  <valueString value="[string]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="displaySequence"> I 0..1 Extension  <!-- I 0..1 What order? -->
  <valueInteger value="[integer]"/><!-- I 1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // logicDefinition
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Which library // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "libraryName", // R! 
        "valueString" : "<string>" // I R! Value of extension
      },
      { // Which definition // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "name", // R! 
        "valueString" : "<string>" // I R! Value of extension
      },
      { // Complete declaration statement // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "statement", // R! 
        "valueString" : "<string>" // I R! Value of extension
      },
      { // What category? // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "displayCategory", // R! 
        "valueString" : "<string>" // I R! Value of extension
      },
      { // What order? // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "displaySequence", // R! 
        "valueInteger" : <integer> // I R! Value of extension
      }
    ],
    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : { Extension }, // I R! Which library
    "extension" : { Extension }, // I R! Which definition
    "extension" : { Extension }, // I R! Complete declaration statement
    "extension" : { Extension }, // IWhat category?
    "extension" : { Extension }, // IWhat order?
    "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" // R! 
  // value[x]: Value of extension: Prohibited
  }

Summary

Name	Card.	Type	Description & Constraints
logicDefinition	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition logicDefinition: Represents a specific logic definition used by the artifact. Use on Element ID Element
libraryName	1..1	string	The name of the library that contains this definition. This is the library name, not the library alias within any particular library usage, and SHOULD be the fully qualified name of the library (i.e. namespace included).
name	1..1	string	The name of the definition, e.g. Initial Population. For function definitions, this SHOULD include the function parameters (e.g. "Measure Observation"(Encounter Encounter)).
statement	1..1	string	The complete declaration statement for the definition. For example, define "Initial Population": [Encounter: "Inpatient"] E where duration in days of E.period > 2.
displayCategory	0..1	string	A string value providing a display category for the logic definition displayed in any human readable representation.
displaySequence	0..1	integer	An integer value indicating the order in which this definition should be displayed in any human readable representation.
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition logicDefinition: Represents a specific logic definition used by the artifact. Use on Element ID Element
Slices for extension	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:libraryName	1..1	Extension	Which library
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"libraryName"
value[x]	1..1	string	Value of extension
extension:name	1..1	Extension	Which definition
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"name"
value[x]	1..1	string	Value of extension
extension:statement	1..1	Extension	Complete declaration statement
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"statement"
value[x]	1..1	string	Value of extension
extension:displayCategory	0..1	Extension	What category?
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"displayCategory"
value[x]	1..1	string	Value of extension
extension:displaySequence	0..1	Extension	What order?
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"displaySequence"
value[x]	1..1	integer	Value of extension
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
value[x]	0..0
valueBase64Binary		base64Binary
valueBoolean		boolean
valueCanonical		canonical(Any)
valueCode		code
valueDate		date
valueDateTime		dateTime
valueDecimal		decimal
valueId		id
valueInstant		instant
valueInteger		integer
valueInteger64		integer64
valueMarkdown		markdown
valueOid		oid
valuePositiveInt		positiveInt
valueString		string
valueTime		time
valueUnsignedInt		unsignedInt
valueUri		uri
valueUrl		url
valueUuid		uuid
valueAddress		Address
valueAge		Age
valueAnnotation		Annotation
valueAttachment		Attachment
valueCodeableConcept		CodeableConcept
valueCodeableReference		CodeableReference
valueCoding		Coding
valueContactPoint		ContactPoint
valueCount		Count
valueDistance		Distance
valueDuration		Duration
valueHumanName		HumanName
valueIdentifier		Identifier
valueMoney		Money
valuePeriod		Period
valueQuantity		Quantity
valueRange		Range
valueRatio		Ratio
valueRatioRange		RatioRange
valueReference		Reference(Any)
valueSampledData		SampledData
valueSignature		Signature
valueTiming		Timing
valueContactDetail		ContactDetail
valueDataRequirement		DataRequirement
valueExpression		Expression
valueParameterDefinition		ParameterDefinition
valueRelatedArtifact		RelatedArtifact
valueTriggerDefinition		TriggerDefinition
valueUsageContext		UsageContext
valueAvailability		Availability
valueExtendedContactDetail		ExtendedContactDetail
valueDosage		Dosage
valueMeta		Meta
Documentation for this format

XML Template

<!-- logicDefinition -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="libraryName"> I 1..1 Extension  <!-- I 1..1 Which library -->
  <valueString value="[string]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="name"> I 1..1 Extension  <!-- I 1..1 Which definition -->
  <valueString value="[string]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="statement"> I 1..1 Extension  <!-- I 1..1 Complete declaration statement -->
  <valueString value="[string]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="displayCategory"> I 0..1 Extension  <!-- I 0..1 What category? -->
  <valueString value="[string]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="displaySequence"> I 0..1 Extension  <!-- I 0..1 What order? -->
  <valueInteger value="[integer]"/><!-- I 1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // logicDefinition
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Which library // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "libraryName", // R! 
        "valueString" : "<string>" // I R! Value of extension
      },
      { // Which definition // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "name", // R! 
        "valueString" : "<string>" // I R! Value of extension
      },
      { // Complete declaration statement // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "statement", // R! 
        "valueString" : "<string>" // I R! Value of extension
      },
      { // What category? // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "displayCategory", // R! 
        "valueString" : "<string>" // I R! Value of extension
      },
      { // What order? // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "displaySequence", // R! 
        "valueInteger" : <integer> // I R! Value of extension
      }
    ],
    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : { Extension }, // I R! Which library
    "extension" : { Extension }, // I R! Which definition
    "extension" : { Extension }, // I R! Complete declaration statement
    "extension" : { Extension }, // IWhat category?
    "extension" : { Extension }, // IWhat order?
    "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" // R! 
  // value[x]: Value of extension: Prohibited
  }

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

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.