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

This page is part of the National Directory of Healthcare Providers and Services (NDH) Implementation Guide (v1.0.0-ballot: STU1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

: NDH Export Operation - TTL Representation

Active as of 2023-05-25

Raw ttl | Download


@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

# - resource -------------------------------------------------------------------

 a fhir:OperationDefinition ;
  fhir:nodeRole fhir:treeRoot ;
  fhir:id [ fhir:v "ndhexport"] ; # 
  fhir:text [
fhir:status [ fhir:v "extensions" ] ;
fhir:div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p>URL: [base]/$ndhExport</p><p>Parameters</p><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>_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,\nOrganization, OrganizationAffiliation, Practitioner, PractitionerRole, and Verification.<br/>\nThe response SHALL be filtered to only include resources of the specified resource types(s).<br/>\nIf this parameter is omitted, the NDH server SHALL return all supported resources within the scope of the client authorization</p>\n</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/>\nWhen provided, a server with support for the parameter and requested search queries SHALL filter the data in the response to only\ninclude resources that meet the specified criteria</p>\n</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 ndhexport data file to be generated default to application/fhir+ndjson. The NDH server MAY\nsupport additional formats, such as application/csv</p>\n</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>\n</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#string\">string</a></td><td/><td><div><p>daily, weekly, monthly, quarterly, yearly</p>\n</div></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;\nquery the status of the request; and query the result of the request.</p>\n</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>\n</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.\nif the value is absent the server will keep the file on the server.</p>\n</div></td></tr></table></div>"
  ] ; # 
  fhir:url [ fhir:v "http://hl7.org/fhir/us/ndh/OperationDefinition/ndhexport"^^xsd:anyURI] ; # 
  fhir:version [ fhir:v "1.0.0-ballot"] ; # 
  fhir:name [ fhir:v "NdhExport"] ; # 
  fhir:title [ fhir:v "NDH Export Operation"] ; # 
  fhir:status [ fhir:v "active"] ; # 
  fhir:kind [ fhir:v "operation"] ; # 
  fhir:date [ fhir:v "2023-05-25"^^xsd:date] ; # 
  fhir:publisher [ fhir:v "HL7 International - Patient Administration Work Group"] ; # 
  fhir:contact ( [
fhir:name [ fhir:v "HL7 International - Patient Administration Work Group" ] ;
    ( fhir:telecom [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "http://hl7.org/Special/committees/pafm" ]     ] [
fhir:system [ fhir:v "email" ] ;
fhir:value [ fhir:v "pafm@lists.hl7.org" ]     ] )
  ] ) ; # 
  fhir:description [ fhir:v "NDH Query Export Operation"] ; # 
  fhir:jurisdiction ( [
    ( fhir:coding [
fhir:system [ fhir:v "urn:iso:std:iso:3166"^^xsd:anyURI ] ;
fhir:code [ fhir:v "US" ] ;
fhir:display [ fhir:v "United States of America" ]     ] )
  ] ) ; # 
  fhir:code [ fhir:v "ndhExport"] ; # 
  fhir:system [ fhir:v "true"^^xsd:boolean] ; # 
  fhir:type [ fhir:v "false"^^xsd:boolean] ; # 
  fhir:instance [ fhir:v "false"^^xsd:boolean] ; # 
  fhir:parameter ( [
fhir:name [ fhir:v "_type" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "*" ] ;
fhir:documentation [ fhir:v "A string of comma-delimited following resource types: CareTeam,Endpoint, HealthcareService, InsurancePlan, Location, Network,\nOrganization, OrganizationAffiliation, Practitioner, PractitionerRole, and Verification.  \nThe response SHALL be filtered to only include resources of the specified resource types(s).  \nIf this parameter is omitted, the NDH server SHALL return all supported resources within the scope of the client authorization" ] ;
fhir:type [ fhir:v "string" ]
  ] [
fhir:name [ fhir:v "_typeFilter" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "*" ] ;
fhir:documentation [ fhir:v "string of comman-delimited FHIR REST search queries.  \nWhen provided, a server with support for the parameter and requested search queries SHALL filter the data in the response to only \ninclude resources that meet the specified criteria" ] ;
fhir:type [ fhir:v "string" ]
  ] [
fhir:name [ fhir:v "_outputFormat" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "The format for the requested ndhexport data file to be generated default to application/fhir+ndjson. The NDH server MAY\nsupport additional formats, such as application/csv" ] ;
fhir:type [ fhir:v "string" ]
  ] [
fhir:name [ fhir:v "_startdate" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "This parameter is used to specify the start dateTime of the export." ] ;
fhir:type [ fhir:v "dateTime" ]
  ] [
fhir:name [ fhir:v "_frequency" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "daily, weekly, monthly, quarterly, yearly" ] ;
fhir:type [ fhir:v "string" ]
  ] [
fhir:name [ fhir:v "_account" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "1"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "This parameter is used to specify the user account. Will be used for cancel the request in the future; \nquery the status of the request; and query the result of the request." ] ;
fhir:type [ fhir:v "string" ]
  ] [
fhir:name [ fhir:v "_cancel" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "If you want to cancel the operation, set the value to true." ] ;
fhir:type [ fhir:v "boolean" ]
  ] [
fhir:name [ fhir:v "_keepFile" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "0"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "This parameter is used to specify whether to keep the file on the server after the file is downloaded.\nif the value is absent the server will keep the file on the server." ] ;
fhir:type [ fhir:v "boolean" ]
  ] ) . #