HL7 FHIR Implementation Guide: Military Service History and Status Release 1 - US Realm | STU1 Ballot
0.1.0 - STU1 Ballot

This page is part of the HL7 FHIR Implementation Guide for Military Service History and Status (v0.1.0: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

: Veteran Status Verification and Confirmation - Operation - XML Representation

Raw xml | Download



<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="VeteranStatus"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><h2>VeteranStatus</h2><p>QUERY: VeteranStatus</p><p>The official URL for this operation definition is: </p><pre>http://hl7.org/fhir/us/military-service/OperationDefinition/VeteranStatus</pre><div><p>The Veteran Status Operation returns 'true' or 'false' based on the known veteran status of the patient.  The API should be used as part of use cases needing general veteran status and not neccesarily be used as part of eligibilty.</p>
</div><p>URL: [base]/$veteranStatus</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>firstName</td><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td/></tr><tr><td>IN</td><td>last</td><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td/></tr><tr><td>IN</td><td>middleName</td><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td/></tr><tr><td>IN</td><td>veteranSSN</td><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#Identifier">Identifier</a></td><td/><td/></tr><tr><td>IN</td><td>dateOfBirth</td><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#date">date</a></td><td/><td/></tr><tr><td>IN</td><td>gender</td><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#code">code</a></td><td/><td/></tr><tr><td>OUT</td><td>veterandateStatus</td><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#boolean">boolean</a></td><td/><td/></tr></table></div>
  </text>
  <url
       value="http://hl7.org/fhir/us/military-service/OperationDefinition/VeteranStatus"/>
  <version value="0.1.0"/>
  <name value="VeteranStatus"/>
  <status value="draft"/>
  <kind value="query"/>
  <date value="2021-08-13T16:25:22+00:00"/>
  <publisher value="Cross Group Projects WG"/>
  <contact>
    <name value="Cross Group Projects WG"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/cgp"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="cgp@lists.hl7.org"/>
    </telecom>
  </contact>
  <description
               value="The Veteran Status Operation returns &#39;true&#39; or &#39;false&#39; based on the known veteran status of the patient.  The API should be used as part of use cases needing general veteran status and not neccesarily be used as part of eligibilty."/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
      <display value="United States of America"/>
    </coding>
  </jurisdiction>
  <code value="veteranStatus"/>
  <resource value="Patient"/>
  <system value="true"/>
  <type value="false"/>
  <instance value="false"/>
  <parameter>
    <name value="firstName"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="last"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="middleName"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="veteranSSN"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <type value="Identifier"/>
  </parameter>
  <parameter>
    <name value="dateOfBirth"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <type value="date"/>
  </parameter>
  <parameter>
    <name value="gender"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <type value="code"/>
  </parameter>
  <parameter>
    <name value="veterandateStatus"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <type value="boolean"/>
  </parameter>
</OperationDefinition>