R4 Draft for Comment

This page is part of the FHIR Specification (v3.2.0: R4 Ballot 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Operation-eligibilityrequest-submit.xml

Financial Management Work GroupMaturity Level: N/ABallot Status: InformativeCompartments: Patient, Practitioner

Raw XML (canonical form)

Jump past Narrative

Operation Definition

<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="EligibilityRequest-submit"/> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2> Submit an EligibilityRequest resource for assessment</h2> 
      <p> OPERATION: Submit an EligibilityRequest resource for assessment</p> 
      <p> The official URL for this operation definition is: </p> 
      <pre> http://hl7.org/fhir/OperationDefinition/EligibilityRequest-submit</pre> 
      <div> 
        <p> This operation is used to submit an EligibilityRequest for assessment either as a single
           EligibilityRequest resource instance or as a Bundle containing the EligibilityRequest
           and other referenced resources, or Bundle containing a batch of EligibilityRequest resources,
           either as single EligibilityRequests resources or Bundle resources, for processing. The
           only input parameter is the single EligibilityRequest or Bundle resource and the only
           output is a single EligibilityResponse, Bundle of EligibilityResponses or an OperationOutcome
           resource.</p> 

      </div> 
      <p> URL: [base]/EligibilityRequest/$submit</p> 
      <p> Parameters</p> 
      <table class="grid">
        <tr> 
          <td> 
            <b> Use</b> 
          </td> 
          <td> 
            <b> Name</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> resource</td> 
          <td> 1..1</td> 
          <td> Resource</td> 
          <td/>  
          <td> 
            <div> 
              <p> An EligibilityRequest resource or Bundle of EligibilityRequests, either as individual
                 EligibilityRequest resources or as Bundles each containing a single EligibilityRequest
                 plus referenced resources.</p> 

            </div> 
          </td> 
        </tr> 
        <tr> 
          <td> OUT</td> 
          <td> return</td> 
          <td> 1..1</td> 
          <td> Resource</td> 
          <td/>  
          <td> 
            <div> 
              <p> An EligibilityResponse resource or Bundle of EligibilityResponse responses, either as
                 individual EligibilityResponse resources or as Bundles each containing a single EligibilityResponse
                 plus referenced resources.</p> 

            </div> 
          </td> 
        </tr> 
      </table> 
      <div/>  
    </div> 
  </text> 
  <url value="http://hl7.org/fhir/OperationDefinition/EligibilityRequest-submit"/> 
  <name value="Submit an EligibilityRequest resource for assessment"/> 
  <status value="draft"/> 
  <kind value="operation"/> 
  <date value="2017-12-20T15:52:34+11:00"/> 
  <publisher value="HL7 (FHIR Project)"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
    <telecom> 
      <system value="email"/> 
      <value value="fhir@lists.hl7.org"/> 
    </telecom> 
  </contact> 
  <description value="This operation is used to submit an EligibilityRequest for assessment either as a single
   EligibilityRequest resource instance or as a Bundle containing the EligibilityRequest
   and other referenced resources, or Bundle containing a batch of EligibilityRequest resources,
   either as single EligibilityRequests resources or Bundle resources, for processing. The
   only input parameter is the single EligibilityRequest or Bundle resource and the only
   output is a single EligibilityResponse, Bundle of EligibilityResponses or an OperationOutcome
   resource."/> 
  <code value="submit"/> 
  <resource value="EligibilityRequest"/> 
  <system value="false"/> 
  <type value="true"/> 
  <instance value="false"/> 
  <parameter> 
    <name value="resource"/> 
    <use value="in"/> 
    <min value="1"/> 
    <max value="1"/> 
    <documentation value="An EligibilityRequest resource or Bundle of EligibilityRequests, either as individual
     EligibilityRequest resources or as Bundles each containing a single EligibilityRequest
     plus referenced resources."/> 
    <type value="Resource"/> 
  </parameter> 
  <parameter> 
    <name value="return"/> 
    <use value="out"/> 
    <min value="1"/> 
    <max value="1"/> 
    <documentation value="An EligibilityResponse resource or Bundle of EligibilityResponse responses, either as
     individual EligibilityResponse resources or as Bundles each containing a single EligibilityResponse
     plus referenced resources."/> 
    <type value="Resource"/> 
  </parameter> 
</OperationDefinition> 

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.