Extensions for Using Data Elements from FHIR STU3 in FHIR R4B
0.1.0 - STU
Extensions for Using Data Elements from FHIR STU3 in FHIR R4B
0.1.0 - STU
Extensions for Using Data Elements from FHIR STU3 in FHIR R4B - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/3.0/StructureDefinition/profile-Measure | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R3_Measure_R4B | ||
This cross-version profile allows STU3 Measure content to be represented via FHIR R4B Measure resources.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Measure |
C | 0..* | Measure(4.3.0) | A quality measure definition Constraints: cnl-0, mea-1 |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
   extension:contributor |
0..* | Contributor | STU3: A content contributor (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.contributor Constraints: ext-1 | |
 extension:set |
0..1 | string | STU3: The measure set, e.g. Preventive Care and Screening (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.set Constraints: ext-1 | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
 status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Measure.status | Base | required | PublicationStatus | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cnl-0 | warning | Measure | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
| dom-2 | error | Measure | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Measure | If 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Measure | If 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-5 | error | Measure | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Measure | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | Measure.implicitRules, Measure.extension, Measure.extension:contributor, Measure.extension:set, Measure.modifierExtension, Measure.status | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Measure.extension, Measure.extension:contributor, Measure.extension:set, Measure.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| mea-1 | error | Measure | Stratifier SHALL be either a single criteria or a set of criteria components |
group.stratifier.all((code | description | criteria).exists() xor component.exists())
|
This structure is derived from Measure
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Measure |
C | 0..* | Measure(4.3.0) | A quality measure definition Constraints: cnl-0, mea-1 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
 meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:meta |
0..1 | (Complex) | STU3: meta additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.meta Constraints: ext-1 | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example) | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:text |
0..1 | (Complex) | STU3: text additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.text Constraints: ext-1 | |||||
| status |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required) | |||||
| div |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
| contained |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:contributor |
0..* | Contributor | STU3: A content contributor (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.contributor Constraints: ext-1 | |||||
| extension:set |
0..1 | string | STU3: The measure set, e.g. Preventive Care and Screening (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.set Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| url |
Σ | 0..1 | uri | Canonical identifier for this measure, represented as a URI (globally unique) | ||||
| identifier |
Σ | 0..* | Identifier | Additional identifier for the measure | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:identifier |
0..* | Identifier | STU3: identifier additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.identifier Constraints: ext-1 | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
 assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| version |
Σ | 0..1 | string | Business version of the measure | ||||
| name |
ΣC | 0..1 | string | Name for this measure (computer friendly) | ||||
| title |
Σ | 0..1 | string | Name for this measure (human friendly) | ||||
| subtitle |
0..1 | string | Subordinate title of the measure | |||||
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
 subject[x] |
0..1 | E.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.). | ||||||
| subjectCodeableConcept |
CodeableConcept | |||||||
| subjectReference |
Reference(Group) | |||||||
| date |
Σ | 0..1 | dateTime | Date last changed | ||||
| publisher |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:contact |
0..* | ContactDetail | STU3: contact additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.contact Constraints: ext-1 | |||||
| name |
Σ | 0..1 | string | Name of an individual to contact | ||||
| telecom |
Σ | 0..* | ContactPoint | Contact details for individual or organization | ||||
| description |
Σ | 0..1 | markdown | Natural language description of the measure | ||||
| useContext |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:useContext |
0..* | UsageContext | STU3: Context the content is intended to support additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.useContext Constraints: ext-1 | |||||
| code |
Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible) | ||||
 value[x] |
Σ | 1..1 | Value that defines the context Binding: Context of Use ValueSet (example) | |||||
 valueCodeableConcept |
