Canonical Resource Management Infrastructure Implementation Guide
1.0.0-ballot - Ballot International flag

This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v1.0.0-ballot: STU1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: CRMI Publishable Measure

Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishablemeasure Version: 1.0.0-ballot
Standards status: Trial-use Maturity Level: 3 Computable Name: CRMIPublishableMeasure

Supports declaration of the Measure metadata required by HL7 and other organizations that share and publish measures with a focus on the aspects of that metadata that are important for post-publication activities including distribution, inclusion in repositories, consumption, and implementation.

Usage:

  • Examples for this Resource Profile: ANCIND01

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from CRMIShareableMeasure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Measure 1..1CRMIShareableMeasureA quality measure definition
... copyrightLabel S0..1stringCopyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
... identifier S0..*IdentifierAdditional identifier for the measure
... date S1..1dateTimeDate last changed
... useContext S0..*UsageContextThe context that the content is intended to support
... jurisdiction S0..*CodeableConceptIntended jurisdiction for measure (if applicable)
... purpose S0..1markdownWhy this measure is defined
... usage S0..1stringDescribes the clinical usage of the measure
... copyright S0..1markdownUse and/or publishing restrictions
... approvalDate S0..1dateWhen the measure was approved by publisher
... lastReviewDate S0..1dateWhen the measure was last reviewed
... effectivePeriod S0..1PeriodWhen the measure is expected to be used
... topic S0..*CodeableConceptThe category of the measure, such as Education, Treatment, Assessment, etc.
... author S0..*ContactDetailWho authored the content
... editor S0..*ContactDetailWho edited the content
... reviewer S0..*ContactDetailWho reviewed the content
... endorser S0..*ContactDetailWho endorsed the content
... relatedArtifact S0..*RelatedArtifactAdditional documentation, citations, etc.
.... display S0..1stringBrief description of the related artifact
.... document S0..1AttachmentWhat document is being referenced
.... resource S0..1canonical(Resource)What resource is being referenced

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Measure C1..1CRMIShareableMeasureA quality measure definition
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... knowledgeCapability S0..*codeshareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapabilityValues (required)
... knowledgeRepresentationLevel S0..*codenarrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: KnowledgeRepresentationLevelValues (required)
... artifactComment S0..*(Complex)Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
... versionAlgorithm S0..1string, CodingHow to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible): The algorithm used to compare versions for the artifact


... versionPolicy S0..1Codingmetadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy Values (extensible): The versioning policy of the artifact


... copyrightLabel S0..1stringCopyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ1..1uriCanonical identifier for this measure, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the measure
... version SΣ1..1stringBusiness version of the measure
... name SΣC0..1stringName for this measure (computer friendly)
... title SΣ1..1stringName for this measure (human friendly)
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental SΣ0..1booleanFor testing purposes, not real usage
... date SΣ1..1dateTimeDate last changed
... publisher SΣ0..1stringName of the publisher (organization or individual)
... contact SΣ0..*ContactDetailContact details for the publisher
... description SΣ1..1markdownNatural language description of the measure
... useContext SΣ0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣ0..*CodeableConceptIntended jurisdiction for measure (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose S0..1markdownWhy this measure is defined
... usage S0..1stringDescribes the clinical usage of the measure
... copyright S0..1markdownUse and/or publishing restrictions
... approvalDate S0..1dateWhen the measure was approved by publisher
... lastReviewDate S0..1dateWhen the measure was last reviewed
... effectivePeriod SΣ0..1PeriodWhen the measure is expected to be used
... topic S0..*CodeableConceptThe category of the measure, such as Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... author S0..*ContactDetailWho authored the content
... editor S0..*ContactDetailWho edited the content
... reviewer S0..*ContactDetailWho reviewed the content
... endorser S0..*ContactDetailWho endorsed the content
... relatedArtifact S0..*RelatedArtifactAdditional documentation, citations, etc.
.... type Σ1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.

.... display SΣ0..1stringBrief description of the related artifact
.... document SΣ0..1AttachmentWhat document is being referenced
.... resource SΣ0..1canonical(Resource)What resource is being referenced

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Measure.statusrequiredPublicationStatus
Measure.jurisdictionextensibleJurisdiction ValueSet
Measure.topicexampleDefinitionTopic
Measure.relatedArtifact.typerequiredRelatedArtifactType

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMeasureIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMeasureIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMeasureIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorMeasureIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMeasureA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
mea-0warningMeasureName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
mea-1errorMeasureStratifier SHALL be either a single criteria or a set of criteria components
: group.stratifier.all((code | description | criteria).exists() xor component.exists())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Measure C1..1CRMIShareableMeasureA quality measure definition
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... knowledgeCapability S0..*codeshareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapabilityValues (required)
... knowledgeRepresentationLevel S0..*codenarrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: KnowledgeRepresentationLevelValues (required)
... artifactComment S0..*(Complex)Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
... versionAlgorithm S0..1string, CodingHow to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible): The algorithm used to compare versions for the artifact


