haau3 FHIR Implementation Guide (HFIG)
1.0.0 - ci-build United States of America flag

haau3 FHIR Implementation Guide (HFIG) - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

: Counties of a state - JSON Representation

Active as of 2026-10-14

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "InsurancePlan-counties",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition InsurancePlan-counties</b></p><a name=\"InsurancePlan-counties\"> </a><a name=\"hcInsurancePlan-counties\"> </a><p>URL: [base]/InsurancePlan/$counties</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</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>state</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The two-letter USPS code of a state, the District of Columbia or a territory, in either case: FL.</p>\n</div></td></tr><tr><td>OUT</td><td>county</td><td/><td>0..*</td><td></td><td/><td><div><p>One county, by name order.</p>\n</div></td></tr><tr><td>OUT</td><td>county.code</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Coding\">Coding</a></td><td/><td><div><p>The county's five-digit FIPS state and county code in the system http://terminology.hl7.org/CodeSystem/FIPS64, with the county's name as the Census Bureau writes it (Miami-Dade County) as its display.</p>\n</div></td></tr><tr><td>OUT</td><td>county.state</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The two-letter USPS code of the county's state, district or territory.</p>\n</div></td></tr><tr><td>OUT</td><td>source</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>Where the list comes from: the Census Bureau's 2020 county codes and the address it is published at.</p>\n</div></td></tr></table><div><p>GET [base]/InsurancePlan/$counties?state=FL. A state code that is not two letters is refused with 400; one that names no state, district or territory answers 404. The response is a Parameters resource: one county parameter per county, then the source.</p>\n</div></div>"
  },
  "url" : "https://haau3.com/fhir/OperationDefinition/InsurancePlan-counties",
  "version" : "1.0.0",
  "name" : "InsurancePlanCounties",
  "title" : "Counties of a state",
  "status" : "active",
  "kind" : "operation",
  "date" : "2026-10-14",
  "publisher" : "haau3",
  "contact" : [
    {
      "name" : "haau3",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://haau3.com"
        },
        {
          "system" : "email",
          "value" : "hello@haau3.com"
        }
      ]
    }
  ],
  "description" : "Lists the counties and county equivalents of a US state, the District of Columbia or a territory, sorted by name, each with its five-digit FIPS state and county code: the code the [coverage-area-county](SearchParameter-InsurancePlan-coverage-area-county.html) search takes. The list is the U.S. Census Bureau's 2020 FIPS codes for counties and county equivalents. It answers whether or not a plan is sold in a county.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US",
          "display" : "United States of America"
        }
      ]
    }
  ],
  "affectsState" : false,
  "code" : "counties",
  "comment" : "GET [base]/InsurancePlan/$counties?state=FL. A state code that is not two letters is refused with 400; one that names no state, district or territory answers 404. The response is a Parameters resource: one county parameter per county, then the source.",
  "resource" : [
    "InsurancePlan"
  ],
  "system" : false,
  "type" : true,
  "instance" : false,
  "parameter" : [
    {
      "name" : "state",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "The two-letter USPS code of a state, the District of Columbia or a territory, in either case: FL.",
      "type" : "string"
    },
    {
      "name" : "county",
      "use" : "out",
      "min" : 0,
      "max" : "*",
      "documentation" : "One county, by name order.",
      "part" : [
        {
          "name" : "code",
          "use" : "out",
          "min" : 1,
          "max" : "1",
          "documentation" : "The county's five-digit FIPS state and county code in the system http://terminology.hl7.org/CodeSystem/FIPS64, with the county's name as the Census Bureau writes it (Miami-Dade County) as its display.",
          "type" : "Coding"
        },
        {
          "name" : "state",
          "use" : "out",
          "min" : 1,
          "max" : "1",
          "documentation" : "The two-letter USPS code of the county's state, district or territory.",
          "type" : "string"
        }
      ]
    },
    {
      "name" : "source",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "Where the list comes from: the Census Bureau's 2020 county codes and the address it is published at.",
      "type" : "string"
    }
  ]
}