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

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 1.0.0-ballot 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

: Scheduled NDH Export Operation - XML Representation

Active as of 2023-05-25

Raw xml | Download


<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="ndhschexport"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition ndhschexport</b></p><a name="ndhschexport"> </a><a name="hcndhschexport"> </a><a name="ndhschexport-en-US"> </a><p>URL: [base]/$ndhschExport</p><h3>Parameters</h3><table class="grid"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>_account</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>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.</p>
</div></td></tr><tr><td>IN</td><td>_scheduledId</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#id">id</a></td><td/><td><div><p>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.</p>
</div></td></tr><tr><td>IN</td><td>_type</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>A string of comma-delimited following resource types: CareTeam,Endpoint, HealthcareService, InsurancePlan, Location, Network,
Organization, OrganizationAffiliation, Practitioner, PractitionerRole, and Verification.<br/>
The response SHALL be filtered to only include resources of the specified resource types(s).<br/>
If this parameter is omitted, the NDH server SHALL return all supported resources within the scope of the client authorization</p>
</div></td></tr><tr><td>IN</td><td>_typeFilter</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>string of comman-delimited FHIR REST search queries.<br/>
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</p>
</div></td></tr><tr><td>IN</td><td>_outputFormat</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>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</p>
</div></td></tr><tr><td>IN</td><td>_startdate</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#dateTime">dateTime</a></td><td/><td><div><p>This parameter is used to specify the start dateTime of the export.</p>
</div></td></tr><tr><td>IN</td><td>_frequency</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#Duration">Duration</a></td><td/><td><div><p>For Natioonal Directory API, only the following unit will be used d-day  wk-week, mo-month, a-year.</p>
</div></td></tr><tr><td>IN</td><td>_cancel</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#boolean">boolean</a></td><td/><td><div><p>If you want to cancel the operation, set the value to true.</p>
</div></td></tr><tr><td>IN</td><td>_keepFile</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#boolean">boolean</a></td><td/><td><div><p>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.</p>
</div></td></tr></table></div>
  </text>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="pa"/>
  </extension>
  <url value="http://hl7.org/fhir/us/ndh/OperationDefinition/ndhschexport"/>
  <version value="1.0.0-ballot"/>
  <name value="NdhSchExport"/>
  <title value="Scheduled NDH Export Operation"/>
  <status value="active"/>
  <kind value="operation"/>
  <date value="2023-05-25"/>
  <publisher value="HL7 International / Patient Administration"/>
  <contact>
    <name value="HL7 International / Patient Administration"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/pafm"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="pafm@lists.hl7.org"/>
    </telecom>
  </contact>
  <description value="Scheduled NDH Export Operation"/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
      <display value="United States of America"/>
    </coding>
  </jurisdiction>
  <code value="ndhschExport"/>
  <system value="true"/>
  <type value="false"/>
  <instance value="false"/>
  <parameter>
    <name value="_account"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="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."/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="_scheduledId"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="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."/>
    <type value="id"/>
  </parameter>
  <parameter>
    <name value="_type"/>
    <use value="in"/>
    <min value="0"/>
    <max value="*"/>
    <documentation
                   value="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"/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="_typeFilter"/>
    <use value="in"/>
    <min value="0"/>
    <max value="*"/>
    <documentation
                   value="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"/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="_outputFormat"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="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"/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="_startdate"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="This parameter is used to specify the start dateTime of the export."/>
    <type value="dateTime"/>
  </parameter>
  <parameter>
    <name value="_frequency"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="For Natioonal Directory API, only the following unit will be used d-day  wk-week, mo-month, a-year."/>
    <type value="Duration"/>
  </parameter>
  <parameter>
    <name value="_cancel"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="If you want to cancel the operation, set the value to true."/>
    <type value="boolean"/>
  </parameter>
  <parameter>
    <name value="_keepFile"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="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."/>
    <type value="boolean"/>
  </parameter>
</OperationDefinition>