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

FHIR IG Statistics: OperationDefinition/GFE-submit

Packagehl7.fhir.us.davinci-pct
TypeOperationDefinition
IdGFE-submit
FHIR VersionR4
Sourcehttp://hl7.org/fhir/us/davinci-pct/https://build.fhir.org/ig/HL7/davinci-pct/OperationDefinition-GFE-submit.html
URLhttp://hl7.org/fhir/us/davinci-pct/OperationDefinition/GFE-submit
Version2.0.0-draft
Statusactive
Date2025-06-03T13:32:08+00:00
NameGFESubmit
TitleSubmit a GFE resource for the creation of an AEOB
Realmus
Authorityhl7
DescriptionThis operation is used by an entity to submit one or multiple GFEs as a Bundle containing the GFE(s) and other referenced resources for processing. The only input parameter is the single Bundle resource with one or multiple GFE(s) - each of which is based on the Claim resource (along with other referenced resources). The output is a url in the Content-Location header for subsequent polling and optionally an OperationOutcome resource per [async pattern](https://hl7.org/fhir/R5/async-bundle.html). If after polling the response is complete, then the result will either be a single Bundle with the AEOB - which is based on the ExplanationOfBenefit resource, (and other referenced resources) or an OperationOutcome resource indicating the AEOB will be sent directly to the patient.
Typetrue
Kindoperation

Resources that use this resource

CapabilityStatement
davinci-pctPatient Cost Transparency Implementation Guide Payer Capability Statement

Resources that this resource uses

No resources found


Narrative

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

Generated Narrative: OperationDefinition GFE-submit

URL: [base]/Claim/$gfe-submit

Input parameters Profile:PCT GFE Packet

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INresource1..1Bundle (PCT GFE Packet)

A Bundle containing a single or multiple GFE resources plus referenced resources.

OUTreturn0..1OperationOutcome

When successful, this will return a Bundle of type batch-submit; When there is an error calling $gfe-submit (4xx, 5xx HTTP code) then an OperationOutcome must be returned per the async pattern.


Source

{
  "resourceType": "OperationDefinition",
  "id": "GFE-submit",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "fm"
    },
    {
      "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-pct/ImplementationGuide/hl7.fhir.us.davinci-pct"
          }
        ]
      }
    }
  ],
  "url": "http://hl7.org/fhir/us/davinci-pct/OperationDefinition/GFE-submit",
  "version": "2.0.0-draft",
  "name": "GFESubmit",
  "title": "Submit a GFE resource for the creation of an AEOB",
  "status": "active",
  "kind": "operation",
  "date": "2025-06-03T13:32:08+00:00",
  "publisher": "HL7 International / Financial Management",
  "contact": [
    {
      "name": "HL7 International / Financial Management",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/fm"
        },
        {
          "system": "email",
          "value": "fmlists@lists.hl7.org"
        }
      ]
    }
  ],
  "description": "This operation is used by an entity to submit one or multiple GFEs as a Bundle containing the GFE(s) and other referenced resources for processing. The only input parameter is the single Bundle resource with one or multiple GFE(s) - each of which is based on the Claim resource (along with other referenced resources). The output is a url in the Content-Location header for subsequent polling and optionally an OperationOutcome resource per [async pattern](https://hl7.org/fhir/R5/async-bundle.html). If after polling the response is complete, then the result will either be a single Bundle with the AEOB - which is based on the ExplanationOfBenefit resource, (and other referenced resources) or an OperationOutcome resource indicating the AEOB will be sent directly to the patient.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "US"
        }
      ]
    }
  ],
  "code": "gfe-submit",
  "base": "http://hl7.org/fhir/us/davinci-pct/OperationDefinition/GFE-submit",
  "resource": [
    "Claim"
  ],
  "system": false,
  "type": true,
  "instance": false,
  "inputProfile": "http://hl7.org/fhir/us/davinci-pct/StructureDefinition/davinci-pct-gfe-packet",
  "parameter": [
    {
      "name": "resource",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "A Bundle containing a single or multiple GFE resources plus referenced resources.",
      "type": "Bundle",
      "targetProfile": [
        "http://hl7.org/fhir/us/davinci-pct/StructureDefinition/davinci-pct-gfe-packet"
      ]
    },
    {
      "name": "return",
      "use": "out",
      "min": 0,
      "max": "1",
      "documentation": "When successful, this will return a Bundle of type batch-submit; When there is an error calling $gfe-submit (4xx, 5xx HTTP code) then an OperationOutcome must be returned per the [async pattern](https://hl7.org/fhir/R5/async-bundle.html).",
      "type": "OperationOutcome"
    }
  ]
}