CodeableConcept | |||||||
| valueQuantity |
Quantity | |||||||
| valueRange |
Range | |||||||
| valueReference |
Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization) | |||||||
| jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction for measure (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose |
0..1 | markdown | Why this measure is defined | |||||
| usage |
0..1 | string | Describes the clinical usage of the measure | |||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| approvalDate |
0..1 | date | When the measure was approved by publisher | |||||
| lastReviewDate |
0..1 | date | When the measure was last reviewed | |||||
| effectivePeriod |
Σ | 0..1 | Period | When the measure is expected to be used | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:effectivePeriod |
0..1 | Period | STU3: effectivePeriod additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.effectivePeriod Constraints: ext-1 | |||||
| start |
ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
| end |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| topic |
0..* | CodeableConcept | The 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 |
0..* | ContactDetail | Who authored the content | |||||
| editor |
0..* | ContactDetail | Who edited the content | |||||
| reviewer |
0..* | ContactDetail | Who reviewed the content | |||||
| endorser |
0..* | ContactDetail | Who endorsed the content | |||||
| relatedArtifact |
0..* | RelatedArtifact | Additional documentation, citations, etc. | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:relatedArtifact |
0..* | RelatedArtifact | STU3: Additional documentation, citations, etc additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.relatedArtifact Constraints: ext-1 | |||||
| type |
Σ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required) | ||||
| label |
Σ | 0..1 | string | Short label | ||||
| display |
Σ | 0..1 | string | Brief description of the related artifact | ||||
| citation |
Σ | 0..1 | markdown | Bibliographic citation for the artifact | ||||
| url |
Σ | 0..1 | url | Where the artifact can be accessed | ||||
| document |
Σ | 0..1 | Attachment | What document is being referenced | ||||
| resource |
Σ | 0..1 | canonical(Resource) | What resource is being referenced | ||||
| library |
0..* | canonical(Library) | Logic used by the measure | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:library |
0..* | Reference(Cross-version Profile for STU3.Library for use in FHIR R4B(0.1.0) | Library) | STU3: library additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.library Constraints: ext-1 | |||||
| value |
0..1 | canonical | Primitive value for canonical | |||||
| disclaimer |
Σ | 0..1 | markdown | Disclaimer for use of the measure or its referenced content | ||||
| scoring |
Σ | 0..1 | CodeableConcept | proportion | ratio | continuous-variable | cohort Binding: MeasureScoring (extensible): The scoring type of the measure. | ||||
| compositeScoring |
Σ | 0..1 | CodeableConcept | opportunity | all-or-nothing | linear | weighted Binding: CompositeMeasureScoring (extensible): The composite scoring method of the measure. | ||||
| type |
Σ | 0..* | CodeableConcept | process | 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..1 | string | How risk adjustment is applied for this measure | ||||
| rateAggregation |
Σ | 0..1 | string | How is rate aggregation performed for this measure | ||||
| rationale |
Σ | 0..1 | markdown | Detailed description of why the measure exists | ||||
| clinicalRecommendationStatement |
Σ | 0..1 | markdown | Summary of clinical guidelines | ||||
| improvementNotation |
Σ | 0..1 | CodeableConcept | increase | 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. | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:improvementNotation |
0..1 | string | STU3: Improvement notation for the measure, e.g. higher score indicates better quality additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.improvementNotation Constraints: ext-1 | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| definition |
Σ | 0..* | markdown | Defined terms used in the measure documentation | ||||
| guidance |
Σ | 0..1 | markdown | Additional guidance for implementers | ||||
| group |
0..* | BackboneElement | Population criteria group | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:identifier |
1..1 | Identifier | STU3: Unique identifier (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.group.identifier Constraints: ext-1 | |||||
| extension:name |
0..1 | string | STU3: Short name (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.group.name Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| code |
0..1 | CodeableConcept | Meaning of the group Binding: MeasureGroupExample (example): Example of measure groups. | |||||
| description |
0..1 | string | Summary description | |||||
| population |
0..* | BackboneElement | Population criteria | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:identifier |
0..1 | Identifier | STU3: Unique identifier (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.group.population.identifier Constraints: ext-1 | |||||
| extension:name |
0..1 | string | STU3: Short name (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.group.population.name Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| code |
0..1 | CodeableConcept | initial-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..1 | string | The human readable description of this population criteria | |||||
| criteria |
1..1 | Expression | The criteria that defines this population | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:criteria |
1..1 | string | STU3: The name of a valid referenced CQL expression (may be namespaced) that defines this population criteria additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.group.population.criteria Constraints: ext-1 | |||||
| description |
Σ | 0..1 | string | Natural language description of the condition | ||||
| name |
Σ | 0..1 | id | Short name assigned to expression for reuse | ||||
| language |
Σ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | text/cql-identifier | text/cql-expression | etc. Binding: ExpressionLanguage (extensible)
| ||||
| expression |
Σ | 0..1 | string | Expression in specified language | ||||
| reference |
Σ | 0..1 | uri | Where the expression is found | ||||
| stratifier |
0..* | BackboneElement | Stratifier criteria for the measure | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:identifier |
0..1 | Identifier | STU3: The identifier for the stratifier used to coordinate the reported data back to this stratifier (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.group.stratifier.identifier Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| code |
0..1 | CodeableConcept | Meaning of the stratifier Binding: MeasureStratifierExample (example): Meaning of the stratifier. | |||||
| description |
0..1 | string | The human readable description of this stratifier | |||||
| criteria |
0..1 | Expression | How the measure should be stratified | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:criteria |
0..1 | string | STU3: criteria additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.group.stratifier.criteria Constraints: ext-1 | |||||
| description |
Σ | 0..1 | string | Natural language description of the condition | ||||
| name |
Σ | 0..1 | id | Short name assigned to expression for reuse | ||||
| language |
Σ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | text/cql-identifier | text/cql-expression | etc. Binding: ExpressionLanguage (extensible)
| ||||
| expression |
Σ | 0..1 | string | Expression in specified language | ||||
| reference |
Σ | 0..1 | uri | Where the expression is found | ||||
| component |
0..* | BackboneElement | Stratifier criteria component for the measure | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| code |
0..1 | CodeableConcept | Meaning of the stratifier component Binding: MeasureStratifierExample (example): Meaning of the stratifier. | |||||
| description |
0..1 | string | The human readable description of this stratifier component | |||||
| criteria |
1..1 | Expression | Component of how the measure should be stratified | |||||
| supplementalData |
0..* | BackboneElement | What other data should be reported with the measure | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:identifier |
0..1 | Identifier | STU3: Identifier, unique within the measure (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.supplementalData.identifier Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| code |
0..1 | CodeableConcept | Meaning of the supplemental data Binding: MeasureSupplementalDataExample (example): Meaning of the supplemental data. | |||||
| usage |
0..* | CodeableConcept | supplemental-data | risk-adjustment-factor Binding: MeasureDataUsage (extensible): The intended usage for supplemental data elements in the measure. | |||||
| description |
0..1 | string | The human readable description of this supplemental data | |||||
| criteria |
1..1 | Expression | Expression describing additional data to be reported | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:criteria |
0..1 | string | STU3: criteria additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.supplementalData.criteria Constraints: ext-1 | |||||
| description |
Σ | 0..1 | string | Natural language description of the condition | ||||
| name |
Σ | 0..1 | id | Short name assigned to expression for reuse | ||||
| language |
Σ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | text/cql-identifier | text/cql-expression | etc. Binding: ExpressionLanguage (extensible)
| ||||
| expression |
Σ | 0..1 | string | Expression in specified language | ||||
| reference |
Σ | 0..1 | uri | Where the expression is found | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Measure.meta.security | Base | extensible | SecurityLabels | 📍4.3.0 | FHIR Std. |
| Measure.meta.tag | Base | example | Common Tags | 📍4.3.0 | FHIR Std. |
| Measure.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| Measure.text.status | Base | required | NarrativeStatus | 📍4.3.0 | FHIR Std. |
| Measure.identifier.use | Base | required | IdentifierUse | 📍4.3.0 | FHIR Std. |
| Measure.identifier.type | Base | extensible | IdentifierType | 📍4.3.0 | FHIR Std. |
| Measure.status | Base | required | PublicationStatus | 📍4.3.0 | FHIR Std. |
| Measure.subject[x] | Base | extensible | Subject type | 📍4.3.0 | FHIR Std. |
| Measure.useContext.code | Base | extensible | UsageContextType | 📍4.3.0 | FHIR Std. |
| Measure.useContext.value[x] | Base | example | ConformanceUseContext | 📍4.3.0 | FHIR Std. |
| Measure.jurisdiction | Base | extensible | Jurisdiction | 📍4.3.0 | FHIR Std. |
| Measure.topic | Base | example | DefinitionTopic | 📍4.3.0 | FHIR Std. |
| Measure.relatedArtifact.type | Base | required | RelatedArtifactType | 📍4.3.0 | FHIR Std. |
| Measure.scoring | Base | extensible | MeasureScoring | 📍4.3.0 | FHIR Std. |
| Measure.compositeScoring | Base | extensible | CompositeMeasureScoring | 📍4.3.0 | FHIR Std. |
| Measure.type | Base | extensible | MeasureType | 📍4.3.0 | FHIR Std. |
| Measure.improvementNotation | Base | required | MeasureImprovementNotation | 📍4.3.0 | FHIR Std. |
| Measure.group.code | Base | example | MeasureGroupExample | 📍4.3.0 | FHIR Std. |
| Measure.group.population.code | Base | extensible | MeasurePopulationType | 📍4.3.0 | FHIR Std. |
| Measure.group.population.criteria.language | Base | extensible | ExpressionLanguage | 📍4.3.0 | FHIR Std. |
| Measure.group.stratifier.code | Base | example | MeasureStratifierExample | 📍4.3.0 | FHIR Std. |
| Measure.group.stratifier.criteria.language | Base | extensible | ExpressionLanguage | 📍4.3.0 | FHIR Std. |
| Measure.group.stratifier.component.code | Base | example | MeasureStratifierExample | 📍4.3.0 | FHIR Std. |
| Measure.supplementalData.code | Base | example | MeasureSupplementalDataExample | 📍4.3.0 | FHIR Std. |
| Measure.supplementalData.usage | Base | extensible | MeasureDataUsage | 📍4.3.0 | FHIR Std. |
| Measure.supplementalData.criteria.language | Base | extensible | ExpressionLanguage | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cnl-0 | warning | Measure | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
| dom-2 | error | Measure | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Measure | If 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Measure | If 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-5 | error | Measure | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Measure | A resource should have narrative for robust management |
text.`div`.exists()
|
| dom-r4b | warning | Measure.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| ele-1 | error | Measure.meta, Measure.meta.extension, Measure.meta.extension:meta, Measure.meta.versionId, Measure.meta.lastUpdated, Measure.meta.source, Measure.meta.profile, Measure.meta.security, Measure.meta.tag, Measure.implicitRules, Measure.language, Measure.text, Measure.text.extension, Measure.text.extension:text, Measure.text.status, Measure.text.div, Measure.extension, Measure.extension:contributor, Measure.extension:set, Measure.modifierExtension, Measure.url, Measure.identifier, Measure.identifier.extension, Measure.identifier.extension:identifier, Measure.identifier.use, Measure.identifier.type, Measure.identifier.system, Measure.identifier.value, Measure.identifier.period, Measure.identifier.assigner, Measure.version, Measure.name, Measure.title, Measure.subtitle, Measure.status, Measure.experimental, Measure.subject[x], Measure.date, Measure.publisher, Measure.contact, Measure.contact.extension, Measure.contact.extension:contact, Measure.contact.name, Measure.contact.telecom, Measure.description, Measure.useContext, Measure.useContext.extension, Measure.useContext.extension:useContext, Measure.useContext.code, Measure.useContext.value[x], Measure.jurisdiction, Measure.purpose, Measure.usage, Measure.copyright, Measure.approvalDate, Measure.lastReviewDate, Measure.effectivePeriod, Measure.effectivePeriod.extension, Measure.effectivePeriod.extension:effectivePeriod, Measure.effectivePeriod.start, Measure.effectivePeriod.end, Measure.topic, Measure.author, Measure.editor, Measure.reviewer, Measure.endorser, Measure.relatedArtifact, Measure.relatedArtifact.extension, Measure.relatedArtifact.extension:relatedArtifact, Measure.relatedArtifact.type, Measure.relatedArtifact.label, Measure.relatedArtifact.display, Measure.relatedArtifact.citation, Measure.relatedArtifact.url, Measure.relatedArtifact.document, Measure.relatedArtifact.resource, Measure.library, Measure.library.extension, Measure.library.extension:library, Measure.disclaimer, Measure.scoring, Measure.compositeScoring, Measure.type, Measure.riskAdjustment, Measure.rateAggregation, Measure.rationale, Measure.clinicalRecommendationStatement, Measure.improvementNotation, Measure.improvementNotation.extension, Measure.improvementNotation.extension:improvementNotation, Measure.improvementNotation.coding, Measure.improvementNotation.text, Measure.definition, Measure.guidance, Measure.group, Measure.group.extension, Measure.group.extension:identifier, Measure.group.extension:name, Measure.group.modifierExtension, Measure.group.code, Measure.group.description, Measure.group.population, Measure.group.population.extension, Measure.group.population.extension:identifier, Measure.group.population.extension:name, Measure.group.population.modifierExtension, Measure.group.population.code, Measure.group.population.description, Measure.group.population.criteria, Measure.group.population.criteria.extension, Measure.group.population.criteria.extension:criteria, Measure.group.population.criteria.description, Measure.group.population.criteria.name, Measure.group.population.criteria.language, Measure.group.population.criteria.expression, Measure.group.population.criteria.reference, Measure.group.stratifier, Measure.group.stratifier.extension, Measure.group.stratifier.extension:identifier, Measure.group.stratifier.modifierExtension, Measure.group.stratifier.code, Measure.group.stratifier.description, Measure.group.stratifier.criteria, Measure.group.stratifier.criteria.extension, Measure.group.stratifier.criteria.extension:criteria, Measure.group.stratifier.criteria.description, Measure.group.stratifier.criteria.name, Measure.group.stratifier.criteria.language, Measure.group.stratifier.criteria.expression, Measure.group.stratifier.criteria.reference, Measure.group.stratifier.component, Measure.group.stratifier.component.extension, Measure.group.stratifier.component.modifierExtension, Measure.group.stratifier.component.code, Measure.group.stratifier.component.description, Measure.group.stratifier.component.criteria, Measure.supplementalData, Measure.supplementalData.extension, Measure.supplementalData.extension:identifier, Measure.supplementalData.modifierExtension, Measure.supplementalData.code, Measure.supplementalData.usage, Measure.supplementalData.description, Measure.supplementalData.criteria, Measure.supplementalData.criteria.extension, Measure.supplementalData.criteria.extension:criteria, Measure.supplementalData.criteria.description, Measure.supplementalData.criteria.name, Measure.supplementalData.criteria.language, Measure.supplementalData.criteria.expression, Measure.supplementalData.criteria.reference | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Measure.meta.extension, Measure.meta.extension:meta, Measure.text.extension, Measure.text.extension:text, Measure.extension, Measure.extension:contributor, Measure.extension:set, Measure.modifierExtension, Measure.identifier.extension, Measure.identifier.extension:identifier, Measure.contact.extension, Measure.contact.extension:contact, Measure.useContext.extension, Measure.useContext.extension:useContext, Measure.effectivePeriod.extension, Measure.effectivePeriod.extension:effectivePeriod, Measure.relatedArtifact.extension, Measure.relatedArtifact.extension:relatedArtifact, Measure.library.extension, Measure.library.extension:library, Measure.improvementNotation.extension, Measure.improvementNotation.extension:improvementNotation, Measure.group.extension, Measure.group.extension:identifier, Measure.group.extension:name, Measure.group.modifierExtension, Measure.group.population.extension, Measure.group.population.extension:identifier, Measure.group.population.extension:name, Measure.group.population.modifierExtension, Measure.group.population.criteria.extension, Measure.group.population.criteria.extension:criteria, Measure.group.stratifier.extension, Measure.group.stratifier.extension:identifier, Measure.group.stratifier.modifierExtension, Measure.group.stratifier.criteria.extension, Measure.group.stratifier.criteria.extension:criteria, Measure.group.stratifier.component.extension, Measure.group.stratifier.component.modifierExtension, Measure.supplementalData.extension, Measure.supplementalData.extension:identifier, Measure.supplementalData.modifierExtension, Measure.supplementalData.criteria.extension, Measure.supplementalData.criteria.extension:criteria | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| mea-1 | error | Measure | Stratifier SHALL be either a single criteria or a set of criteria components |
group.stratifier.all((code | description | criteria).exists() xor component.exists())
|
| txt-1 | error | Measure.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
htmlChecks()
|
| txt-2 | error | Measure.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
This structure is derived from Measure
Summary
Mandatory: 0 element(2 nested mandatory elements)
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Measure |
C | 0..* | Measure(4.3.0) | A quality measure definition Constraints: cnl-0, mea-1 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
| extension:contributor |
0..* | Contributor | STU3: A content contributor (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.contributor Constraints: ext-1 | |
| extension:set |
0..1 | string | STU3: The measure set, e.g. Preventive Care and Screening (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.set Constraints: ext-1 | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Measure.status | Base | required | PublicationStatus | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cnl-0 | warning | Measure | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
| dom-2 | error | Measure | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Measure | If 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Measure | If 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-5 | error | Measure | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Measure | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | Measure.implicitRules, Measure.extension, Measure.extension:contributor, Measure.extension:set, Measure.modifierExtension, Measure.status | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Measure.extension, Measure.extension:contributor, Measure.extension:set, Measure.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| mea-1 | error | Measure | Stratifier SHALL be either a single criteria or a set of criteria components |
group.stratifier.all((code | description | criteria).exists() xor component.exists())
|
Differential View
This structure is derived from Measure
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Measure |
C | 0..* | Measure(4.3.0) | A quality measure definition Constraints: cnl-0, mea-1 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:meta |
0..1 | (Complex) | STU3: meta additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.meta Constraints: ext-1 | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example) | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:text |
0..1 | (Complex) | STU3: text additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.text Constraints: ext-1 | |||||
| status |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required) | |||||
| div |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
| contained |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:contributor |
0..* | Contributor | STU3: A content contributor (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.contributor Constraints: ext-1 | |||||
| extension:set |
0..1 | string | STU3: The measure set, e.g. Preventive Care and Screening (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.set Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| url |
Σ | 0..1 | uri | Canonical identifier for this measure, represented as a URI (globally unique) | ||||
| identifier |
Σ | 0..* | Identifier | Additional identifier for the measure | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:identifier |
0..* | Identifier | STU3: identifier additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.identifier Constraints: ext-1 | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| version |
Σ | 0..1 | string | Business version of the measure | ||||
| name |
ΣC | 0..1 | string | Name for this measure (computer friendly) | ||||
| title |
Σ | 0..1 | string | Name for this measure (human friendly) | ||||
| subtitle |
0..1 | string | Subordinate title of the measure | |||||
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| subject[x] |
0..1 | E.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.). | ||||||
| subjectCodeableConcept |
CodeableConcept | |||||||
| subjectReference |
Reference(Group) | |||||||
| date |
Σ | 0..1 | dateTime | Date last changed | ||||
| publisher |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:contact |
0..* | ContactDetail | STU3: contact additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.contact Constraints: ext-1 | |||||
| name |
Σ | 0..1 | string | Name of an individual to contact | ||||
| telecom |
Σ | 0..* | ContactPoint | Contact details for individual or organization | ||||
| description |
Σ | 0..1 | markdown | Natural language description of the measure | ||||
| useContext |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:useContext |
0..* | UsageContext | STU3: Context the content is intended to support additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.useContext Constraints: ext-1 | |||||
| code |
Σ | 1..1 | Coding | Type of context being specified Binding: UsageContextType (extensible) | ||||
| value[x] |
Σ | 1..1 | Value that defines the context Binding: Context of Use ValueSet (example) | |||||
| valueCodeableConcept |
CodeableConcept | |||||||
| valueQuantity |
Quantity | |||||||
| valueRange |
Range | |||||||
| valueReference |
Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization) | |||||||
| jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction for measure (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose |
0..1 | markdown | Why this measure is defined | |||||
| usage |
0..1 | string | Describes the clinical usage of the measure | |||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| approvalDate |
0..1 | date | When the measure was approved by publisher | |||||
| lastReviewDate |
0..1 | date | When the measure was last reviewed | |||||
| effectivePeriod |
Σ | 0..1 | Period | When the measure is expected to be used | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:effectivePeriod |
0..1 | Period | STU3: effectivePeriod additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.effectivePeriod Constraints: ext-1 | |||||
| start |
ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
| end |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| topic |
0..* | CodeableConcept | The 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 |
0..* | ContactDetail | Who authored the content | |||||
| editor |
0..* | ContactDetail | Who edited the content | |||||
| reviewer |
0..* | ContactDetail | Who reviewed the content | |||||
| endorser |
0..* | ContactDetail | Who endorsed the content | |||||
| relatedArtifact |
0..* | RelatedArtifact | Additional documentation, citations, etc. | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:relatedArtifact |
0..* | RelatedArtifact | STU3: Additional documentation, citations, etc additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.relatedArtifact Constraints: ext-1 | |||||
| type |
Σ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of Binding: RelatedArtifactType (required) | ||||
| label |
Σ | 0..1 | string | Short label | ||||
| display |
Σ | 0..1 | string | Brief description of the related artifact | ||||
| citation |
Σ | 0..1 | markdown | Bibliographic citation for the artifact | ||||
| url |
Σ | 0..1 | url | Where the artifact can be accessed | ||||
| document |
Σ | 0..1 | Attachment | What document is being referenced | ||||
| resource |
Σ | 0..1 | canonical(Resource) | What resource is being referenced | ||||
| library |
0..* | canonical(Library) | Logic used by the measure | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:library |
0..* | Reference(Cross-version Profile for STU3.Library for use in FHIR R4B(0.1.0) | Library) | STU3: library additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.library Constraints: ext-1 | |||||
| value |
0..1 | canonical | Primitive value for canonical | |||||
| disclaimer |
Σ | 0..1 | markdown | Disclaimer for use of the measure or its referenced content | ||||
| scoring |
Σ | 0..1 | CodeableConcept | proportion | ratio | continuous-variable | cohort Binding: MeasureScoring (extensible): The scoring type of the measure. | ||||
| compositeScoring |
Σ | 0..1 | CodeableConcept | opportunity | all-or-nothing | linear | weighted Binding: CompositeMeasureScoring (extensible): The composite scoring method of the measure. | ||||
| type |
Σ | 0..* | CodeableConcept | process | 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..1 | string | How risk adjustment is applied for this measure | ||||
| rateAggregation |
Σ | 0..1 | string | How is rate aggregation performed for this measure | ||||
| rationale |
Σ | 0..1 | markdown | Detailed description of why the measure exists | ||||
| clinicalRecommendationStatement |
Σ | 0..1 | markdown | Summary of clinical guidelines | ||||
| improvementNotation |
Σ | 0..1 | CodeableConcept | increase | 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. | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:improvementNotation |
0..1 | string | STU3: Improvement notation for the measure, e.g. higher score indicates better quality additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.improvementNotation Constraints: ext-1 | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| definition |
Σ | 0..* | markdown | Defined terms used in the measure documentation | ||||
| guidance |
Σ | 0..1 | markdown | Additional guidance for implementers | ||||
| group |
0..* | BackboneElement | Population criteria group | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:identifier |
1..1 | Identifier | STU3: Unique identifier (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.group.identifier Constraints: ext-1 | |||||
| extension:name |
0..1 | string | STU3: Short name (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.group.name Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| code |
0..1 | CodeableConcept | Meaning of the group Binding: MeasureGroupExample (example): Example of measure groups. | |||||
| description |
0..1 | string | Summary description | |||||
| population |
0..* | BackboneElement | Population criteria | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:identifier |
0..1 | Identifier | STU3: Unique identifier (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.group.population.identifier Constraints: ext-1 | |||||
| extension:name |
0..1 | string | STU3: Short name (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.group.population.name Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| code |
0..1 | CodeableConcept | initial-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..1 | string | The human readable description of this population criteria | |||||
| criteria |
1..1 | Expression | The criteria that defines this population | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:criteria |
1..1 | string | STU3: The name of a valid referenced CQL expression (may be namespaced) that defines this population criteria additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.group.population.criteria Constraints: ext-1 | |||||
| description |
Σ | 0..1 | string | Natural language description of the condition | ||||
| name |
Σ | 0..1 | id | Short name assigned to expression for reuse | ||||
| language |
Σ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | text/cql-identifier | text/cql-expression | etc. Binding: ExpressionLanguage (extensible)
| ||||
| expression |
Σ | 0..1 | string | Expression in specified language | ||||
| reference |
Σ | 0..1 | uri | Where the expression is found | ||||
| stratifier |
0..* | BackboneElement | Stratifier criteria for the measure | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:identifier |
0..1 | Identifier | STU3: The identifier for the stratifier used to coordinate the reported data back to this stratifier (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.group.stratifier.identifier Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| code |
0..1 | CodeableConcept | Meaning of the stratifier Binding: MeasureStratifierExample (example): Meaning of the stratifier. | |||||
| description |
0..1 | string | The human readable description of this stratifier | |||||
| criteria |
0..1 | Expression | How the measure should be stratified | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:criteria |
0..1 | string | STU3: criteria additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.group.stratifier.criteria Constraints: ext-1 | |||||
| description |
Σ | 0..1 | string | Natural language description of the condition | ||||
| name |
Σ | 0..1 | id | Short name assigned to expression for reuse | ||||
| language |
Σ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | text/cql-identifier | text/cql-expression | etc. Binding: ExpressionLanguage (extensible)
| ||||
| expression |
Σ | 0..1 | string | Expression in specified language | ||||
| reference |
Σ | 0..1 | uri | Where the expression is found | ||||
| component |
0..* | BackboneElement | Stratifier criteria component for the measure | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| code |
0..1 | CodeableConcept | Meaning of the stratifier component Binding: MeasureStratifierExample (example): Meaning of the stratifier. | |||||
| description |
0..1 | string | The human readable description of this stratifier component | |||||
| criteria |
1..1 | Expression | Component of how the measure should be stratified | |||||
| supplementalData |
0..* | BackboneElement | What other data should be reported with the measure | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:identifier |
0..1 | Identifier | STU3: Identifier, unique within the measure (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.supplementalData.identifier Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| code |
0..1 | CodeableConcept | Meaning of the supplemental data Binding: MeasureSupplementalDataExample (example): Meaning of the supplemental data. | |||||
| usage |
0..* | CodeableConcept | supplemental-data | risk-adjustment-factor Binding: MeasureDataUsage (extensible): The intended usage for supplemental data elements in the measure. | |||||
| description |
0..1 | string | The human readable description of this supplemental data | |||||
| criteria |
1..1 | Expression | Expression describing additional data to be reported | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:criteria |
0..1 | string | STU3: criteria additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Measure.supplementalData.criteria Constraints: ext-1 | |||||
| description |
Σ | 0..1 | string | Natural language description of the condition | ||||
| name |
Σ | 0..1 | id | Short name assigned to expression for reuse | ||||
| language |
Σ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | text/cql-identifier | text/cql-expression | etc. Binding: ExpressionLanguage (extensible)
| ||||
| expression |
Σ | 0..1 | string | Expression in specified language | ||||
| reference |
Σ | 0..1 | uri | Where the expression is found | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Measure.meta.security | Base | extensible | SecurityLabels | 📍4.3.0 | FHIR Std. |
| Measure.meta.tag | Base | example | Common Tags | 📍4.3.0 | FHIR Std. |
| Measure.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| Measure.text.status | Base | required | NarrativeStatus | 📍4.3.0 | FHIR Std. |
| Measure.identifier.use | Base | required | IdentifierUse | 📍4.3.0 | FHIR Std. |
| Measure.identifier.type | Base | extensible | IdentifierType | 📍4.3.0 | FHIR Std. |
| Measure.status | Base | required | PublicationStatus | 📍4.3.0 | FHIR Std. |
| Measure.subject[x] | Base | extensible | Subject type | 📍4.3.0 | FHIR Std. |
| Measure.useContext.code | Base | extensible | UsageContextType | 📍4.3.0 | FHIR Std. |
| Measure.useContext.value[x] | Base | example | ConformanceUseContext | 📍4.3.0 | FHIR Std. |
| Measure.jurisdiction | Base | extensible | Jurisdiction | 📍4.3.0 | FHIR Std. |
| Measure.topic | Base | example | DefinitionTopic | 📍4.3.0 | FHIR Std. |
| Measure.relatedArtifact.type | Base | required | RelatedArtifactType | 📍4.3.0 | FHIR Std. |
| Measure.scoring | Base | extensible | MeasureScoring | 📍4.3.0 | FHIR Std. |
| Measure.compositeScoring | Base | extensible | CompositeMeasureScoring | 📍4.3.0 | FHIR Std. |
| Measure.type | Base | extensible | MeasureType | 📍4.3.0 | FHIR Std. |
| Measure.improvementNotation | Base | required | MeasureImprovementNotation | 📍4.3.0 | FHIR Std. |
| Measure.group.code | Base | example | MeasureGroupExample | 📍4.3.0 | FHIR Std. |
| Measure.group.population.code | Base | extensible | MeasurePopulationType | 📍4.3.0 | FHIR Std. |
| Measure.group.population.criteria.language | Base | extensible | ExpressionLanguage | 📍4.3.0 | FHIR Std. |
| Measure.group.stratifier.code | Base | example | MeasureStratifierExample | 📍4.3.0 | FHIR Std. |
| Measure.group.stratifier.criteria.language | Base | extensible | ExpressionLanguage | 📍4.3.0 | FHIR Std. |
| Measure.group.stratifier.component.code | Base | example | MeasureStratifierExample | 📍4.3.0 | FHIR Std. |
| Measure.supplementalData.code | Base | example | MeasureSupplementalDataExample | 📍4.3.0 | FHIR Std. |
| Measure.supplementalData.usage | Base | extensible | MeasureDataUsage | 📍4.3.0 | FHIR Std. |
| Measure.supplementalData.criteria.language | Base | extensible | ExpressionLanguage | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| cnl-0 | warning | Measure | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
| dom-2 | error | Measure | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Measure | If 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Measure | If 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-5 | error | Measure | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Measure | A resource should have narrative for robust management |
text.`div`.exists()
|
| dom-r4b | warning | Measure.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems |
($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
|
| ele-1 | error | Measure.meta, Measure.meta.extension, Measure.meta.extension:meta, Measure.meta.versionId, Measure.meta.lastUpdated, Measure.meta.source, Measure.meta.profile, Measure.meta.security, Measure.meta.tag, Measure.implicitRules, Measure.language, Measure.text, Measure.text.extension, Measure.text.extension:text, Measure.text.status, Measure.text.div, Measure.extension, Measure.extension:contributor, Measure.extension:set, Measure.modifierExtension, Measure.url, Measure.identifier, Measure.identifier.extension, Measure.identifier.extension:identifier, Measure.identifier.use, Measure.identifier.type, Measure.identifier.system, Measure.identifier.value, Measure.identifier.period, Measure.identifier.assigner, Measure.version, Measure.name, Measure.title, Measure.subtitle, Measure.status, Measure.experimental, Measure.subject[x], Measure.date, Measure.publisher, Measure.contact, Measure.contact.extension, Measure.contact.extension:contact, Measure.contact.name, Measure.contact.telecom, Measure.description, Measure.useContext, Measure.useContext.extension, Measure.useContext.extension:useContext, Measure.useContext.code, Measure.useContext.value[x], Measure.jurisdiction, Measure.purpose, Measure.usage, Measure.copyright, Measure.approvalDate, Measure.lastReviewDate, Measure.effectivePeriod, Measure.effectivePeriod.extension, Measure.effectivePeriod.extension:effectivePeriod, Measure.effectivePeriod.start, Measure.effectivePeriod.end, Measure.topic, Measure.author, Measure.editor, Measure.reviewer, Measure.endorser, Measure.relatedArtifact, Measure.relatedArtifact.extension, Measure.relatedArtifact.extension:relatedArtifact, Measure.relatedArtifact.type, Measure.relatedArtifact.label, Measure.relatedArtifact.display, Measure.relatedArtifact.citation, Measure.relatedArtifact.url, Measure.relatedArtifact.document, Measure.relatedArtifact.resource, Measure.library, Measure.library.extension, Measure.library.extension:library, Measure.disclaimer, Measure.scoring, Measure.compositeScoring, Measure.type, Measure.riskAdjustment, Measure.rateAggregation, Measure.rationale, Measure.clinicalRecommendationStatement, Measure.improvementNotation, Measure.improvementNotation.extension, Measure.improvementNotation.extension:improvementNotation, Measure.improvementNotation.coding, Measure.improvementNotation.text, Measure.definition, Measure.guidance, Measure.group, Measure.group.extension, Measure.group.extension:identifier, Measure.group.extension:name, Measure.group.modifierExtension, Measure.group.code, Measure.group.description, Measure.group.population, Measure.group.population.extension, Measure.group.population.extension:identifier, Measure.group.population.extension:name, Measure.group.population.modifierExtension, Measure.group.population.code, Measure.group.population.description, Measure.group.population.criteria, Measure.group.population.criteria.extension, Measure.group.population.criteria.extension:criteria, Measure.group.population.criteria.description, Measure.group.population.criteria.name, Measure.group.population.criteria.language, Measure.group.population.criteria.expression, Measure.group.population.criteria.reference, Measure.group.stratifier, Measure.group.stratifier.extension, Measure.group.stratifier.extension:identifier, Measure.group.stratifier.modifierExtension, Measure.group.stratifier.code, Measure.group.stratifier.description, Measure.group.stratifier.criteria, Measure.group.stratifier.criteria.extension, Measure.group.stratifier.criteria.extension:criteria, Measure.group.stratifier.criteria.description, Measure.group.stratifier.criteria.name, Measure.group.stratifier.criteria.language, Measure.group.stratifier.criteria.expression, Measure.group.stratifier.criteria.reference, Measure.group.stratifier.component, Measure.group.stratifier.component.extension, Measure.group.stratifier.component.modifierExtension, Measure.group.stratifier.component.code, Measure.group.stratifier.component.description, Measure.group.stratifier.component.criteria, Measure.supplementalData, Measure.supplementalData.extension, Measure.supplementalData.extension:identifier, Measure.supplementalData.modifierExtension, Measure.supplementalData.code, Measure.supplementalData.usage, Measure.supplementalData.description, Measure.supplementalData.criteria, Measure.supplementalData.criteria.extension, Measure.supplementalData.criteria.extension:criteria, Measure.supplementalData.criteria.description, Measure.supplementalData.criteria.name, Measure.supplementalData.criteria.language, Measure.supplementalData.criteria.expression, Measure.supplementalData.criteria.reference | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Measure.meta.extension, Measure.meta.extension:meta, Measure.text.extension, Measure.text.extension:text, Measure.extension, Measure.extension:contributor, Measure.extension:set, Measure.modifierExtension, Measure.identifier.extension, Measure.identifier.extension:identifier, Measure.contact.extension, Measure.contact.extension:contact, Measure.useContext.extension, Measure.useContext.extension:useContext, Measure.effectivePeriod.extension, Measure.effectivePeriod.extension:effectivePeriod, Measure.relatedArtifact.extension, Measure.relatedArtifact.extension:relatedArtifact, Measure.library.extension, Measure.library.extension:library, Measure.improvementNotation.extension, Measure.improvementNotation.extension:improvementNotation, Measure.group.extension, Measure.group.extension:identifier, Measure.group.extension:name, Measure.group.modifierExtension, Measure.group.population.extension, Measure.group.population.extension:identifier, Measure.group.population.extension:name, Measure.group.population.modifierExtension, Measure.group.population.criteria.extension, Measure.group.population.criteria.extension:criteria, Measure.group.stratifier.extension, Measure.group.stratifier.extension:identifier, Measure.group.stratifier.modifierExtension, Measure.group.stratifier.criteria.extension, Measure.group.stratifier.criteria.extension:criteria, Measure.group.stratifier.component.extension, Measure.group.stratifier.component.modifierExtension, Measure.supplementalData.extension, Measure.supplementalData.extension:identifier, Measure.supplementalData.modifierExtension, Measure.supplementalData.criteria.extension, Measure.supplementalData.criteria.extension:criteria | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| mea-1 | error | Measure | Stratifier SHALL be either a single criteria or a set of criteria components |
group.stratifier.all((code | description | criteria).exists() xor component.exists())
|
| txt-1 | error | Measure.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
htmlChecks()
|
| txt-2 | error | Measure.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
This structure is derived from Measure
Summary
Mandatory: 0 element(2 nested mandatory elements)
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ FHIR Infrastructure. Package hl7.fhir.uv.xver-r3.r4b#0.1.0 based on FHIR 4.3.0. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
