PSGC Terminology FHIR Implementation Guide
0.1.0 - ci-build Philippines flag

PSGC Terminology FHIR Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

: Geographic Lookup - JSON Representation

Draft as of 2026-06-23

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "geo-lookup",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: DefinicionDeOperacion geo-lookup</b></p><a name=\"geo-lookup\"> </a><a name=\"hcgeo-lookup\"> </a><p>URL: [base]/CodeSystem/$geo-lookup</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>parent</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#code\">code</a></td><td/><td><div><p>Parent PSGC code (trailing zeros stripped to form prefix)</p>\n</div></td></tr><tr><td>IN</td><td>level</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#code\">code</a></td><td><a href=\"ValueSet-psgc-geographic-level.html\">PSGC Geographic Level</a> (Required)</td><td><div><p>Geographic level filter (Reg, Prov, City, Mun, SubMun, Bgy)</p>\n</div></td></tr><tr><td>IN</td><td>version</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>PSGC release version. Defaults to latest.</p>\n</div></td></tr><tr><td>OUT</td><td>match</td><td/><td>0..*</td><td/><td/><td><div><p>Matching codes</p>\n</div></td></tr><tr><td>OUT</td><td>match.code</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#code\">code</a></td><td/><td/></tr><tr><td>OUT</td><td>match.display</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td/></tr><tr><td>OUT</td><td>match.level</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#code\">code</a></td><td/><td/></tr></table></div>"
  },
  "url" : "https://australian-e-health-research-centre.gitlab.io/psgc-fhir-ig/OperationDefinition/geo-lookup",
  "version" : "0.1.0",
  "name" : "GeoLookup",
  "title" : "Geographic Lookup",
  "status" : "draft",
  "kind" : "operation",
  "date" : "2026-06-23T13:03:53+00:00",
  "publisher" : "CSIRO Australian e-Health Research Centre",
  "contact" : [
    {
      "name" : "CSIRO Australian e-Health Research Centre",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://aehrc.csiro.au"
        }
      ]
    }
  ],
  "description" : "Find PSGC codes by parent code prefix and/or geographic level. Exploits the positional encoding of the 10-digit PSGC code.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "PH",
          "display" : "Philippines"
        }
      ]
    }
  ],
  "code" : "geo-lookup",
  "resource" : [
    "CodeSystem"
  ],
  "system" : false,
  "type" : true,
  "instance" : false,
  "parameter" : [
    {
      "name" : "parent",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Parent PSGC code (trailing zeros stripped to form prefix)",
      "type" : "code"
    },
    {
      "name" : "level",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Geographic level filter (Reg, Prov, City, Mun, SubMun, Bgy)",
      "type" : "code",
      "binding" : {
        "strength" : "required",
        "valueSet" : "https://australian-e-health-research-centre.gitlab.io/psgc-fhir-ig/ValueSet/psgc-geographic-level"
      }
    },
    {
      "name" : "version",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "PSGC release version. Defaults to latest.",
      "type" : "string"
    },
    {
      "name" : "match",
      "use" : "out",
      "min" : 0,
      "max" : "*",
      "documentation" : "Matching codes",
      "part" : [
        {
          "name" : "code",
          "use" : "out",
          "min" : 1,
          "max" : "1",
          "type" : "code"
        },
        {
          "name" : "display",
          "use" : "out",
          "min" : 1,
          "max" : "1",
          "type" : "string"
        },
        {
          "name" : "level",
          "use" : "out",
          "min" : 1,
          "max" : "1",
          "type" : "code"
        }
      ]
    }
  ]
}