Situational Awareness for Novel Epidemic Response, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 1.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-saner/ and changes regularly. See the Directory of published versions
Draft as of 2024-05-18 |
{
"resourceType" : "OperationDefinition",
"id" : "MeasureReport-aggregate",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p>URL: [base]/MeasureReport/[id]/$aggregate</p><p>Parameters</p><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>_id</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#string\">string</a>)</td><td/><td/></tr><tr><td>IN</td><td>measure</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#uri\">uri</a>)</td><td/><td/></tr><tr><td>IN</td><td>measure-report</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/measurereport.html\">MeasureReport</a></td><td/><td><div><p>The MeasureReport resources to aggregate.</p>\n</div></td></tr><tr><td>IN</td><td>measure.title</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#string\">string</a>)</td><td/><td/></tr><tr><td>IN</td><td>period</td><td/><td>1..2</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#date\">date</a>)</td><td/><td/></tr><tr><td>IN</td><td>reporter</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#reference\">reference</a>)</td><td/><td/></tr><tr><td>IN</td><td>reporter:identifier</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#token\">token</a>)</td><td/><td/></tr><tr><td>IN</td><td>result-reporter</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#reference\">reference</a>)</td><td/><td><div><p>A reference or identifier of the reporter for the MeasureReport. May be omitted if all MeasureReport resources being aggregated have a common reporter. A server may determine the reporter based on business rules (e.g., based on the identity of the sender of the request).</p>\n</div></td></tr><tr><td>IN</td><td>result-subject</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#reference\">reference</a>)</td><td/><td><div><p>A reference or identifier of the subject for the MeasureReport. May be omitted if all MeasureReport resources being aggregated have a common subject.</p>\n</div></td></tr><tr><td>IN</td><td>subject</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#reference\">reference</a>)</td><td/><td/></tr><tr><td>IN</td><td>subject:identifier</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#token\">token</a>)</td><td/><td/></tr><tr><td>OUT</td><td>return</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/measurereport.html\">MeasureReport</a></td><td/><td><div><p>The result of the aggregation operation.</p>\n</div></td></tr></table></div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "pher"
}
],
"url" : "http://hl7.org/fhir/uv/saner/OperationDefinition/MeasureReport-aggregate",
"version" : "1.0.1",
"name" : "Aggregate",
"title" : "Aggregate",
"status" : "draft",
"kind" : "operation",
"experimental" : true,
"date" : "2024-05-18T21:25:01+00:00",
"publisher" : "HL7 International / Public Health",
"contact" : [
{
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/pher"
}
]
},
{
"telecom" : [
{
"system" : "email",
"value" : "pher@lists.hl7.org"
}
]
},
{
"name" : "Keith W. Boone",
"telecom" : [
{
"system" : "email",
"value" : "mailto:kboone@ainq.com"
}
]
}
],
"description" : "Aggregate two or more more Messure Report resources into a single MeasureReport.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001",
"display" : "World"
}
]
}
],
"code" : "aggregate",
"resource" : [
"MeasureReport"
],
"system" : false,
"type" : false,
"instance" : true,
"parameter" : [
{
"name" : "_id",
"use" : "in",
"min" : 0,
"max" : "*",
"type" : "string",
"searchType" : "string"
},
{
"name" : "measure",
"use" : "in",
"min" : 1,
"max" : "1",
"type" : "string",
"searchType" : "uri"
},
{
"name" : "measure-report",
"use" : "in",
"min" : 0,
"max" : "*",
"documentation" : "The MeasureReport resources to aggregate.",
"type" : "MeasureReport"
},
{
"name" : "measure.title",
"use" : "in",
"min" : 0,
"max" : "1",
"type" : "string",
"searchType" : "string"
},
{
"name" : "period",
"use" : "in",
"min" : 1,
"max" : "2",
"type" : "string",
"searchType" : "date"
},
{
"name" : "reporter",
"use" : "in",
"min" : 0,
"max" : "*",
"type" : "string",
"searchType" : "reference"
},
{
"name" : "reporter:identifier",
"use" : "in",
"min" : 0,
"max" : "*",
"type" : "string",
"searchType" : "token"
},
{
"name" : "result-reporter",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "A reference or identifier of the reporter for the MeasureReport. May be omitted if all MeasureReport resources being aggregated have a common reporter. A server may determine the reporter based on business rules (e.g., based on the identity of the sender of the request).",
"type" : "string",
"searchType" : "reference"
},
{
"name" : "result-subject",
"use" : "in",
"min" : 0,
"max" : "1",
"documentation" : "A reference or identifier of the subject for the MeasureReport. May be omitted if all MeasureReport resources being aggregated have a common subject.",
"type" : "string",
"searchType" : "reference"
},
{
"name" : "subject",
"use" : "in",
"min" : 0,
"max" : "*",
"type" : "string",
"searchType" : "reference"
},
{
"name" : "subject:identifier",
"use" : "in",
"min" : 0,
"max" : "*",
"type" : "string",
"searchType" : "token"
},
{
"name" : "return",
"use" : "out",
"min" : 0,
"max" : "1",
"documentation" : "The result of the aggregation operation.",
"type" : "MeasureReport"
}
]
}