XIG: OperationDefinition/MeasureReport-aggregate

FHIR IG Statistics: OperationDefinition/MeasureReport-aggregate

Package	hl7.fhir.uv.saner
Type	OperationDefinition
Id	MeasureReport-aggregate
FHIR Version	R4
Source	http://hl7.org/fhir/uv/saner/https://build.fhir.org/ig/HL7/fhir-saner/OperationDefinition-MeasureReport-aggregate.html
URL	http://hl7.org/fhir/uv/saner/OperationDefinition/MeasureReport-aggregate
Version	1.0.1
Status	draft
Date	2024-05-18T21:25:01+00:00
Name	Aggregate
Title	Aggregate
Realm	uv
Authority	hl7
Description	Aggregate two or more more Messure Report resources into a single MeasureReport.
Type	false
Kind	operation

Resources that use this resource

CapabilityStatement
MeasureConsumer-Aggregate	Measure Consumer implementing the Aggregate Option.
MeasureSource-Aggregate	Measure Source implementing the Aggregate Option.

Resources that this resource uses

No resources found

Narrative

Note: links and images are rebased to the (stated) source

URL: [base]/MeasureReport/[id]/$aggregate

Parameters

Use

Name

Scope

Cardinality

Type

Binding

Documentation

_id

0..*

string
(string)

measure

1..1

string
(uri)

measure-report

0..*

MeasureReport

The MeasureReport resources to aggregate.

measure.title

0..1

string
(string)

period

1..2

string
(date)

reporter

0..*

string
(reference)

reporter:identifier

0..*

string
(token)

result-reporter

0..1

string
(reference)

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).

result-subject

0..1

string
(reference)

A reference or identifier of the subject for the MeasureReport. May be omitted if all MeasureReport resources being aggregated have a common subject.

subject

0..*

string
(reference)

subject:identifier

0..*

string
(token)

OUT

return

0..1

MeasureReport

The result of the aggregation operation.

Source

{
  "resourceType": "OperationDefinition",
  "id": "MeasureReport-aggregate",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "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"
    }
  ]
}