Quality Measure STU2 for FHIR R4 Implementation Guide

Quality Measure STU2 for FHIR R4 Implementation Guide

This page is part of the Quality Measure STU2 for FHIR R4 Implementation Guide (v2.0.0: STU 2) based on FHIR R4. The current version which supercedes this version is 3.0.0. For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition: cqfm-definitionTerm

Examples:

Simple Library Example (uses definitionTerm extension)

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is:

http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-definitionTerm

Specifies a term and its associated definition.

This profile builds on Extension.

This profile was published on Wed Feb 13 00:00:00 UTC 2019 as a active by Health Level Seven, Inc. - CQI WG.

Description of Profiles, Differentials, and Snapshots.

Text Summary
Differential Table
Snapshot Table
All

Summary

Mandatory: 2 elements
Fixed Value: 3 elements
Prohibited: 1 element

Name	Card.	Type	Description & Constraints
Extension	0..1	Extension	Defined term
extension:term	1..1	Extension	Term being defined
url	1..1	uri	"term"
value[x]	0..1	string	Value of extension
extension:definition	1..1	Extension	Definition of the term
url	1..1	uri	"definition"
value[x]	0..1	markdown	Value of extension
url	1..1	uri	"http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-definitionTerm"
value[x]	0..0
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Extension	I	0..1	Extension	Defined term
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:term	I	1..1	Extension	Term being defined
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]	I	0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
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
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
url		1..1	uri	"term"
value[x]	I	0..1	string	Value of extension
extension:definition	I	1..1	Extension	Definition of the term
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]	I	0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
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
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
url		1..1	uri	"definition"
value[x]	I	0..1	markdown	Value of extension
url		1..1	uri	"http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-definitionTerm"
Documentation for this format

Summary

Mandatory: 2 elements
Fixed Value: 3 elements
Prohibited: 1 element

Differential View

Name	Card.	Type	Description & Constraints
Extension	0..1	Extension	Defined term
extension:term	1..1	Extension	Term being defined
url	1..1	uri	"term"
value[x]	0..1	string	Value of extension
extension:definition	1..1	Extension	Definition of the term
url	1..1	uri	"definition"
value[x]	0..1	markdown	Value of extension
url	1..1	uri	"http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-definitionTerm"
value[x]	0..0
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Extension	I	0..1	Extension	Defined term
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:term	I	1..1	Extension	Term being defined
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]	I	0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
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
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
url		1..1	uri	"term"
value[x]	I	0..1	string	Value of extension
extension:definition	I	1..1	Extension	Definition of the term
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]	I	0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
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
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
url		1..1	uri	"definition"
value[x]	I	0..1	markdown	Value of extension
url		1..1	uri	"http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-definitionTerm"
Documentation for this format

D.4.1.2 Terminology Bindings

D.4.1.3 Constraints

Constraints

Id	Path	Details	Requirements
ele-1	Extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Extension.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Extension.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Extension.extension:term	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Extension.extension:term	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Extension.extension:term.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Extension.extension:term.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Extension.extension:term.extension.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Extension.extension:term.extension.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Extension.extension:term.extension.value[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Extension.extension:term.value[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Extension.extension:definition	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Extension.extension:definition	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Extension.extension:definition.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Extension.extension:definition.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Extension.extension:definition.extension.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Extension.extension:definition.extension.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Extension.extension:definition.extension.value[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Extension.extension:definition.value[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())