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

• Narrative Content
• XML
• JSON
• TTL

: Download Postable Remittance - JSON Representation

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "DownloadRemittance",
  "text" : {
    "status" : "generated",
    "div" : "<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>\n</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>\n</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>\n</div></td></tr></table></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "claims"
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger" : 1,
      "_valueInteger" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/us/davinci-pr/ImplementationGuide/hl7.fhir.us.davinci-pr"
          }
        ]
      }
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode" : "trial-use",
      "_valueCode" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/us/davinci-pr/ImplementationGuide/hl7.fhir.us.davinci-pr"
          }
        ]
      }
    }
  ],
  "url" : "http://hl7.org/fhir/us/davinci-pr/OperationDefinition/DownloadRemittance",
  "version" : "1.0.0-ballot",
  "name" : "DownloadRemittance",
  "title" : "Download Postable Remittance",
  "status" : "active",
  "kind" : "operation",
  "date" : "2024-12-16T18:43:35+00:00",
  "publisher" : "HL7 International / Payer/Provider Information Exchange Work Group",
  "contact" : [
    {
      "name" : "HL7 International / Payer/Provider Information Exchange Work Group",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/claims"
        }
      ]
    }
  ],
  "description" : "This operation is used to download a previously sent postable remittance.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US",
          "display" : "United States of America"
        }
      ]
    }
  ],
  "code" : "downloadRemittance",
  "system" : true,
  "type" : false,
  "instance" : false,
  "inputProfile" : "http://hl7.org/fhir/us/davinci-pr/StructureDefinition/downloadRemittanceParameters",
  "outputProfile" : "http://hl7.org/fhir/us/davinci-pr/StructureDefinition/remittanceAdviceDocument",
  "parameter" : [
    {
      "name" : "RemittanceAdviceIdentifier",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "Remittance Advice Identifier",
      "type" : "string"
    },
    {
      "name" : "RemittanceAdviceType",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Advice on which file format to be returned.",
      "type" : "code",
      "binding" : {
        "strength" : "required",
        "valueSet" : "http://hl7.org/fhir/us/davinci-pr/ValueSet/RemittanceAdviceType"
      }
    },
    {
      "name" : "RemittanceAdviceDocument",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "Remittance Advice file sent as a binary and compressed in a zip format.",
      "type" : "Binary",
      "targetProfile" : [
        🔗 "http://hl7.org/fhir/us/davinci-pr/StructureDefinition/remittanceAdviceDocument"
      ]
    }
  ]
}