FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: OperationDefinition/bulk-submit-data

Packagehl7.fhir.us.davinci-deqm
TypeOperationDefinition
Idbulk-submit-data
FHIR VersionR4
Sourcehttp://hl7.org/fhir/us/davinci-deqm/https://build.fhir.org/ig/HL7/davinci-deqm/OperationDefinition-bulk-submit-data.html
URLhttp://hl7.org/fhir/us/davinci-deqm/OperationDefinition/bulk-submit-data
Version5.0.0
Statusactive
Date2022-11-09T10:53:32-05:00
NameBulkSubmitData
TitleBulk Submit Data
Realmus
Authorityhl7
DescriptionThe bulk-submit-data operation sends a bulk import request based on the data requirements of a FHIR Measure. This operation is modeled off the existing draft of the [Bulk Data Import Ping and Pull Approach](https://github.com/smart-on-fhir/bulk-import/blob/master/import-pnp.md).
Typetrue
Kindoperation

Resources that use this resource

CapabilityStatement
consumer-serverConsumer Server CapabilityStatement
producer-clientProducer Client CapabilityStatement

Resources that this resource uses

No resources found


Narrative

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

URL: [base]/Measure/$bulk-submit-data

URL: [base]/Measure/[id]/$bulk-submit-data

Parameters

UseNameCardinalityTypeBindingDocumentation
INmeasureReport1..*MeasureReport

The measure report that is being submitted

INexportType0..1code

(Optional) String of static or dynamic. Defaults to dynamic if omitted.

If the value is dynamic, the Data Consumer will issue a POST request to the exportUrl to obtain a dataset from the Data Provider.

If the value is static, the Data Consumer will issue a GET request to the exportUrl to retrieve a Bulk Data manifest file with the location of the Bulk Data files.

INexportUrl1..1url

The absolute URL of the bulk export endpoint of a Data Provider (if the exportType parameter is dynamic) OR the location of a FHIR Bulk Data Export manifest file (if the exportType parameter is static)

IN_type0..*string

(Optional) Restrict the data exported to only be specific FHIR resource types. See the bulk data $export spec for more information on '_type'

INuseTypeFilters0..1boolean

(Optional) If enabled, data exported by the 'exportUrl' system will be filtered according to the data requirements of the Measure. Requires support of the _typeFilter experimental parameter in the export server. See the bulk data $export spec for more information on '_typeFilter'


Source

{
  "resourceType": "OperationDefinition",
  "id": "bulk-submit-data",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 0
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "trial-use"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "cqi"
    }
  ],
  "url": "http://hl7.org/fhir/us/davinci-deqm/OperationDefinition/bulk-submit-data",
  "version": "5.0.0",
  "name": "BulkSubmitData",
  "title": "Bulk Submit Data",
  "status": "active",
  "kind": "operation",
  "date": "2022-11-09T10:53:32-05:00",
  "publisher": "HL7 International / Clinical Quality Information",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/cqi"
        }
      ]
    }
  ],
  "description": "The bulk-submit-data operation sends a bulk import request based on the data requirements of a FHIR Measure. This operation is modeled off the existing draft of the [Bulk Data Import Ping and Pull Approach](https://github.com/smart-on-fhir/bulk-import/blob/master/import-pnp.md).",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "US"
        }
      ]
    }
  ],
  "code": "bulk-submit-data",
  "resource": [
    "Measure"
  ],
  "system": false,
  "type": true,
  "instance": true,
  "parameter": [
    {
      "name": "measureReport",
      "use": "in",
      "min": 1,
      "max": "*",
      "documentation": "The measure report that is being submitted",
      "type": "MeasureReport"
    },
    {
      "name": "exportType",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "(Optional) String of `static` or `dynamic`. Defaults to `dynamic` if omitted.\n\nIf the value is `dynamic`, the Data Consumer will issue a POST request to the `exportUrl` to obtain a dataset from the Data Provider.\n\nIf the value is `static`, the Data Consumer will issue a GET request to the `exportUrl` to retrieve a Bulk Data manifest file with the location of the Bulk Data files.",
      "type": "code"
    },
    {
      "name": "exportUrl",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "The absolute URL of the bulk export endpoint of a Data Provider (if the `exportType` parameter is `dynamic`) OR the location of a FHIR Bulk Data Export manifest file (if the `exportType` parameter is `static`)",
      "type": "url"
    },
    {
      "name": "_type",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "(Optional) Restrict the data exported to only be specific FHIR resource types. See [the bulk data $export spec](https://hl7.org/fhir/uv/bulkdata/export/index.html#query-parameters) for more information on '_type'",
      "type": "string"
    },
    {
      "name": "useTypeFilters",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "(Optional) If enabled, data exported by the 'exportUrl' system will be filtered according to the data requirements of the Measure. Requires support of the _typeFilter experimental parameter in the export server. See [the bulk data $export spec](https://hl7.org/fhir/uv/bulkdata/export/index.html#example-request-with-_typefilter) for more information on '_typeFilter'",
      "type": "boolean"
    }
  ]
}