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 in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Active as of 2023-11-14 |
@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 "RegistryUpload"] ; #
fhir:text [
fhir:status [ fhir:v "extensions" ] ;
fhir: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>"
] ; #
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"^^xsd:anyURI ] ;
fhir:value [ fhir:v "cic" ]
] ) ; #
fhir:url [ fhir:v "http://hl7.org/fhir/us/registry-protocols/OperationDefinition/RegistryUpload"^^xsd:anyURI] ; #
fhir:version [ fhir:v "1.0.0"] ; #
fhir:name [ fhir:v "RegistryUpload"] ; #
fhir:title [ fhir:v "The Registry Upload of NDJSON data"] ; #
fhir:status [ fhir:v "active"] ; #
fhir:kind [ fhir:v "operation"] ; #
fhir:date [ fhir:v "2023-11-14T18:51:51+00:00"^^xsd:dateTime] ; #
fhir:publisher [ fhir:v "HL7 International / Clinical Interoperability Council"] ; #
fhir:contact ( [
( fhir:telecom [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "http://www.hl7.org/Special/committees/cic" ] ] )
] [
( fhir:telecom [
fhir:system [ fhir:v "email" ] ;
fhir:value [ fhir:v "cic@lists.hl7.org" ] ] )
] [
fhir:name [ fhir:v "Clinical Interoperability Council" ] ;
( fhir:telecom [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "http://www.hl7.org/Special/committees/cic" ] ] )
] [
fhir:name [ fhir:v "David Pyke" ] ;
( fhir:telecom [
fhir:system [ fhir:v "email" ] ;
fhir:value [ fhir:v "mailto:David.Pyke@pointclickcare.com" ] ] )
] ) ; #
fhir:description [ fhir:v "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."] ; #
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 "registryUpload"] ; #
fhir:resource ( [ fhir:v "Binary"] ) ; #
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 "input" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v "1"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "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" ] ;
fhir:type [ fhir:v "Binary" ]
] [
fhir:name [ fhir:v "output" ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v "1"^^xsd:integer ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "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." ] ;
fhir:type [ fhir:v "OperationOutcome" ]
] ) . #
IG © 2022+ HL7 International / Clinical Interoperability Council. Package hl7.fhir.us.registry-protocols#1.0.0 based on FHIR 4.0.1. Generated 2023-11-14
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change