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

FHIR IG Statistics: OperationDefinition/DownloadRemittance

Packagehl7.fhir.us.davinci-pr
TypeOperationDefinition
IdDownloadRemittance
FHIR VersionR4
Sourcehttp://hl7.org/fhir/us/davinci-pr/https://build.fhir.org/ig/HL7/davinci-pr/OperationDefinition-DownloadRemittance.html
URLhttp://hl7.org/fhir/us/davinci-pr/OperationDefinition/DownloadRemittance
Version1.0.0
Statusactive
Date2025-04-07T20:24:22+00:00
NameDownloadRemittance
TitleDownload Postable Remittance
Realmus
Authorityhl7
DescriptionThis operation is used to download a previously sent postable remittance.
Typefalse
Kindoperation

Resources that use this resource

CapabilityStatement
PostableRemittanceClientCapabilitiesPostable Remittance Client Capabilities
PostableRemittanceServerCapabilitiesPostable Remittance Server Capabilities

Resources that this resource uses

No resources found


Narrative

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

Generated Narrative: OperationDefinition DownloadRemittance

URL: [base]/$downloadRemittance

Input parameters Profile:Download Remittance Incoming Parameters

Output parameters Profile:Remittance Advice Document

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INRemittanceAdviceIdentifier1..1string

Remittance Advice Identifier

INRemittanceAdviceType0..1codeRemittance Advice Value Set (Required)

Advice on which file format to be returned.

OUTRemittanceAdviceDocument1..1Binary (Remittance Advice Document)

Remittance Advice file sent as a binary and compressed in a zip format.


Source

{
  "resourceType": "OperationDefinition",
  "id": "DownloadRemittance",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "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",
  "name": "DownloadRemittance",
  "title": "Download Postable Remittance",
  "status": "active",
  "kind": "operation",
  "date": "2025-04-07T20:24:22+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"
      ]
    }
  ]
}