This page is part of the DaVinci Postable Remittance FHIR Implementation Guide (v1.0.0-ballot: STU 1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions
Page standards status: Trial-use | Maturity Level: 1 |
<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="DownloadRemittance"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition DownloadRemittance</b></p><a name="DownloadRemittance"> </a><a name="hcDownloadRemittance"> </a><a name="DownloadRemittance-en-US"> </a><p>URL: [base]/$downloadRemittance</p><p>Input parameters Profile:<a href="StructureDefinition-downloadRemittanceParameters.html">Download Remittance Incoming Parameters</a></p><p>Output parameters Profile:<a href="StructureDefinition-remittanceAdviceDocument.html">Remittance Advice Document</a></p><h3>Parameters</h3><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>RemittanceAdviceIdentifier</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Remittance Advice Identifier</p>
</div></td></tr><tr><td>IN</td><td>RemittanceAdviceType</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#code">code</a></td><td><a href="ValueSet-RemittanceAdviceType.html">Remittance Advice Value Set</a> (Required)</td><td><div><p>Advice on which file format to be returned.</p>
</div></td></tr><tr><td>OUT</td><td>RemittanceAdviceDocument</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/binary.html">Binary</a> (<a href="StructureDefinition-remittanceAdviceDocument.html" title="http://hl7.org/fhir/us/davinci-pr/StructureDefinition/remittanceAdviceDocument">Remittance Advice Document</a>)</td><td/><td><div><p>Remittance Advice file sent as a binary and compressed in a zip format.</p>
</div></td></tr></table></div>
</text>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
<valueCode value="claims"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
<valueInteger value="1">
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
<valueCanonical
value="http://hl7.org/fhir/us/davinci-pr/ImplementationGuide/hl7.fhir.us.davinci-pr"/>
</extension>
</valueInteger>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
<valueCode value="trial-use">
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
<valueCanonical
value="http://hl7.org/fhir/us/davinci-pr/ImplementationGuide/hl7.fhir.us.davinci-pr"/>
</extension>
</valueCode>
</extension>
<url
value="http://hl7.org/fhir/us/davinci-pr/OperationDefinition/DownloadRemittance"/>
<version value="1.0.0-ballot"/>
<name value="DownloadRemittance"/>
<title value="Download Postable Remittance"/>
<status value="active"/>
<kind value="operation"/>
<date value="2024-12-16T18:43:35+00:00"/>
<publisher
value="HL7 International / Payer/Provider Information Exchange Work Group"/>
<contact>
<name
value="HL7 International / Payer/Provider Information Exchange Work Group"/>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/claims"/>
</telecom>
</contact>
<description
value="This operation is used to download a previously sent postable remittance."/>
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="US"/>
<display value="United States of America"/>
</coding>
</jurisdiction>
<code value="downloadRemittance"/>
<system value="true"/>
<type value="false"/>
<instance value="false"/>
<inputProfile
value="http://hl7.org/fhir/us/davinci-pr/StructureDefinition/downloadRemittanceParameters"/>
<outputProfile
value="http://hl7.org/fhir/us/davinci-pr/StructureDefinition/remittanceAdviceDocument"/>
<parameter>
<name value="RemittanceAdviceIdentifier"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation value="Remittance Advice Identifier"/>
<type value="string"/>
</parameter>
<parameter>
<name value="RemittanceAdviceType"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation value="Advice on which file format to be returned."/>
<type value="code"/>
<binding>
<strength value="required"/>
<valueSet
value="http://hl7.org/fhir/us/davinci-pr/ValueSet/RemittanceAdviceType"/>
</binding>
</parameter>
<parameter>
<name value="RemittanceAdviceDocument"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation
value="Remittance Advice file sent as a binary and compressed in a zip format."/>
<type value="Binary"/>
<targetProfile
value="http://hl7.org/fhir/us/davinci-pr/StructureDefinition/remittanceAdviceDocument"/>
</parameter>
</OperationDefinition>