National Directory of Healthcare Providers & Services (NDH) Implementation Guide
1.0.0 - STU1 United States of America flag

This page is part of the National Directory of Healthcare Providers and Services (NDH) Implementation Guide (v1.0.0: STU1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

OperationDefinition: Scheduled NDH Export Operation

Official URL: http://hl7.org/fhir/us/ndh/OperationDefinition/ndhschexport Version: 1.0.0
Standards status: Trial-use Computable Name: NdhSchExport

Scheduled NDH Export Operation

Generated Narrative: OperationDefinition ndhschexport

URL: [base]/$ndhschExport

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
IN_account1..1string

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_scheduledId1..1id

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_type0..*string

A string of comma-delimited following resource types: CareTeam,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_typeFilter0..*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_outputFormat0..1string

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_startdate0..1dateTime

This parameter is used to specify the start dateTime of the export.

IN_frequency0..1Duration

For Natioonal Directory API, only the following unit will be used d-day wk-week, mo-month, a-year.

IN_cancel0..1boolean

If you want to cancel the operation, set the value to true.

IN_keepFile0..1boolean

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.