XIG: OperationDefinition/Measure-report-csv

FHIR IG Statistics: OperationDefinition/Measure-report-csv

Package	hl7.fhir.uv.saner
Type	OperationDefinition
Id	Measure-report-csv
FHIR Version	R4
Source	http://hl7.org/fhir/uv/saner/https://build.fhir.org/ig/HL7/fhir-saner/OperationDefinition-Measure-report-csv.html
URL	http://hl7.org/fhir/uv/saner/OperationDefinition/Measure-report-csv
Version	1.0.1
Status	draft
Date	2024-05-18T21:25:01+00:00
Name	CreateorupdateaMeasureReportfromCSVFormat
Title	Create or update a MeasureReport from CSV Format
Realm	uv
Authority	hl7
Description	Create or update a MeasureReport from the CSV Format. If a report already exists for the subject and reporter for the given time period, it is updated. Otherwise, a new report is created. See [CSV Conversion](CSV_Conversion.html) for details.
Type	false
Kind	operation

Resources that use this resource

CapabilityStatement
MeasureConsumer-CSV-Push	Measure Consumer implementing the CSV Option and the Push Option.
MeasureConsumer-ProduceMeasure-CSV-Push	Measure Consumer implementing the Produce Measure transaction with the CSV Option and the Push Option.
MeasureSource-CSV-Push	Measure Source implementing the CSV Option and the Push Option.
MeasureSource-ProduceMeasure-CSV-Push	Measure Source implementing the Produce Measure transaction with the CSV Option and the Push Option.

Resources that this resource uses

No resources found

Narrative

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

URL: [base]/Measure/[id]/$report-csv

Parameters

Use

Name

Scope

Cardinality

Type

Binding

Documentation

input

1..1

Binary

The input of the request is a CSV file with labeled columns containing the data in the report.

map

0..*

string
(composite)

Each parameter is a composite of column to measure mappings

period-end

1..1

string
(date)

The end of the reporting period.

period-start

1..1

string
(date)

The start of the reporting period.

reporter

0..1

string
(reference)

A reference or identifier of the reporter for the MeasureReport. If unspecified, the server may determine the reporter based on business rules (e.g., based on the identity of the sender).

subject

0..1

string
(reference)

A reference or identifier of the subject for the MeasureReport. If unspecified, the server may determine the subject based on business rules (e.g., based on the identity of the sender).

OUT

return

0..1

Bundle

The result of the reporting operation

Source

{
  "resourceType": "OperationDefinition",
  "id": "Measure-report-csv",
  "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/Measure-report-csv",
  "version": "1.0.1",
  "name": "CreateorupdateaMeasureReportfromCSVFormat",
  "title": "Create or update a MeasureReport from CSV Format",
  "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": "Create or update a MeasureReport from the CSV Format. If a report already exists for the subject and reporter\nfor the given time period, it is updated. Otherwise, a new report is created. See [CSV Conversion](CSV_Conversion.html) for details.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001",
          "display": "World"
        }
      ]
    }
  ],
  "code": "report-csv",
  "resource": [
    "Measure"
  ],
  "system": false,
  "type": false,
  "instance": true,
  "parameter": [
    {
      "name": "input",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "The input of the request is a CSV file with labeled columns containing the data in the report.",
      "type": "Binary"
    },
    {
      "name": "map",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "Each parameter is a composite of column to measure mappings",
      "type": "string",
      "searchType": "composite"
    },
    {
      "name": "period-end",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "The end of the reporting period.",
      "type": "string",
      "searchType": "date"
    },
    {
      "name": "period-start",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "The start of the reporting period.",
      "type": "string",
      "searchType": "date"
    },
    {
      "name": "reporter",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "A reference or identifier of the reporter for the MeasureReport. If unspecified, the server may determine the reporter based on business rules (e.g., based on the identity of the sender).",
      "type": "string",
      "searchType": "reference"
    },
    {
      "name": "subject",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "A reference or identifier of the subject for the MeasureReport. If unspecified, the server may determine the subject based on business rules (e.g., based on the identity of the sender).",
      "type": "string",
      "searchType": "reference"
    },
    {
      "name": "return",
      "use": "out",
      "min": 0,
      "max": "1",
      "documentation": "The result of the reporting operation",
      "type": "Bundle"
    }
  ]
}