This
page
is
part
of
the
Continuous
Integration
Build
of
FHIR
Specification
(v5.0.0:
R5
-
STU
).
This
is
the
current
published
version
in
it's
permanent
home
(it
will
always
(will
be
available
incorrect/inconsistent
at
this
URL).
For
a
full
list
of
available
versions,
see
times).
See
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
| Responsible Owner: Clinical Quality Information Work Group | Standards Status : Informative | Compartments : No defined compartments |
This is the narrative for the resource. See also the XML , JSON or Turtle format.
Note that this is the formal definition for the collect-data operation as an OperationDefinition on Measure. See the Operation documentation
Generated Narrative: OperationDefinition Measure-collect-data
URL:
[base]/Measure/[id]/$collect-data
[base]/Measure/$collect-data
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | measureUrl |
|
canonical |
|
This the the URL of a measure for which the data-of-interest will be collected. A measure URL is specified in the url element of the Measure resource. The measure URL remains the same when the measure is stored on different servers. | |
| IN | periodStart | 1..1 | date |
The
start
of
the
measurement
period.
In
keeping
with
the
semantics
of
the
date
parameter
used
in
the
FHIR
search
operation,
the
period
will
start
at
the
beginning
of
the
period
implied
by
the
supplied
timestamp.
E.g.
a
value
of
2014
would
set
the
period
|
||
| IN | periodEnd | 1..1 | date |
The end of the measurement period. The period will end at the end of the period implied by the supplied timestamp. E.g. a value of 2014 would set the period end to be 2014-12-31T23:59:59 inclusive |
||
| IN |
|
|
0..1 |
string
( reference ) |
|
|
| IN | subjectGroup | 0..1 | Group |
Subjects for which the data-of-interest for the measure will be collected, provided as a Group resource. Subjects provided in this parameter SHALL match the subjectType of the measure for which data is being collected. (e.g. if the Measure.group.subjectType is Patient, the subject SHALL be a reference to a Patient or a Group of Patients). If no subject is provided, subjects for which data is collected is up to the server. This parameter cannot be used with the subject parameter. |
||
|
| reporter | 0..1 |
string
( reference ) |
| ||
| IN | reporterResource | 0..1 |
string
( reference ) |
The
provider
for
which
the
data-of-interest
will
|
||
| IN | organizationResource |
|
Organization |
|
Organization resource for which data-of-interest for the given measure will be collected. |
|
| IN | location | 0..* |
string
( reference ) |
|
||
| IN | lastReceivedOn | 0..1 | dateTime |
The date the results of this measure were last received. This parameter used to indicate when the last time data for this measure was collected. This information is used to support incremental data collection scenarios |
||
|
|
parameters |
|
Parameters
|
Any input parameters for the evaluation. Parameters defined in this input will be made available by name to the CQL expression. Parameter types are mapped to CQL as specified in the Using CQL with FHIR implementation guide. If a parameter appears more than once in the input Parameters resource, it is represented with a List in the input CQL. If a parameter has parts, it is represented as a Tuple in the input CQL. |
||
| IN | manifest | 0..1 | canonical ( Library ) |
|
||
|
|
validateResources |
|
boolean |
|
Indicates whether data collected conform to the appropriate profiles as specified by the measure. | |
| OUT | return |
|
0..* | Bundle |
The
|
The effect of invoking this operation is to gather the data required to perform an evaluation of the measure. If the lastReceivedOn parameter is supplied, only data that is new or has been changed since the lastReceivedOn date is included in the response. Note that the resulting MeasureReport is a transient resource
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.