R6 Ballot (1st Draft)

This page is part of the FHIR Specification v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes). The current version is 5.0.0. For a full list of available versions, see the Directory of published versions

14.18.12.7 StructureDefinition: PublishableMeasure

Clinical Quality Information icon Work Group Maturity Level: 0Trial Use Use Context: Any

The canonical URL for this profile is: 

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

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.

Note to Implementers: All of the shareable, publishable, computable, and executable profiles will be migrating to the new Canonical Resource Management icon implementation guide as part of the next FHIR release. Implementers are encouraged to look there for updates, corrections and clarifications.

This profile was published on Thu, Jan 1, 1970 00:00+1000 as a draft by HL7.

14.18.12.7.1 Formal Views of Profile Content

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

This structure is derived from ShareableMeasure.

Summary

Mandatory: 1 element
Must-Support: 22 elements

This indicates the differences between this profile and the base ShareableMeasure structure.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Measure 1..1ShareableMeasureA quality measure definition
... identifier S0..*IdentifierAdditional identifier for the measure
... date S1..1dateTimeDate last changed
... contact S0..*ContactDetailContact details for the publisher
... jurisdiction S0..*CodeableConceptIntended jurisdiction for measure (if applicable)
... purpose S0..1markdownWhy this measure is defined
... usage S0..1markdownDescribes the clinical usage of the measure
... copyright S0..1markdownUse and/or publishing restrictions
... copyrightLabel S0..1stringCopyright holder and year(s)
... approvalDate S0..1dateWhen the measure was approved by publisher
... lastReviewDate S0..1dateWhen the measure was last reviewed by the publisher
... 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 artifact is being referenced
.... resourceReference S0..1Reference(Resource)What artifact, if not a conformance resource

doco Documentation for this format icon

This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base ShareableMeasure structure.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Measure C icon1..1ShareableMeasureA 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: All Languages (required): IETF language tag for a human language

Additional BindingsPurpose
Common LanguagesStarter Set
... 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: Knowledge Capability Value Set (required)
... knowledgeRepresentationLevel S0..*codenarrative | semi-structured | structured | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel
Binding: Knowledge Representation Level (required)
... artifactComment S0..*(Complex)Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... url SΣC icon1..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
... versionAlgorithm[x] SΣ0..1How to compare versions
Binding: Version Algorithm (extensible)
.... versionAlgorithmStringstring
.... versionAlgorithmCodingCoding
... name SΣC icon0..1stringName for this measure (computer friendly)
... title SΣ1..1stringName for this measure (human friendly)
... subtitle 0..1stringSubordinate title of the measure
... status ?!Σ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: Participant Resource Types (extensible): The possible types of subjects for a measure (E.g. Patient, Practitioner, Organization, Location, etc.).

.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... basis Σ0..1codePopulation basis
Binding: All FHIR Types (required)
... date SΣ1..1dateTimeDate last changed
... publisher SΣ0..1stringName of the publisher/steward (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..1markdownDescribes the clinical usage of the measure
... copyright S0..1markdownUse and/or publishing restrictions
... copyrightLabel S0..1stringCopyright holder and year(s)
... approvalDate S0..1dateWhen the measure was approved by publisher
... lastReviewDate S0..1dateWhen the measure was last reviewed by the publisher
... 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: Definition Topic (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..1idUnique 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 | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.

.... classifier Σ0..*CodeableConceptAdditional classifiers
Binding: Citation Artifact Classifier (example): Additional classifiers for the related artifact.


.... label Σ0..1stringShort label
.... display SΣ0..1stringBrief description of the related artifact
.... citation Σ0..1markdownBibliographic citation for the artifact
.... document SΣ0..1AttachmentWhat document is being referenced
.... resource SΣ0..1canonical(Resource)What artifact is being referenced
.... resourceReference SΣ0..1Reference(Resource)What artifact, if not a conformance resource
.... publicationStatus Σ0..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): Publication status of an artifact being referred to.

.... publicationDate Σ0..1dateDate of publication of the artifact being referred to
... 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 icon (extensible): The scoring type of the measure.

... scoringUnit Σ0..1CodeableConceptWhat units?
Binding: Measure Scoring Unit (example)
... compositeScoring Σ0..1CodeableConceptopportunity | all-or-nothing | linear | weighted
Binding: Composite Measure Scoring (extensible): The composite scoring method of the measure.

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


... riskAdjustment Σ0..1markdownHow risk adjustment is applied for this measure
... rateAggregation Σ0..1markdownHow 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: Measure Improvement Notation (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.

... term 0..*BackboneElementDefined terms used in the measure documentation
.... 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..1CodeableConceptWhat term?
Binding: Measure Definition Example (example): Codeable representations of measure definition terms.

.... definition 0..1markdownMeaning of the term
... guidance Σ0..1markdownAdditional guidance for implementers (deprecated)
... group C icon0..*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
.... linkId C icon0..1stringUnique id for group in measure
.... code 0..1CodeableConceptMeaning of the group
Binding: Measure Group Example (example): Example of measure groups.

.... description 0..1markdownSummary description
.... type Σ0..*CodeableConceptprocess | outcome | structure | patient-reported-outcome | composite
Binding: Measure Type (extensible)
.... subject[x] 0..1E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Binding: Participant Resource Types (extensible): The possible types of subjects for a measure (E.g. Patient, Practitioner, Organization, Location, etc.).

..... subjectCodeableConceptCodeableConcept
..... subjectReferenceReference(Group)
.... basis Σ0..1codePopulation basis
Binding: All FHIR Types (required)
.... scoring Σ0..1CodeableConceptproportion | ratio | continuous-variable | cohort
Binding: MeasureScoring icon (extensible)
.... scoringUnit Σ0..1CodeableConceptWhat units?
Binding: Measure Scoring Unit (example)
.... rateAggregation Σ0..1markdownHow is rate aggregation performed for this measure
.... improvementNotation Σ0..1CodeableConceptincrease | decrease
Binding: Measure Improvement Notation (required)
.... library 0..*canonical(Library)Logic used by the measure group
.... 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
..... linkId C icon0..1stringUnique id for population in measure
..... code 0..1CodeableConceptinitial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation
Binding: Measure Population Type (extensible): The type of population.

..... description 0..1markdownThe human readable description of this population criteria
..... criteria 0..1ExpressionThe criteria that defines this population
..... groupDefinition 0..1Reference(Group)A group resource that defines this population
..... inputPopulationId 0..1stringWhich population
..... aggregateMethod 0..1CodeableConceptAggregation method for a measure score (e.g. sum, average, median, minimum, maximum, count)
Binding: Measure Aggregate Method (extensible)