Canonical Resource Management Infrastructure Implementation Guide
2.0.0-ballot - STU 2 - Ballot International flag

This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v2.0.0-ballot: STU 2 Ballot) based on FHIR (HL7® FHIR® Standard) R4. This version is a pre-release. The current official version is 1.0.0. For a full list of available versions, see the Directory of published versions

: PublishableSearchParameterExample - JSON Representation

Page standards status: Informative

Raw json | Download

{
  "resourceType" : "SearchParameter",
  "id" : "publishable-example",
  "meta" : {
    "profile" : [
      🔗 "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishablesearchparameter"
    ]
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: SearchParameter publishable-example</b></p><a name=\"publishable-example\"> </a><a name=\"hcpublishable-example\"> </a><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\"/><p style=\"margin-bottom: 0px\">Profile: <a href=\"StructureDefinition-crmi-publishablesearchparameter.html\">CRMI Publishable SearchParameter</a></p></div><h2>PublishableSearchParameterExample</h2><p>Parameter <code>_id</code>:<code>token</code></p><div><p>Search by resource identifier - e.g. same as the read interaction, but can return included resources</p>\n</div><table class=\"grid\"><tr><td>Resource</td><td><a href=\"http://hl7.org/fhir/R4/resource.html\">Resource</a></td></tr><tr><td>Expression</td><td><code>id</code></td></tr><tr><td>Processing Mode</td><td>Normal</td></tr><tr><td>Multiples</td><td><ul><li>multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true</li><li>multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true</li></ul></td></tr><tr><td>Comparators</td><td>Allowed: eq</td></tr></table></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/artifact-title",
      "valueString" : "Publishable SearchParameter Example"
    }
  ],
  "url" : "http://hl7.org/fhir/uv/crmi/SearchParameter/publishable-example",
  "version" : "2.0.0-ballot",
  "name" : "PublishableSearchParameterExample",
  "status" : "draft",
  "experimental" : true,
  "date" : "2013-10-23",
  "publisher" : "Health Level Seven International (FHIR Infrastructure)",
  "contact" : [
    {
      "name" : "[string]",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://hl7.org/fhir"
        }
      ]
    }
  ],
  "description" : "Search by resource identifier - e.g. same as the read interaction, but can return included resources",
  "useContext" : [
    {
      "code" : {
        "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
        "code" : "focus"
      },
      "valueCodeableConcept" : {
        "coding" : [
          {
            "system" : "http://terminology.hl7.org/CodeSystem/variant-state",
            "code" : "positive"
          }
        ]
      }
    }
  ],
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US",
          "display" : "United States of America"
        }
      ]
    }
  ],
  "purpose" : "Need to search by identifier for various infrastructural cases - mainly retrieving packages, and matching as part of a chain",
  "code" : "_id",
  "base" : [
    "Resource"
  ],
  "type" : "token",
  "expression" : "id",
  "xpathUsage" : "normal",
  "comparator" : [
    "eq"
  ]
}