... versionPolicy S0..1Codingmetadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy Values (extensible): The versioning policy of the artifact


... copyrightLabel S0..1stringCopyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ1..1uriCanonical identifier for this measure, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the measure
... version SΣ1..1stringBusiness version of the measure
... name SΣC0..1stringName for this measure (computer friendly)
... title SΣ1..1stringName for this measure (human friendly)
... subtitle 0..1stringSubordinate title of the measure
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental SΣ0..1booleanFor testing purposes, not real usage
... subject[x] 0..1E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Binding: SubjectType (extensible): The possible types of subjects for a measure (E.g. Patient, Practitioner, Organization, Location, etc.).

.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date SΣ1..1dateTimeDate last changed
... publisher SΣ0..1stringName of the publisher (organization or individual)
... contact SΣ0..*ContactDetailContact details for the publisher
... description SΣ1..1markdownNatural language description of the measure
... useContext SΣ0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣ0..*CodeableConceptIntended jurisdiction for measure (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose S0..1markdownWhy this measure is defined
... usage S0..1stringDescribes the clinical usage of the measure
... copyright S0..1markdownUse and/or publishing restrictions
... approvalDate S0..1dateWhen the measure was approved by publisher
... lastReviewDate S0..1dateWhen the measure was last reviewed
... effectivePeriod SΣ0..1PeriodWhen the measure is expected to be used
... topic S0..*CodeableConceptThe category of the measure, such as Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... author S0..*ContactDetailWho authored the content
... editor S0..*ContactDetailWho edited the content
... reviewer S0..*ContactDetailWho reviewed the content
... endorser S0..*ContactDetailWho endorsed the content
... relatedArtifact S0..*RelatedArtifactAdditional documentation, citations, etc.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... type Σ1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.

.... label Σ0..1stringShort label
.... display SΣ0..1stringBrief description of the related artifact
.... citation Σ0..1markdownBibliographic citation for the artifact
.... url Σ0..1urlWhere the artifact can be accessed
.... document SΣ0..1AttachmentWhat document is being referenced
.... resource SΣ0..1canonical(Resource)What resource is being referenced
... library 0..*canonical(Library)Logic used by the measure
... disclaimer Σ0..1markdownDisclaimer for use of the measure or its referenced content
... scoring Σ0..1CodeableConceptproportion | ratio | continuous-variable | cohort
Binding: MeasureScoring (extensible): The scoring type of the measure.

... compositeScoring Σ0..1CodeableConceptopportunity | all-or-nothing | linear | weighted
Binding: CompositeMeasureScoring (extensible): The composite scoring method of the measure.

... type Σ0..*CodeableConceptprocess | outcome | structure | patient-reported-outcome | composite
Binding: MeasureType (extensible): The type of measure (includes codes from 2.16.840.1.113883.1.11.20368).


... riskAdjustment Σ0..1stringHow risk adjustment is applied for this measure
... rateAggregation Σ0..1stringHow is rate aggregation performed for this measure
... rationale Σ0..1markdownDetailed description of why the measure exists
... clinicalRecommendationStatement Σ0..1markdownSummary of clinical guidelines
... improvementNotation Σ0..1CodeableConceptincrease | decrease
Binding: MeasureImprovementNotation (required): Observation values that indicate what change in a measurement value or score is indicative of an improvement in the measured item or scored issue.

... definition Σ0..*markdownDefined terms used in the measure documentation
... guidance Σ0..1markdownAdditional guidance for implementers
... group 0..*BackboneElementPopulation criteria group
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 0..1CodeableConceptMeaning of the group
.... description 0..1stringSummary description
.... population 0..*BackboneElementPopulation criteria
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 0..1CodeableConceptinitial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation
Binding: MeasurePopulationType (extensible): The type of population.

..... description 0..1stringThe human readable description of this population criteria
..... criteria 1..1ExpressionThe criteria that defines this population
.... stratifier 0..*BackboneElementStratifier criteria for the measure
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 0..1CodeableConceptMeaning of the stratifier
..... description 0..1stringThe human readable description of this stratifier
..... criteria 0..1ExpressionHow the measure should be stratified
..... component 0..*BackboneElementStratifier criteria component for the measure
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... code 0..1CodeableConceptMeaning of the stratifier component
...... description 0..1stringThe human readable description of this stratifier component
...... criteria 1..1ExpressionComponent of how the measure should be stratified
... supplementalData 0..*BackboneElementWhat other data should be reported with the measure
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 0..1CodeableConceptMeaning of the supplemental data
.... usage 0..*CodeableConceptsupplemental-data | risk-adjustment-factor
Binding: MeasureDataUsage (extensible): The intended usage for supplemental data elements in the measure.


.... description 0..1stringThe human readable description of this supplemental data
.... criteria 1..1ExpressionExpression describing additional data to be reported

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Measure.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Measure.statusrequiredPublicationStatus
Measure.subject[x]extensibleSubjectType
Measure.jurisdictionextensibleJurisdiction ValueSet
Measure.topicexampleDefinitionTopic
Measure.relatedArtifact.typerequiredRelatedArtifactType
Measure.scoringextensibleMeasureScoring
Measure.compositeScoringextensibleCompositeMeasureScoring
Measure.typeextensibleMeasureType
Measure.improvementNotationrequiredMeasureImprovementNotation
Measure.group.population.codeextensibleMeasurePopulationType
Measure.supplementalData.usageextensibleMeasureDataUsage

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from CRMIShareableMeasure

Summary

Mandatory: 1 element
Must-Support: 21 elements

Extensions

This structure refers to these extensions:

Maturity: 3

Differential View

This structure is derived from CRMIShareableMeasure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Measure 1..1CRMIShareableMeasureA quality measure definition
... copyrightLabel S0..1stringCopyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
... identifier S0..*IdentifierAdditional identifier for the measure
... date S1..1dateTimeDate last changed
... useContext S0..*UsageContextThe context that the content is intended to support
... jurisdiction S0..*CodeableConceptIntended jurisdiction for measure (if applicable)
... purpose S0..1markdownWhy this measure is defined
... usage S0..1stringDescribes the clinical usage of the measure
... copyright S0..1markdownUse and/or publishing restrictions
... approvalDate S0..1dateWhen the measure was approved by publisher
... lastReviewDate S0..1dateWhen the measure was last reviewed
... effectivePeriod S0..1PeriodWhen the measure is expected to be used
... topic S0..*CodeableConceptThe category of the measure, such as Education, Treatment, Assessment, etc.
... author S0..*ContactDetailWho authored the content
... editor S0..*ContactDetailWho edited the content
... reviewer S0..*ContactDetailWho reviewed the content
... endorser S0..*ContactDetailWho endorsed the content
... relatedArtifact S0..*RelatedArtifactAdditional documentation, citations, etc.
.... display S0..1stringBrief description of the related artifact
.... document S0..1AttachmentWhat document is being referenced
.... resource S0..1canonical(Resource)What resource is being referenced

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Measure C1..1CRMIShareableMeasureA quality measure definition
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... knowledgeCapability S0..*codeshareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapabilityValues (required)
... knowledgeRepresentationLevel S0..*codenarrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: KnowledgeRepresentationLevelValues (required)
... artifactComment S0..*(Complex)Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
... versionAlgorithm S0..1string, CodingHow to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible): The algorithm used to compare versions for the artifact


