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

• Narrative Content
• XML
• JSON
• TTL

: Veteran Status Verification and Confirmation - Operation - JSON Representation

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "VeteranStatus",
  "text" : {
    "status" : "extensions",
    "div" : "<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>\n</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>"
  },
  "url" : "http://hl7.org/fhir/us/military-service/OperationDefinition/VeteranStatus",
  "version" : "0.1.0",
  "name" : "VeteranStatus",
  "status" : "draft",
  "kind" : "query",
  "date" : "2021-08-13T16:25:22+00:00",
  "publisher" : "Cross Group Projects WG",
  "contact" : [
    {
      "name" : "Cross Group Projects WG",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/cgp"
        },
        {
          "system" : "email",
          "value" : "cgp@lists.hl7.org"
        }
      ]
    }
  ],
  "description" : "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.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US",
          "display" : "United States of America"
        }
      ]
    }
  ],
  "code" : "veteranStatus",
  "resource" : [
    "Patient"
  ],
  "system" : true,
  "type" : false,
  "instance" : false,
  "parameter" : [
    {
      "name" : "firstName",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "type" : "string"
    },
    {
      "name" : "last",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "type" : "string"
    },
    {
      "name" : "middleName",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "type" : "string"
    },
    {
      "name" : "veteranSSN",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "type" : "Identifier"
    },
    {
      "name" : "dateOfBirth",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "type" : "date"
    },
    {
      "name" : "gender",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "type" : "code"
    },
    {
      "name" : "veterandateStatus",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "type" : "boolean"
    }
  ]
}