This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4
Clinical Quality Information Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Patient |
This is a representation of the json schema for MeasureReport, which is just a part of the full JSON Schema.
{ "$schema": "http://json-schema.org/draft-06/schema#", "id": "http://hl7.org/fhir/json-schema/MeasureReport", "$ref": "#/definitions/MeasureReport", "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas", "definitions": { "MeasureReport": { "description": "The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.", "properties": { "resourceType": { "description": "This is a MeasureReport resource", "const": "MeasureReport" }, "id": { "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "$ref": "id.schema.json#/definitions/id" }, "meta": { "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", "$ref": "Meta.schema.json#/definitions/Meta" }, "implicitRules": { "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", "$ref": "#/definitions/uri" }, "_implicitRules": { "description": "Extensions for implicitRules", "$ref": "Element.schema.json#/definitions/Element" }, "language": { "description": "The base language in which the resource is written.", "$ref": "#/definitions/code" }, "_language": { "description": "Extensions for language", "$ref": "Element.schema.json#/definitions/Element" }, "text": { "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", "$ref": "Narrative.schema.json#/definitions/Narrative" }, "contained": { "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.", "items": { "$ref": "ResourceList.schema.json#/definitions/ResourceList" }, "type": "array" }, "extension": { "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "items": { "$ref": "Extension.schema.json#/definitions/Extension" }, "type": "array" }, "modifierExtension": { "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "items": { "$ref": "Extension.schema.json#/definitions/Extension" }, "type": "array" }, "identifier": { "description": "A formal identifier that is used to identify this MeasureReport when it is represented in other formats or referenced in a specification, model, design or an instance.", "items": { "$ref": "Identifier.schema.json#/definitions/Identifier" }, "type": "array" }, "status": { "description": "The MeasureReport status. No data will be available until the MeasureReport status is complete.", "$ref": "#/definitions/code" }, "_status": { "description": "Extensions for status", "$ref": "Element.schema.json#/definitions/Element" }, "type": { "description": "The type of measure report. This may be an individual report, which provides the score for the measure for an individual member of the population; a subject-listing, which returns the list of members that meet the various criteria in the measure; a summary report, which returns a population count for each of the criteria in the measure; or a data-collection, which enables the MeasureReport to be used to exchange the data-of-interest for a quality measure.", "$ref": "#/definitions/code" }, "_type": { "description": "Extensions for type", "$ref": "Element.schema.json#/definitions/Element" }, "dataUpdateType": { "description": "Indicates whether the data submitted in an data-exchange report represents a snapshot or incremental update. A snapshot update replaces all previously submitted data for the receiver, whereas an incremental update represents only updated and/or changed data and should be applied as a differential update to the existing submitted data for the receiver.", "$ref": "#/definitions/code" }, "_dataUpdateType": { "description": "Extensions for dataUpdateType", "$ref": "Element.schema.json#/definitions/Element" }, "measure": { "description": "A reference to the Measure that was calculated to produce this report.", "$ref": "canonical.schema.json#/definitions/canonical" }, "subject": { "description": "Optional subject identifying the individual or individuals the report is for.", "$ref": "Reference.schema.json#/definitions/Reference" }, "date": { "description": "The date this measure report was generated.", "$ref": "#/definitions/dateTime" }, "_date": { "description": "Extensions for date", "$ref": "Element.schema.json#/definitions/Element" }, "reporter": { "description": "The individual or organization that is reporting the data.", "$ref": "Reference.schema.json#/definitions/Reference" }, "reportingVendor": { "description": "A reference to the vendor who queried the data, calculated results and/or generated the report. The ‘reporting vendor’ is intended to represent the submitting entity when it is not the same as the reporting entity. This extension is used when the Receiver is interested in getting vendor information in the report.", "$ref": "Reference.schema.json#/definitions/Reference" }, "location": { "description": "A reference to the location for which the data is being reported.", "$ref": "Reference.schema.json#/definitions/Reference" }, "period": { "description": "The reporting period for which the report was calculated.", "$ref": "Period.schema.json#/definitions/Period" }, "inputParameters": { "description": "A reference to a Parameters resource (typically represented using a contained resource) that represents any input parameters that were provided to the operation that generated the report.", "$ref": "Reference.schema.json#/definitions/Reference" }, "scoring": { "description": "Indicates how the calculation is performed for the measure, including proportion, ratio, continuous-variable, and cohort. The value set is extensible, allowing additional measure scoring types to be represented. It is expected to be the same as the scoring element on the referenced Measure.", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "improvementNotation": { "description": "Whether improvement in the measure is noted by an increase or decrease in the measure score.", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "group": { "description": "The results of the calculation, one for each population group in the measure.", "items": { "$ref": "#/definitions/MeasureReport_Group" }, "type": "array" }, "evaluatedResource": { "description": "A reference to a Resource that was used in the calculation of this measure.", "items": { "$ref": "Reference.schema.json#/definitions/Reference" }, "type": "array" } }, "type": "object", "additionalProperties": false, "required": [ "period", "resourceType" ] }, "MeasureReport_Group": { "description": "The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.", "properties": { "id": { "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "$ref": "string.schema.json#/definitions/string" }, "extension": { "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "items": { "$ref": "Extension.schema.json#/definitions/Extension" }, "type": "array" }, "modifierExtension": { "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "items": { "$ref": "Extension.schema.json#/definitions/Extension" }, "type": "array" }, "code": { "description": "The meaning of the population group as defined in the measure definition.", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "population": { "description": "The populations that make up the population group, one for each type of population appropriate for the measure.", "items": { "$ref": "#/definitions/MeasureReport_Population" }, "type": "array" }, "measureScoreQuantity": { "description": "The measure score for this population group, calculated as appropriate for the measure type and scoring method, and based on the contents of the populations defined in the group.", "$ref": "Quantity.schema.json#/definitions/Quantity" }, "measureScoreDateTime": { "description": "The measure score for this population group, calculated as appropriate for the measure type and scoring method, and based on the contents of the populations defined in the group.", "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?$", "type": "string" }, "_measureScoreDateTime": { "description": "Extensions for measureScoreDateTime", "$ref": "Element.schema.json#/definitions/Element" }, "measureScoreCodeableConcept": { "description": "The measure score for this population group, calculated as appropriate for the measure type and scoring method, and based on the contents of the populations defined in the group.", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "measureScorePeriod": { "description": "The measure score for this population group, calculated as appropriate for the measure type and scoring method, and based on the contents of the populations defined in the group.", "$ref": "Period.schema.json#/definitions/Period" }, "measureScoreRange": { "description": "The measure score for this population group, calculated as appropriate for the measure type and scoring method, and based on the contents of the populations defined in the group.", "$ref": "Range.schema.json#/definitions/Range" }, "measureScoreDuration": { "description": "The measure score for this population group, calculated as appropriate for the measure type and scoring method, and based on the contents of the populations defined in the group.", "$ref": "Duration.schema.json#/definitions/Duration" }, "stratifier": { "description": "When a measure includes multiple stratifiers, there will be a stratifier group for each stratifier defined by the measure.", "items": { "$ref": "#/definitions/MeasureReport_Stratifier" }, "type": "array" } }, "type": "object", "additionalProperties": false }, "MeasureReport_Population": { "description": "The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.", "properties": { "id": { "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "$ref": "string.schema.json#/definitions/string" }, "extension": { "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "items": { "$ref": "Extension.schema.json#/definitions/Extension" }, "type": "array" }, "modifierExtension": { "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "items": { "$ref": "Extension.schema.json#/definitions/Extension" }, "type": "array" }, "code": { "description": "The type of the population.", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "count": { "description": "The number of members of the population.", "$ref": "#/definitions/integer" }, "_count": { "description": "Extensions for count", "$ref": "Element.schema.json#/definitions/Element" }, "subjectResults": { "description": "This element refers to a List of subject level MeasureReport resources, one for each subject in this population.", "$ref": "Reference.schema.json#/definitions/Reference" } }, "type": "object", "additionalProperties": false }, "MeasureReport_Stratifier": { "description": "The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.", "properties": { "id": { "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "$ref": "string.schema.json#/definitions/string" }, "extension": { "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "items": { "$ref": "Extension.schema.json#/definitions/Extension" }, "type": "array" }, "modifierExtension": { "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "items": { "$ref": "Extension.schema.json#/definitions/Extension" }, "type": "array" }, "code": { "description": "The meaning of this stratifier, as defined in the measure definition.", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "stratum": { "description": "This element contains the results for a single stratum within the stratifier. For example, when stratifying on administrative gender, there will be four strata, one for each possible gender value.", "items": { "$ref": "#/definitions/MeasureReport_Stratum" }, "type": "array" } }, "type": "object", "additionalProperties": false }, "MeasureReport_Stratum": { "description": "The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.", "properties": { "id": { "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "$ref": "string.schema.json#/definitions/string" }, "extension": { "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "items": { "$ref": "Extension.schema.json#/definitions/Extension" }, "type": "array" }, "modifierExtension": { "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "items": { "$ref": "Extension.schema.json#/definitions/Extension" }, "type": "array" }, "valueCodeableConcept": { "description": "The value for this stratum, expressed as a CodeableConcept. When defining stratifiers on complex values, the value must be rendered such that the value for each stratum within the stratifier is unique.", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "valueBoolean": { "description": "The value for this stratum, expressed as a CodeableConcept. When defining stratifiers on complex values, the value must be rendered such that the value for each stratum within the stratifier is unique.", "pattern": "^true|false$", "type": "boolean" }, "_valueBoolean": { "description": "Extensions for valueBoolean", "$ref": "Element.schema.json#/definitions/Element" }, "valueQuantity": { "description": "The value for this stratum, expressed as a CodeableConcept. When defining stratifiers on complex values, the value must be rendered such that the value for each stratum within the stratifier is unique.", "$ref": "Quantity.schema.json#/definitions/Quantity" }, "valueRange": { "description": "The value for this stratum, expressed as a CodeableConcept. When defining stratifiers on complex values, the value must be rendered such that the value for each stratum within the stratifier is unique.", "$ref": "Range.schema.json#/definitions/Range" }, "valueReference": { "description": "The value for this stratum, expressed as a CodeableConcept. When defining stratifiers on complex values, the value must be rendered such that the value for each stratum within the stratifier is unique.", "$ref": "Reference.schema.json#/definitions/Reference" }, "component": { "description": "A stratifier component value.", "items": { "$ref": "#/definitions/MeasureReport_Component" }, "type": "array" }, "population": { "description": "The populations that make up the stratum, one for each type of population appropriate to the measure.", "items": { "$ref": "#/definitions/MeasureReport_Population1" }, "type": "array" }, "measureScoreQuantity": { "description": "The measure score for this stratum, calculated as appropriate for the measure type and scoring method, and based on only the members of this stratum.", "$ref": "Quantity.schema.json#/definitions/Quantity" }, "measureScoreDateTime": { "description": "The measure score for this stratum, calculated as appropriate for the measure type and scoring method, and based on only the members of this stratum.", "pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?$", "type": "string" }, "_measureScoreDateTime": { "description": "Extensions for measureScoreDateTime", "$ref": "Element.schema.json#/definitions/Element" }, "measureScoreCodeableConcept": { "description": "The measure score for this stratum, calculated as appropriate for the measure type and scoring method, and based on only the members of this stratum.", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "measureScorePeriod": { "description": "The measure score for this stratum, calculated as appropriate for the measure type and scoring method, and based on only the members of this stratum.", "$ref": "Period.schema.json#/definitions/Period" }, "measureScoreRange": { "description": "The measure score for this stratum, calculated as appropriate for the measure type and scoring method, and based on only the members of this stratum.", "$ref": "Range.schema.json#/definitions/Range" }, "measureScoreDuration": { "description": "The measure score for this stratum, calculated as appropriate for the measure type and scoring method, and based on only the members of this stratum.", "$ref": "Duration.schema.json#/definitions/Duration" } }, "type": "object", "additionalProperties": false }, "MeasureReport_Component": { "description": "The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.", "properties": { "id": { "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "$ref": "string.schema.json#/definitions/string" }, "extension": { "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "items": { "$ref": "Extension.schema.json#/definitions/Extension" }, "type": "array" }, "modifierExtension": { "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "items": { "$ref": "Extension.schema.json#/definitions/Extension" }, "type": "array" }, "code": { "description": "The code for the stratum component value.", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "valueCodeableConcept": { "description": "The stratum component value.", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "valueBoolean": { "description": "The stratum component value.", "pattern": "^true|false$", "type": "boolean" }, "_valueBoolean": { "description": "Extensions for valueBoolean", "$ref": "Element.schema.json#/definitions/Element" }, "valueQuantity": { "description": "The stratum component value.", "$ref": "Quantity.schema.json#/definitions/Quantity" }, "valueRange": { "description": "The stratum component value.", "$ref": "Range.schema.json#/definitions/Range" }, "valueReference": { "description": "The stratum component value.", "$ref": "Reference.schema.json#/definitions/Reference" } }, "type": "object", "additionalProperties": false, "required": [ "code" ] }, "MeasureReport_Population1": { "description": "The MeasureReport resource contains the results of the calculation of a measure; and optionally a reference to the resources involved in that calculation.", "properties": { "id": { "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "$ref": "string.schema.json#/definitions/string" }, "extension": { "description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "items": { "$ref": "Extension.schema.json#/definitions/Extension" }, "type": "array" }, "modifierExtension": { "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "items": { "$ref": "Extension.schema.json#/definitions/Extension" }, "type": "array" }, "code": { "description": "The type of the population.", "$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept" }, "count": { "description": "The number of members of the population in this stratum.", "$ref": "#/definitions/integer" }, "_count": { "description": "Extensions for count", "$ref": "Element.schema.json#/definitions/Element" }, "subjectResults": { "description": "This element refers to a List of subject level MeasureReport resources, one for each subject in this population in this stratum.", "$ref": "Reference.schema.json#/definitions/Reference" } }, "type": "object", "additionalProperties": false } } }