... versionPolicy S0..1Codingmetadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy Values (extensible): The versioning policy of the artifact


... copyrightLabel S0..1stringCopyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ1..1uriCanonical identifier for this measure, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the measure
... version SΣ1..1stringBusiness version of the measure
... name SΣC0..1stringName for this measure (computer friendly)
... title SΣ1..1stringName for this measure (human friendly)
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental SΣ0..1booleanFor testing purposes, not real usage
... date SΣ1..1dateTimeDate last changed
... publisher SΣ0..1stringName of the publisher (organization or individual)
... contact SΣ0..*ContactDetailContact details for the publisher
... description SΣ1..1markdownNatural language description of the measure
... useContext SΣ0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣ0..*CodeableConceptIntended jurisdiction for measure (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose S0..1markdownWhy this measure is defined
... usage S0..1stringDescribes the clinical usage of the measure
... copyright S0..1markdownUse and/or publishing restrictions
... approvalDate S0..1dateWhen the measure was approved by publisher
... lastReviewDate S0..1dateWhen the measure was last reviewed
... effectivePeriod SΣ0..1PeriodWhen the measure is expected to be used
... topic S0..*CodeableConceptThe category of the measure, such as Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... author S0..*ContactDetailWho authored the content
... editor S0..*ContactDetailWho edited the content
... reviewer S0..*ContactDetailWho reviewed the content
... endorser S0..*ContactDetailWho endorsed the content
... relatedArtifact S0..*RelatedArtifactAdditional documentation, citations, etc.
.... type Σ1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.

.... display SΣ0..1stringBrief description of the related artifact
.... document SΣ0..1AttachmentWhat document is being referenced
.... resource SΣ0..1canonical(Resource)What resource is being referenced

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Measure.statusrequiredPublicationStatus
Measure.jurisdictionextensibleJurisdiction ValueSet
Measure.topicexampleDefinitionTopic
Measure.relatedArtifact.typerequiredRelatedArtifactType

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMeasureIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMeasureIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMeasureIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorMeasureIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMeasureA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
mea-0warningMeasureName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
mea-1errorMeasureStratifier SHALL be either a single criteria or a set of criteria components
: group.stratifier.all((code | description | criteria).exists() xor component.exists())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Measure C1..1CRMIShareableMeasureA quality measure definition
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... knowledgeCapability S0..*codeshareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapabilityValues (required)
... knowledgeRepresentationLevel S0..*codenarrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: KnowledgeRepresentationLevelValues (required)
... artifactComment S0..*(Complex)Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
... versionAlgorithm S0..1string, CodingHow to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible): The algorithm used to compare versions for the artifact


