This page is part of the FHIR Specification (v4.3.0: R4B - STU). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
FHIR Infrastructure Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Not linked to any defined compartments |
Raw JSON (canonical form + also see JSON Format Specification)
General example
{ "resourceType" : "SearchParameter", "id" : "example", "text" : { "status" : "generated", "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative</b></p><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\">Resource "example" </p></div><p><b>url</b>: <code>http://hl7.org/fhir/SearchParameter/example</code></p><p><b>version</b>: 1</p><p><b>name</b>: ID-SEARCH-PARAMETER</p><p><b>derivedFrom</b>: <a href=\"http://hl7.org/fhir/SearchParameter/Resource-id\">http://hl7.org/fhir/SearchParameter/Resource-id</a></p><p><b>status</b>: draft</p><p><b>experimental</b>: true</p><p><b>date</b>: 2013-10-23</p><p><b>publisher</b>: Health Level Seven International (FHIR Infrastructure)</p><p><b>contact</b>: [string]: <a href=\"http://hl7.org/fhir\">http://hl7.org/fhir</a></p><p><b>description</b>: Search by resource identifier - e.g. same as the read interaction, but can return included resources</p><p><b>jurisdiction</b>: United States of America (the) <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (unknown#US)</span></p><p><b>purpose</b>: Need to search by identifier for various infrastructural cases - mainly retrieving packages, and matching as part of a chain</p><p><b>code</b>: _id</p><p><b>base</b>: Resource</p><p><b>type</b>: token</p><p><b>expression</b>: id</p><p><b>xpath</b>: f:*/f:id</p><p><b>xpathUsage</b>: normal</p><p><b>comparator</b>: eq</p></div>" }, "url" : "http://hl7.org/fhir/SearchParameter/example", "version" : "1", "name" : "ID-SEARCH-PARAMETER", "derivedFrom" : "http://hl7.org/fhir/SearchParameter/Resource-id", "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 (the)" }] }], "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", "xpath" : "f:*/f:id", "xpathUsage" : "normal", "comparator" : ["eq"] }
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.