{
"description": null,
"_filename": "OPEL-Dashboard-Metric.json",
"package_name": "notts.scr.poc",
"date": null,
"derivation": "specialization",
"publisher": null,
"fhirVersion": "3.0.2",
"name": "OPEL-Dashboard-Metric",
"mapping": [ {
"uri": "http://hl7.org/fhir/STU3",
"name": "HL7 FHIR STU3 Mapping",
"identity": "STU3"
} ],
"abstract": false,
"type": "https://fhir.nottinghamshire.gov.uk/STU3/StructureDefinition/OPEL-Dashboard-Metric",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "0.1.0",
"status": "draft",
"id": "47b2a1d9-e76e-416e-86cb-8055b4585bb1",
"kind": "logical",
"url": "https://fhir.nottinghamshire.gov.uk/STU3/StructureDefinition/OPEL-Dashboard-Metric",
"version": null,
"differential": {
"element": [ {
"id": "OPEL-Dashboard-Metric",
"max": "1",
"min": 1,
"path": "OPEL-Dashboard-Metric",
"type": [ {
"code": "Element"
} ],
"alias": [ "KPI", "Measure", "Metric" ],
"mapping": [ {
"map": "Observation",
"identity": "STU3"
} ],
"definition": "Measurements and simple assertions made about an ICS Entity's OPEL state."
}, {
"id": "OPEL-Dashboard-Metric.uniqueId",
"max": "1",
"min": 1,
"path": "OPEL-Dashboard-Metric.uniqueId",
"type": [ {
"code": "id",
"profile": "http://hl7.org/fhir/StructureDefinition/id"
} ],
"mapping": [ {
"map": "Observation.id",
"identity": "STU3"
} ],
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes."
}, {
"id": "OPEL-Dashboard-Metric.metricType",
"max": "1",
"min": 1,
"path": "OPEL-Dashboard-Metric.metricType",
"type": [ {
"code": "Coding",
"profile": "http://hl7.org/fhir/StructureDefinition/Coding"
} ],
"mapping": [ {
"map": "Observation.code",
"identity": "STU3"
} ],
"definition": "Describes what was measured. Sometimes this is called the \"metric name\".",
"requirements": "Knowing what is being measured is essential to understanding the metric."
}, {
"id": "OPEL-Dashboard-Metric.effective",
"max": "1",
"min": 1,
"path": "OPEL-Dashboard-Metric.effective",
"type": [ {
"code": "dateTime",
"profile": "http://hl7.org/fhir/StructureDefinition/dateTime"
} ],
"mapping": [ {
"map": "Observation.effectiveDateTime",
"identity": "STU3"
} ],
"definition": "The the metric value is asserted as being true.",
"requirements": "Knowing when a metric was deemed true is important to its relevance as well as determining trends"
}, {
"path": "OPEL-Dashboard-Metric.icsEntity",
"requirements": "Metrics have no value if you don't know who or what they're about",
"min": 1,
"definition": "ICS Entity whose OPEL characteristics (direct or indirect) are described by the metric and into whose record the metric is placed",
"mapping": [ {
"map": "Observation.subject",
"identity": "STU3"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "https://fhir.nottinghamshire.gov.uk/STU3/StructureDefinition/ICS-Entity"
} ],
"alias": [ "ICS Partner", "ICS Organisation" ],
"max": "1",
"id": "OPEL-Dashboard-Metric.icsEntity"
}, {
"path": "OPEL-Dashboard-Metric.metricValue[x]",
"min": 0,
"definition": "The information determined as a result of making the measurement, if the information has a actual value",
"mapping": [ {
"map": "Observation.value[x]",
"identity": "STU3"
} ],
"type": [ {
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/Quantity"
}, {
"code": "CodeableConcept",
"profile": "http://hl7.org/fhir/StructureDefinition/CodeableConcept"
} ],
"meaningWhenMissing": "The metricValue should only be missing where it is identical to the opelRating",
"max": "1",
"id": "OPEL-Dashboard-Metric.metricValue[x]",
"comment": "Normally, an OPEL-Dashboard-Metric will have either a single metricValue, however it can be omitted if it is the same as the opelRating. This element has a variable name depending on the type as follows: metricValueQuantity, metricValueCodeableConcept,"
}, {
"path": "OPEL-Dashboard-Metric.opelRating",
"requirements": "For some results, particularly numeric results, the opelRating is necessary to fully understand the significance of a result.",
"min": 1,
"definition": "The OPEL Rating of the metric, this could be assigned manually using local knowledge or defined by referrence to the metricValue (e.g. OPEL-1 if metricValueQuantity < 10)",
"short": "OPEL-1 | OPEL-2 | OPEL-3 | OPEL-4",
"mapping": [ {
"map": "Observation.interpretation",
"identity": "STU3"
} ],
"type": [ {
"code": "code",
"profile": "http://hl7.org/fhir/StructureDefinition/code"
} ],
"binding": {
"strength": "required",
"valueSetUri": "https://fhir.nottinghamshire.gov.uk/STU3/valueset/Notts-OPEL-Score"
},
"max": "1",
"id": "OPEL-Dashboard-Metric.opelRating",
"comment": "The assessment made based on the result of the metric measurement. Intended as a simple compact code often placed adjacent to the result value in a dashboard to signal the meaning/normalcy status of the result."
}, {
"id": "OPEL-Dashboard-Metric.opelGuidance",
"max": "1",
"min": 0,
"path": "OPEL-Dashboard-Metric.opelGuidance",
"type": [ {
"code": "string",
"profile": "http://hl7.org/fhir/StructureDefinition/string"
} ],
"mapping": [ {
"map": "Observation.referenceRange.text",
"identity": "STU3"
} ],
"definition": "Text based description defining the importance of that type of metric with regards to the ICS Entity, and how the OPEL Rating is determined/related to the actual metric value"
}, {
"id": "OPEL-Dashboard-Metric.comment",
"max": "*",
"min": 0,
"path": "OPEL-Dashboard-Metric.comment",
"type": [ {
"code": "string",
"profile": "http://hl7.org/fhir/StructureDefinition/string"
} ],
"mapping": [ {
"map": "Observation.comment",
"identity": "STU3"
} ],
"definition": "Free text commentary on the specific instance of the value measured",
"requirements": "The comment differs from the opelGuidance in that it relates the specifc meaurement at that time, whereas the guidance is general commentary as to the significance of that measuremnt type (and how the values will be used to determine the OPEL Score)"
}, {
"id": "OPEL-Dashboard-Metric.relatedMetric",
"max": "*",
"min": 0,
"path": "OPEL-Dashboard-Metric.relatedMetric",
"type": [ {
"code": "BackboneElement"
} ],
"mapping": [ {
"map": "Observation.related",
"identity": "STU3"
} ],
"definition": "A reference to another OPEL-Dashboard-Metric whose relationship is defined by the relationship type code",
"requirements": "relatedMetric is used for any supporting result that can be interpreted and used on its own. This structure permits nested grouping, e.g. where a metric value is derived from or inferred by subsidiary metrics"
}, {
"path": "OPEL-Dashboard-Metric.relatedMetric.type",
"requirements": "A relationship type SHOULD be provided.",
"min": 0,
"definition": "A code specifying the kind of relationship that exists with the target resource.",
"short": "derived-from | qualified-by | interfered-by +",
"type": [ {
"code": "code",
"profile": "http://hl7.org/fhir/StructureDefinition/code"
} ],
"binding": {
"strength": "required",
"valueSetUri": "http://hl7.org/fhir/ValueSet/observation-relationshiptypes"
},
"max": "*",
"id": "OPEL-Dashboard-Metric.relatedMetric.type"
}, {
"id": "OPEL-Dashboard-Metric.relatedMetric.target",
"max": "1",
"min": 1,
"path": "OPEL-Dashboard-Metric.relatedMetric.target",
"type": [ {
"code": "Reference",
"targetProfile": "https://fhir.nottinghamshire.gov.uk/STU3/StructureDefinition/OPEL-Dashboard-Metric"
} ],
"definition": "A reference to another OPEL-Dashboard-Metric"
} ]
},
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element"
}