... versionPolicy S0..1Codingmetadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy Values (extensible): The versioning policy of the artifact


... copyrightLabel S0..1stringCopyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ1..1uriCanonical identifier for this measure, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the measure
... version SΣ1..1stringBusiness version of the measure
... name SΣC0..1stringName for this measure (computer friendly)
... title SΣ1..1stringName for this measure (human friendly)
... subtitle 0..1stringSubordinate title of the measure
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental SΣ0..1booleanFor testing purposes, not real usage
... subject[x] 0..1E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Binding: SubjectType (extensible): The possible types of subjects for a measure (E.g. Patient, Practitioner, Organization, Location, etc.).

.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date SΣ1..1dateTimeDate last changed
... publisher SΣ0..1stringName of the publisher (organization or individual)
... contact SΣ0..*ContactDetailContact details for the publisher
... description SΣ1..1markdownNatural language description of the measure
... useContext SΣ0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣ0..*CodeableConceptIntended jurisdiction for measure (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose S0..1markdownWhy this measure is defined
... usage S0..1stringDescribes the clinical usage of the measure
... copyright S0..1markdownUse and/or publishing restrictions
... approvalDate S0..1dateWhen the measure was approved by publisher
... lastReviewDate S0..1dateWhen the measure was last reviewed
... effectivePeriod SΣ0..1PeriodWhen the measure is expected to be used
... topic S0..*CodeableConceptThe category of the measure, such as Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... author S0..*ContactDetailWho authored the content
... editor S0..*ContactDetailWho edited the content
... reviewer S0..*ContactDetailWho reviewed the content
... endorser S0..*ContactDetailWho endorsed the content
... relatedArtifact S0..*RelatedArtifactAdditional documentation, citations, etc.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... type Σ1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.

.... label Σ0..1stringShort label
.... display SΣ0..1stringBrief description of the related artifact
.... citation Σ0..1markdownBibliographic citation for the artifact
.... url Σ0..1urlWhere the artifact can be accessed
.... document SΣ0..1AttachmentWhat document is being referenced
.... resource SΣ0..1canonical(Resource)What resource is being referenced
... library 0..*canonical(Library)Logic used by the measure
... disclaimer Σ0..1markdownDisclaimer for use of the measure or its referenced content
... scoring Σ0..1CodeableConceptproportion | ratio | continuous-variable | cohort
Binding: MeasureScoring (extensible): The scoring type of the measure.

... compositeScoring Σ0..1CodeableConceptopportunity | all-or-nothing | linear | weighted
Binding: CompositeMeasureScoring (extensible): The composite scoring method of the measure.

... type Σ0..*CodeableConceptprocess | outcome | structure | patient-reported-outcome | composite
Binding: MeasureType (extensible): The type of measure (includes codes from 2.16.840.1.113883.1.11.20368).


... riskAdjustment Σ0..1stringHow risk adjustment is applied for this measure
... rateAggregation Σ0..1stringHow is rate aggregation performed for this measure
... rationale Σ0..1markdownDetailed description of why the measure exists
... clinicalRecommendationStatement Σ0..1markdownSummary of clinical guidelines
... improvementNotation Σ0..1CodeableConceptincrease | decrease
Binding: MeasureImprovementNotation (required): Observation values that indicate what change in a measurement value or score is indicative of an improvement in the measured item or scored issue.

... definition Σ0..*markdownDefined terms used in the measure documentation
... guidance Σ0..1markdownAdditional guidance for implementers
... group 0..*BackboneElementPopulation criteria group
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 0..1CodeableConceptMeaning of the group
.... description 0..1stringSummary description
.... population 0..*BackboneElementPopulation criteria
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 0..1CodeableConceptinitial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation
Binding: MeasurePopulationType (extensible): The type of population.

..... description 0..1stringThe human readable description of this population criteria
..... criteria 1..1ExpressionThe criteria that defines this population
.... stratifier 0..*BackboneElementStratifier criteria for the measure
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 0..1CodeableConceptMeaning of the stratifier
..... description 0..1stringThe human readable description of this stratifier
..... criteria 0..1ExpressionHow the measure should be stratified
..... component 0..*BackboneElementStratifier criteria component for the measure
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... code 0..1CodeableConceptMeaning of the stratifier component
...... description 0..1stringThe human readable description of this stratifier component
...... criteria 1..1ExpressionComponent of how the measure should be stratified
... supplementalData 0..*BackboneElementWhat other data should be reported with the measure
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 0..1CodeableConceptMeaning of the supplemental data
.... usage 0..*CodeableConceptsupplemental-data | risk-adjustment-factor
Binding: MeasureDataUsage (extensible): The intended usage for supplemental data elements in the measure.


.... description 0..1stringThe human readable description of this supplemental data
.... criteria 1..1ExpressionExpression describing additional data to be reported

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Measure.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Measure.statusrequiredPublicationStatus
Measure.subject[x]extensibleSubjectType
Measure.jurisdictionextensibleJurisdiction ValueSet
Measure.topicexampleDefinitionTopic
Measure.relatedArtifact.typerequiredRelatedArtifactType
Measure.scoringextensibleMeasureScoring
Measure.compositeScoringextensibleCompositeMeasureScoring
Measure.typeextensibleMeasureType
Measure.improvementNotationrequiredMeasureImprovementNotation
Measure.group.population.codeextensibleMeasurePopulationType
Measure.supplementalData.usageextensibleMeasureDataUsage

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from CRMIShareableMeasure

Summary

Mandatory: 1 element
Must-Support: 21 elements

Extensions

This structure refers to these extensions:

Maturity: 3

 

Other representations of profile: CSV, Excel, Schematron