Release 4B R5 Final QA

This page is part of the FHIR Specification (v4.3.0: R4B (v5.0.0-draft-final: Final QA Preview for R5 - STU see ballot notes ). 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

Example SearchParameter/example (Turtle)

FHIR Infrastructure Work Group Maturity Level : N/A Standards Status : Informative Compartments : Not linked to any defined compartments

Raw Turtle (+ also see Turtle/RDF Format Specification )

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 -------------------------------------------------------------------

[] a fhir:SearchParameter;
  fhir:Resource.id [ fhir:value "example"];
  fhir:DomainResource.text [
     fhir:Narrative.status [ fhir:value "generated" ]
  ];
  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.derivedFrom [ fhir:value "http://hl7.org/fhir/SearchParameter/Resource-id"];
  fhir:SearchParameter.status [ fhir:value "draft"];
  fhir:SearchParameter.experimental [ fhir:value "true"];
  fhir:SearchParameter.date [ fhir:value "2013-10-23"];
  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.description [ fhir:value "Search by resource identifier - e.g. same as the read interaction, but can return included resources"];
  fhir:SearchParameter.useContext [
     fhir:index 0;
     fhir:UsageContext.code [
       fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/usage-context-type" ];
       fhir:Coding.code [ fhir:value "focus" ]
     ];
     fhir:UsageContext.value [
       fhir:CodeableConcept.coding [
         fhir:index 0;
         fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/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)" ]

[a fhir:SearchParameter ;
  fhir:nodeRole fhir:treeRoot ;
  fhir:id [ fhir:v "example"] ; # 
  fhir:text [
     fhir:status [ fhir:v "generated" ] ;
     fhir:div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative: SearchParameter</b><a name=\"example\"> </a></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 SearchParameter &quot;example&quot; </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>: IDSEARCHPARAMETER</p><p><b>title</b>: I D- S E A R C H- P A R A M E T E R</p><p><b>derivedFrom</b>: <a href=\"resource-search.html#Resource-id\">_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><h3>UseContexts</h3><table class=\"grid\"><tr><td>-</td><td><b>Code</b></td><td><b>Value[x]</b></td></tr><tr><td>*</td><td>Clinical Focus (Details: http://terminology.hl7.org/CodeSystem/usage-context-type code focus = 'Clinical Focus', stated as 'null')</td><td>positive <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-variant-state.html\">sequenceStatus</a>#positive)</span></td></tr></table><p><b>jurisdiction</b>: United States of America (the) <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-ISO3166Part1.html\">ISO 3166-1 Codes for the representation of names of countries and their subdivisions — Part 1: Country code</a>#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>processingMode</b>: normal</p></div>"
  ] ; # 
  fhir:url [ fhir:v "http://hl7.org/fhir/SearchParameter/example"^^xsd:anyURI] ; # 
  fhir:version [ fhir:v "1"] ; # 
  fhir:name [ fhir:v "IDSEARCHPARAMETER"] ; # 
  fhir:title [ fhir:v "I D- S E A R C H- P A R A M E T E R"] ; # 
  fhir:derivedFrom [
     fhir:v "http://hl7.org/fhir/SearchParameter/Resource-id"^^xsd:anyURI ;
     fhir:link <http://hl7.org/fhir/SearchParameter/Resource-id>
  ] ; # 
  fhir:status [ fhir:v "draft"] ; # 
  fhir:experimental [ fhir:v "true"^^xsd:boolean] ; # 
  fhir:date [ fhir:v "2013-10-23"^^xsd:date] ; # 
  fhir:publisher [ fhir:v "Health Level Seven International (FHIR Infrastructure)"] ; # 
  fhir:contact ( [
     fhir:name [ fhir:v "[string]" ] ;
     fhir:telecom ( [
       fhir:system [ fhir:v "url" ] ;
       fhir:value [ fhir:v "http://hl7.org/fhir" ]
     ] )
  ] ) ; # 
  fhir:description [ fhir:v "Search by resource identifier - e.g. same as the read interaction, but can return included resources"] ; # 
  fhir:useContext ( [
     fhir:code [
       fhir:system [ fhir:v "http://terminology.hl7.org/CodeSystem/usage-context-type"^^xsd:anyURI ] ;
       fhir:code [ fhir:v "focus" ]
     ] ;
     fhir:value [
       a fhir:CodeableConcept ;
       fhir:coding ( [
         fhir:system [ fhir:v "http://terminology.hl7.org/CodeSystem/variant-state"^^xsd:anyURI ] ;
         fhir:code [ fhir:v "positive" ]
       ] )

     ]
  ];
  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.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
  ] .

  ] ) ; # 
  fhir:jurisdiction ( [
     fhir:coding ( [
       fhir:system [ fhir:v "urn:iso:std:iso:3166"^^xsd:anyURI ] ;
       fhir:code [ fhir:v "US" ] ;
       fhir:display [ fhir:v "United States of America (the)" ]
     ] )
  ] ) ; # 
  fhir:purpose [ fhir:v "Need to search by identifier for various infrastructural cases - mainly retrieving packages, and matching as part of a chain"] ; # 
  fhir:code [ fhir:v "_id"] ; # 
  fhir:base ( [ fhir:v "Resource"] ) ; # 
  fhir:type [ fhir:v "token"] ; # 
  fhir:expression [ fhir:v "id"] ; # 
  fhir:processingMode [ fhir:v "normal"]] . # 


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


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.