Quality Measure Implementation Guide (v0.1.0) (STU Ballot)

This page is part of the Quality Measure STU2 for FHIR R4 Implementation Guide (v0.1.0: STU 1 Ballot 1) based on FHIR R3. 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.4 StructureDefinition: cqfm-artifactComment - Detailed Descriptions

Definitions for the StructureDefinition-cqfm-artifactComment Profile.

1. Extension
Definition	A comment containing additional documentation, a review comment, usage guidance, or other relevant information from a particular user.
Control	0..* This element is affected by the following invariants: ele-1
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() \| (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
2. Extension.id
Definition	unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control	0..1
Type	string
3. Extension.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control	0..*
Type	Extension
Alternate Names	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
4. Extension.extension:type
Definition	Indicates whether the comment is providing additional documentation, a review comment that requires resolution, or providing usage guidance to an artifact consumer.
Control	1..1
Type	Extension
5. Extension.extension:type.id
Definition	unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control	0..1
Type	string
6. Extension.extension:type.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control	0..*
Type	Extension
Alternate Names	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
7. Extension.extension:type.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Control	1..1
Type	uri
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value	type
8. Extension.extension:type.valueCode
Definition	Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
Control	0..1
Binding	The type of artifact comment (documentation, review, guidance) The codes SHALL be taken from ArtifactCommentType
Type	code
9. Extension.extension:text
Definition	The text content of the comment.
Control	1..1
Type	Extension
10. Extension.extension:text.id
Definition	unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control	0..1
Type	string
11. Extension.extension:text.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control	0..*
Type	Extension
Alternate Names	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
12. Extension.extension:text.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Control	1..1
Type	uri
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value	text
13. Extension.extension:text.valueMarkdown
Definition	Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
Control	0..1
Type	markdown
14. Extension.extension:target
Definition	A URI that points to what the comment is about, such as a line of text in the CQL, or a specific element in a resource.
Control	0..*
Type	Extension
Comments	The target element is used to point the comment to aspect of the artifact, typically a text range within a CQL library (e.g. Library/example#content?0:0-120:80).
15. Extension.extension:target.id
Definition	unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control	0..1
Type	string
16. Extension.extension:target.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control	0..*
Type	Extension
Alternate Names	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
17. Extension.extension:target.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Control	1..1
Type	uri
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value	target
18. Extension.extension:target.valueUri
Definition	Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
Control	0..1
Type	uri
19. Extension.extension:reference
Definition	Provides additional supporting information relevant to the comment.
Control	0..*
Type	Extension
Comments	The reference element is used to reference other relevant information. For example, a comment may point to a citation in a relatedArtifact element (e.g. Library/example#relatedArtifact[ABC]).
20. Extension.extension:reference.id
Definition	unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control	0..1
Type	string
21. Extension.extension:reference.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control	0..*
Type	Extension
Alternate Names	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
22. Extension.extension:reference.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Control	1..1
Type	uri
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value	reference
23. Extension.extension:reference.valueUri
Definition	Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
Control	0..1
Type	uri
24. Extension.extension:user
Definition	Specifies the user that authored the comment.
Control	0..1
Type	Extension
25. Extension.extension:user.id
Definition	unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control	0..1
Type	string
26. Extension.extension:user.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control	0..*
Type	Extension
Alternate Names	extensions, user content
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
27. Extension.extension:user.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Control	1..1
Type	uri
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value	user
28. Extension.extension:user.valueString
Definition	Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
Control	0..1
Type	string
29. Extension.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Control	1..1
Type	uri
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value	http://hl7.org/fhir/us/cqfmeasures/StructureDefinition/cqfm-artifactComment
30. Extension.value[x]
Definition	Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
Control	0..0
Type	Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta
[x] Note	See Choice of Data Types for further information about how to use [x]