Protocols for Clinical Registry Extraction and Data Submission (CREDS) IG
1.0.0 - STU1 United States of America flag

This page is part of the Protocols for Clinical Registry Extraction and Data Submission (CREDS) IG (v1.0.0: STU1) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

: The Registry Upload of NDJSON data - XML Representation

Active as of 2023-11-14

Raw xml | Download



<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="RegistryUpload"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p>URL: [base]/$registryUpload</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>input</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/binary.html">Binary</a></td><td/><td><div><p>The POST will be Binary resource consisting of the contentType element listing the mime type of
application/fhir+ndjson and the data element consisting of a NDJSON file. Each line of the NDJSON file will comprising a
single patient Submission Bundle.
The http POST will have:</p>
<ol>
<li>the Prefer header set to respond-async and</li>
<li>the Accept header set to the application/fhir+ndjson format</li>
</ol>
</div></td></tr><tr><td>OUT</td><td>output</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/operationoutcome.html">OperationOutcome</a></td><td/><td><div><p>The optionally attached OperationOutcome will solely be the result of the validation that the submission file is a valid NDJSON file
and will not have information regarding the content sumbitted.
The result of a successful submission will be a 202 Accepted with the Content-Location pointing to a polling
location of the NDJSON file of OperationOutcomes.
Each OperationOutcome in the fetched NDJSON file will give the results of a validation exercise
for the individual lines within the submission file.</p>
</div></td></tr></table></div>
  </text>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="cic"/>
  </extension>
  <url
       value="http://hl7.org/fhir/us/registry-protocols/OperationDefinition/RegistryUpload"/>
  <version value="1.0.0"/>
  <name value="RegistryUpload"/>
  <title value="The Registry Upload of NDJSON data"/>
  <status value="active"/>
  <kind value="operation"/>
  <date value="2023-11-14T19:07:04+00:00"/>
  <publisher value="HL7 International / Clinical Interoperability Council"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/cic"/>
    </telecom>
  </contact>
  <contact>
    <telecom>
      <system value="email"/>
      <value value="cic@lists.hl7.org"/>
    </telecom>
  </contact>
  <contact>
    <name value="Clinical Interoperability Council"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/cic"/>
    </telecom>
  </contact>
  <contact>
    <name value="David Pyke"/>
    <telecom>
      <system value="email"/>
      <value value="mailto:David.Pyke@pointclickcare.com"/>
    </telecom>
  </contact>
  <description
               value="When the Registry periodic submission upload would exceed timeout limits or 
is requested as an [NDJSON](https://www.hl7.org/fhir/nd-json.html) file, use of this Upload operation is suggested.
 See the FHIR [Asynchronous API](https://www.hl7.org/fhir/async.html) for more details on asynchronous FHIR exchange."/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
      <display value="United States of America"/>
    </coding>
  </jurisdiction>
  <code value="registryUpload"/>
  <resource value="Binary"/>
  <system value="true"/>
  <type value="false"/>
  <instance value="false"/>
  <parameter>
    <name value="input"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="The POST will be Binary resource consisting of the contentType element listing the mime type of
  application/fhir+ndjson and the data element consisting of a NDJSON file. Each line of the NDJSON file will comprising a 
  single patient Submission Bundle.
  The http POST will have: 
  1. the Prefer header set to respond-async and 
  2. the Accept header set to the application/fhir+ndjson format"/>
    <type value="Binary"/>
  </parameter>
  <parameter>
    <name value="output"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="The optionally attached OperationOutcome will solely be the result of the validation that the submission file is a valid NDJSON file
  and will not have information regarding the content sumbitted.
  The result of a successful submission will be a 202 Accepted with the Content-Location pointing to a polling 
  location of the NDJSON file of OperationOutcomes. 
  Each OperationOutcome in the fetched NDJSON file will give the results of a validation exercise 
  for the individual lines within the submission file."/>
    <type value="OperationOutcome"/>
  </parameter>
</OperationDefinition>