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 - JSON Representation

Active as of 2023-11-14

Raw json | Download


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