National Directory of Healthcare Providers & Services (NDH) Implementation Guide
2.0.0-current - ci-build

National Directory of Healthcare Providers & Services (NDH) Implementation Guide, published by HL7 International / Patient Administration. This guide is not an authorized publication; it is the continuous build for version 2.0.0-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-us-ndh/ and changes regularly. See the Directory of published versions

## OperationDefinition: Scheduled NDH Export Operation

Official URL: http://hl7.org/fhir/us/ndh/OperationDefinition/ndhschexport | Version: 2.0.0-current
Standards status: Trial-use | Maturity Level: 4 | Computable Name: NdhSchExport

Scheduled NDH Export Operation

URL: [base]/$ndhschExport

### Parameters

Use | Name | Scope | Cardinality | Type | Binding | Documentation
IN | _account |  | 1..1 | string |  | This parameter is used to specify the user account. Will be used for cancel the request in the future; query the status of the request; and query the result of the request.
IN | _scheduledId |  | 1..1 | id |  | This parameter is used to specify the request identifier. Will be used for cancel the request in the future; query the status of the request; and query the result of the request.
IN | _type |  | 0..* | string |  | A string of comma-delimited following resource types: Endpoint, HealthcareService, InsurancePlan, Location, Network, Organization, OrganizationAffiliation, Practitioner, PractitionerRole, and Verification. The response SHALL be filtered to only include resources of the specified resource types(s). If this parameter is omitted, the NDH server SHALL return all supported resources within the scope of the client authorization
IN | _typeFilter |  | 0..* | string |  | string of comman-delimited FHIR REST search queries. When provided, a server with support for the parameter and requested search queries SHALL filter the data in the response to only include resources that meet the specified criteria
IN | _outputFormat |  | 0..1 | string |  | The format for the requested ndhschexport data file to be generated default to application/fhir+ndjson. The NDH server MAY support additional formats, such as application/csv
IN | _startdate |  | 0..1 | dateTime |  | This parameter is used to specify the start dateTime of the export.
IN | _frequency |  | 0..1 | Duration |  | For Natioonal Directory API, only the following unit will be used d-day wk-week, mo-month, a-year.
IN | _cancel |  | 0..1 | boolean |  | If you want to cancel the operation, set the value to true.
IN | _keepFile |  | 0..1 | boolean |  | This parameter is used to specify whether to keep the file on the server after the file is downloaded. if the value is absent the server will keep the file on the server.