SearchParameter

draftResource40 elementsv4.0.1

A search parameter that defines a named search item that can be used to search/filter on a resource.

Metadata

Canonical URL: http://hl7.org/fhir/StructureDefinition/SearchParameter
ID: SearchParameter
Type
Base Definition
Derivation: specialization
Publisher: Health Level Seven International (FHIR Infrastructure)
Version: 4.0.1

Path	Card.	Type	Description
`SearchParameter`	`0..*`		Search parameter for a resource
`id`	`0..1`	string	Logical id of this artifact
`meta`	`0..1`	Meta	Metadata about the resource
`implicitRules`	`0..1`	uri	A set of rules under which this content was created
`language`	`0..1`	code	Language of the resource contentpreferred: languages
`text`	`0..1`	Narrative	Text summary of the resource, for human interpretation
`contained`	`0..*`	Resource	Contained, inline Resources
`extension`	`0..*`	Extension	Additional content defined by implementations
`modifierExtension`	`0..*`	Extension	Extensions that cannot be ignored
`url`	`1..1`	uri	Canonical identifier for this search parameter, represented as a URI (globally unique)
`version`	`0..1`	string	Business version of the search parameter
`name`	`1..1`	string	Name for this search parameter (computer friendly)
`derivedFrom`	`0..1`	canonical	Original definition for the search parameter
`status`	`1..1`	code	draft \| active \| retired \| unknownrequired: publication-status
`experimental`	`0..1`	boolean	For testing purposes, not real usage
`date`	`0..1`	dateTime	Date last changed
`publisher`	`0..1`	string	Name of the publisher (organization or individual)
`contact`	`0..*`	ContactDetail	Contact details for the publisher
`description`	`1..1`	markdown	Natural language description of the search parameter
`useContext`	`0..*`	UsageContext	The context that the content is intended to support
`jurisdiction`	`0..*`	CodeableConcept	Intended jurisdiction for search parameter (if applicable)extensible: jurisdiction
`purpose`	`0..1`	markdown	Why this search parameter is defined
`code`	`1..1`	code	Code used in URL
`base`	`1..*`	code	The resource type(s) this search parameter applies torequired: resource-types
`type`	`1..1`	code	number \| date \| string \| token \| reference \| composite \| quantity \| uri \| specialrequired: search-param-type
`expression`	`0..1`	string	FHIRPath expression that extracts the values
`xpath`	`0..1`	string	XPath that extracts the values
`xpathUsage`	`0..1`	code	normal \| phonetic \| nearby \| distance \| otherrequired: search-xpath-usage
`target`	`0..*`	code	Types of resource (if a resource reference)required: resource-types
`multipleOr`	`0..1`	boolean	Allow multiple values per parameter (or)
`multipleAnd`	`0..1`	boolean	Allow multiple parameters (and)
`comparator`	`0..*`	code	eq \| ne \| gt \| lt \| ge \| le \| sa \| eb \| aprequired: search-comparator
`modifier`	`0..*`	code	missing \| exact \| contains \| not \| text \| in \| not-in \| below \| above \| type \| identifier \| ofTyperequired: search-modifier-code
`chain`	`0..*`	string	Chained names supported
`component`	`0..*`	BackboneElement	For Composite resources to define the parts