FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). 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

Searchparameter-example.ttl

FHIR Infrastructure Work GroupMaturity Level: N/ABallot Status: InformativeCompartments: Not linked to any defined compartments

Raw Turtle, JSON-LD

General example

@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

# - resource -------------------------------------------------------------------

<http://hl7.org/fhir/SearchParameter/example> a fhir:SearchParameter;
  fhir:nodeRole fhir:treeRoot;
  fhir:Resource.id [ fhir:value "example"];
  fhir:DomainResource.text [
     fhir:Narrative.status [ fhir:value "generated" ];
     fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example</p><p><b>url</b>: <a>http://hl7.org/fhir/SearchParameter/example</a></p><p><b>version</b>: 1</p><p><b>name</b>: ID-SEARCH-PARAMETER</p><p><b>status</b>: draft</p><p><b>experimental</b>: true</p><p><b>date</b>: 23/10/2013</p><p><b>publisher</b>: Health Level Seven International (FHIR Infrastructure)</p><p><b>contact</b>: </p><p><b>useContext</b>: </p><p><b>jurisdiction</b>: United States of America (the) <span>(Details : {urn:iso:std:iso:3166 code 'US' = 'United States', given as 'United States of America (the)'})</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>derivedFrom</b>: <a>http://hl7.org/fhir/SearchParameter/Resource-id</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>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>"
  ];
  fhir:SearchParameter.url [ fhir:value "http://hl7.org/fhir/SearchParameter/example"];
  fhir:SearchParameter.version [ fhir:value "1"];
  fhir:SearchParameter.name [ fhir:value "ID-SEARCH-PARAMETER"];
  fhir:SearchParameter.status [ fhir:value "draft"];
  fhir:SearchParameter.experimental [ fhir:value "true"^^xsd:boolean];
  fhir:SearchParameter.date [ fhir:value "2013-10-23"^^xsd:date];
  fhir:SearchParameter.publisher [ fhir:value "Health Level Seven International (FHIR Infrastructure)"];
  fhir:SearchParameter.contact [
     fhir:index 0;
     fhir:ContactDetail.name [ fhir:value "[string]" ];
     fhir:ContactDetail.telecom [
       fhir:index 0;
       fhir:ContactPoint.system [ fhir:value "url" ];
       fhir:ContactPoint.value [ fhir:value "http://hl7.org/fhir" ]
     ]
  ];
  fhir:SearchParameter.useContext [
     fhir:index 0;
     fhir:UsageContext.code [
       fhir:Coding.system [ fhir:value "http://hl7.org/fhir/usage-context-type" ];
       fhir:Coding.code [ fhir:value "focus" ]
     ];
     fhir:UsageContext.valueCodeableConcept [
       fhir:CodeableConcept.coding [
         fhir:index 0;
         fhir:Coding.system [ fhir:value "http://hl7.org/fhir/variant-state" ];
         fhir:Coding.code [ fhir:value "positive" ]
       ]
     ]
  ];
  fhir:SearchParameter.jurisdiction [
     fhir:index 0;
     fhir:CodeableConcept.coding [
       fhir:index 0;
       fhir:Coding.system [ fhir:value "urn:iso:std:iso:3166" ];
       fhir:Coding.code [ fhir:value "US" ];
       fhir:Coding.display [ fhir:value "United States of America (the)" ]
     ]
  ];
  fhir:SearchParameter.purpose [ fhir:value "Need to search by identifier for various infrastructural cases - mainly retrieving packages, and matching as part of a chain"];
  fhir:SearchParameter.code [ fhir:value "_id"];
  fhir:SearchParameter.base [
     fhir:value "Resource";
     fhir:index 0
  ];
  fhir:SearchParameter.type [ fhir:value "token"];
  fhir:SearchParameter.derivedFrom [ fhir:value "http://hl7.org/fhir/SearchParameter/Resource-id"];
  fhir:SearchParameter.description [ fhir:value "Search by resource identifier - e.g. same as the read interaction, but can return included resources"];
  fhir:SearchParameter.expression [ fhir:value "id"];
  fhir:SearchParameter.xpath [ fhir:value "f:*/f:id"];
  fhir:SearchParameter.xpathUsage [ fhir:value "normal"];
  fhir:SearchParameter.comparator [
     fhir:value "eq";
     fhir:index 0
  ] .

# - ontology header ------------------------------------------------------------

<http://hl7.org/fhir/SearchParameter/example.ttl> a owl:Ontology;
  owl:imports fhir:fhir.ttl;
  owl:versionIRI <http://hl7.org/fhir/STU3/SearchParameter/example.ttl> .

# -------------------------------------------------------------------------------------


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.