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

FHIR IG Statistics: OperationDefinition/Claim-inquiry

Packagehl7.fhir.us.davinci-pas
TypeOperationDefinition
IdClaim-inquiry
FHIR VersionR4
Sourcehttp://hl7.org/fhir/us/davinci-pas/https://build.fhir.org/ig/HL7/davinci-pas/OperationDefinition-Claim-inquiry.html
URLhttp://hl7.org/fhir/us/davinci-pas/OperationDefinition/Claim-inquiry
Version2.2.0-ballot
Statusdraft
Date2025-07-22T15:36:40+00:00
NameClaimInquiry
TitleSearch for a Prior Authorization Response by example
Realmus
Authorityhl7
DescriptionThis operation is used to make a search for a Prior Authorization Response by example. This Prior Authorization $inquire operation is a query-by-example that follows the X12 278 Inquiry rules. The only input parameter is the single Bundle resource with a PASClaimInquiry instance (along with other referenced resources) and the only output is a single Bundle with zero-to-many PASClaimInquiryResponses (and other referenced resources) or an OperationOutcome resource.
Typetrue
Kindoperation

Resources that use this resource

CapabilityStatement
EHRCapabilitiesEHR PAS Capabilities
IntermediaryCapabilitiesIntermediary PAS Capabilities

Resources that this resource uses

No resources found


Narrative

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

Generated Narrative: OperationDefinition Claim-inquiry

URL: [base]/Claim/$inquire

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INresource1..1Bundle (PAS Inquiry Request Bundle)

A Bundle containing a single ClaimInquiry plus referenced resources.

OUTreturn1..1Bundle (PAS Inquiry Response Bundle)

A Bundle containing a single ClaimInquiryResponse plus referenced resources.


Source

{
  "resourceType": "OperationDefinition",
  "id": "Claim-inquiry",
  "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-fmm",
      "valueInteger": 3,
      "_valueInteger": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/us/davinci-pas/ImplementationGuide/hl7.fhir.us.davinci-pas"
          }
        ]
      }
    },
    {
      "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-pas/ImplementationGuide/hl7.fhir.us.davinci-pas"
          }
        ]
      }
    }
  ],
  "url": "http://hl7.org/fhir/us/davinci-pas/OperationDefinition/Claim-inquiry",
  "version": "2.2.0-ballot",
  "name": "ClaimInquiry",
  "title": "Search for a Prior Authorization Response by example",
  "status": "draft",
  "kind": "operation",
  "date": "2025-07-22T15:36:40+00:00",
  "publisher": "HL7 International / Financial Management",
  "contact": [
    {
      "name": "HL7 International / Financial Management",
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/Special/committees/fm"
        },
        {
          "system": "email",
          "value": "fmlists@lists.hl7.org"
        }
      ]
    },
    {
      "name": "Jean Duteau",
      "telecom": [
        {
          "system": "email",
          "value": "mailto:jean@duteaudesign.com"
        }
      ]
    },
    {
      "name": "HL7 International / Financial Management",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/fm"
        }
      ]
    }
  ],
  "description": "This operation is used to make a search for a Prior Authorization Response by example.  This Prior Authorization $inquire operation is a query-by-example that follows the X12 278 Inquiry rules.  The only input parameter is the single Bundle resource with a PASClaimInquiry instance (along with other referenced resources) and the only output is a single Bundle with zero-to-many PASClaimInquiryResponses (and other referenced resources) or an OperationOutcome resource.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "US",
          "display": "United States of America"
        }
      ]
    }
  ],
  "code": "inquire",
  "base": "http://hl7.org/fhir/OperationDefinition/Claim-submit",
  "resource": [
    "Claim"
  ],
  "system": false,
  "type": true,
  "instance": false,
  "parameter": [
    {
      "name": "resource",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "A Bundle containing a single ClaimInquiry plus referenced resources.",
      "type": "Bundle",
      "targetProfile": [
        "http://hl7.org/fhir/us/davinci-pas/StructureDefinition/profile-pas-inquiry-request-bundle"
      ]
    },
    {
      "name": "return",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "A Bundle containing a single ClaimInquiryResponse plus referenced resources.",
      "type": "Bundle",
      "targetProfile": [
        "http://hl7.org/fhir/us/davinci-pas/StructureDefinition/profile-pas-inquiry-response-bundle"
      ]
    }
  ]
}