FHIR © HL7.org  |  Server Home  |  XIG Home  |  XIG Stats  |  Server Source  |  FHIR  

FHIR IG Statistics: OperationDefinition/RegistryUpload

Packagehl7.fhir.us.registry-protocols
Resource TypeOperationDefinition
IdRegistryUpload
FHIR VersionR4
Sourcehttp://hl7.org/fhir/us/registry-protocols/https://build.fhir.org/ig/HL7/fhir-registry-protocols-ig/OperationDefinition-RegistryUpload.html
URLhttp://hl7.org/fhir/us/registry-protocols/OperationDefinition/RegistryUpload
Version1.0.0
Statusactive
Date2023-11-14T18:38:28+00:00
NameRegistryUpload
TitleThe Registry Upload of NDJSON data
Realmus
Authorityhl7
DescriptionWhen 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.
Typefalse
Kindoperation

Resources that use this resource

No resources found


Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

URL: [base]/$registryUpload

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INinput1..1Binary

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
OUToutput1..1OperationOutcome

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.


Source

{
  "resourceType": "OperationDefinition",
  "id": "RegistryUpload",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "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-14T18:38:28+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"
    }
  ]
}