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

Protocols for Clinical Registry Extraction and Data Submission (CREDS) IG, published by HL7 International / Clinical Interoperability Council. This is not an authorized publication; it is the continuous build for version 1.0.0. This version is based on the current content of and changes regularly. See the Directory of published versions

OperationDefinition: The Registry Upload of NDJSON data

Official URL: Version: 1.0.0
Active as of 2023-11-14 Computable Name: RegistryUpload

When the Registry periodic submission upload would exceed timeout limits or is requested as an NDJSON file, use of this Upload operation is suggested. See the FHIR Asynchronous API for more details on asynchronous FHIR exchange.

URL: [base]/$registryUpload



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

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.