STU3 Candidate
ConformanceThis page is part of the FHIR Specification (v1.8.0: STU 3 Draft). 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
StructureDefinition for searchparameter
{
"resourceType": "StructureDefinition",
"id": "SearchParameter",
"meta": {
"lastUpdated": "2016-12-06T12:22:34.981+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 1
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/SearchParameter",
"name": "SearchParameter",
"status": "draft",
"publisher": "Health Level Seven International (FHIR Infrastructure)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fiwg/index.cfm"
}
]
}
],
"date": "2016-12-06T12:22:34+11:00",
"description": "Base StructureDefinition for SearchParameter Resource",
"fhirVersion": "1.8.0",
"mapping": [
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
},
{
"identity": "objimpl",
"uri": "http://hl7.org/fhir/object-implementation",
"name": "Object Implementation Information"
}
],
"kind": "resource",
"abstract": false,
"type": "SearchParameter",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"_baseDefinition": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-codegen-super",
"valueString": "MetadataResource"
}
]
},
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "SearchParameter",
"path": "SearchParameter",
"short": "Search Parameter for a resource",
"definition": "A search parameter that defines a named search item that can be used to search/filter on a resource.",
"comments": "In FHIR, search is not performed directly on a resource (by XML or JSON path), but on a named parameter that maps into the resource content.",
"min": 1,
"max": "1",
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource"
},
{
"key": "dom-1",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression": "contained.text.empty()",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource"
},
{
"key": "dom-3",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "DomainResource"
},
{
"key": "spd-1",
"severity": "error",
"human": "If an xpath is present, there SHALL be an xpathUsage",
"expression": "xpath.empty() or xpathUsage.exists()",
"xpath": "not(exists(f:xpath)) or exists(f:xpathUsage)"
},
{
"key": "spd-2",
"severity": "error",
"human": "Search parameters can only have chain names when the search parameter type is 'reference'",
"expression": "chain.empty() or type = 'reference'",
"xpath": "not(exists(f:chain)) or (f:type/@value = 'reference')"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "v2",
"map": "n/a"
},
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "w5",
"map": "conformance.behavior"
}
]
},
{
"id": "SearchParameter.id",
"path": "SearchParameter.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "SearchParameter.meta",
"path": "SearchParameter.meta",
"short": "Metadata about the resource",
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"id": "SearchParameter.implicitRules",
"path": "SearchParameter.implicitRules",
"short": "A set of rules under which this content was created",
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.",
"comments": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"id": "SearchParameter.language",
"path": "SearchParameter.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
}
},
{
"id": "SearchParameter.text",
"path": "SearchParameter.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "SearchParameter.contained",
"path": "SearchParameter.contained",
"short": "Contained, inline Resources",
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "SearchParameter.extension",
"path": "SearchParameter.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "SearchParameter.modifierExtension",
"path": "SearchParameter.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "SearchParameter.url",
"path": "SearchParameter.url",
"short": "Logical uri to reference this search parameter (globally unique)",
"definition": "An absolute URL that is used to identify this search parameter when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this search parameter is (or will be) published. The URL SHOULD include the major version of the search parameter. For more information see [Technical and Business Versions](resource.html#versions).",
"comments": "Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred.",
"requirements": "Allows the search parameter to be referenced by a single globally unique identifier. To allow referencing and reusing search parameter definitions under other names on operational systems (in case of name clash).",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "SearchParameter.version",
"path": "SearchParameter.version",
"short": "Business version of the search parameter",
"definition": "The identifier that is used to identify this version of the search parameter when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the search parameter author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable.",
"comments": "There may be multiple different instances of a search parameter that have the same identifier but different versions.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "id.version"
}
]
},
{
"id": "SearchParameter.name",
"path": "SearchParameter.name",
"short": "Name for this search parameter (Computer friendly)",
"definition": "A natural language name identifying the search parameter. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comments": "The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure it is computable friendly.",
"requirements": "Support human navigation & code generation.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "SearchParameter.status",
"path": "SearchParameter.status",
"short": "draft | active | retired",
"definition": "The status of this search parameter. Enables tracking the life-cycle of the content.",
"comments": "Allows filtering of search parameter that are appropriate for use vs. not.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "The lifecycle status of a Value Set or Concept Map.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/publication-status"
}
},
"mapping": [
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "SearchParameter.experimental",
"path": "SearchParameter.experimental",
"short": "If for testing purposes, not real usage",
"definition": "A flag to indicate that this search parameter is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"comments": "Allows filtering of search parameter that are appropriate for use vs. not.",
"requirements": "Enables experimental content to be developed following the same life-cycle as a production-level search parameter would.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "class"
}
]
},
{
"id": "SearchParameter.date",
"path": "SearchParameter.date",
"short": "Date this was last changed",
"definition": "The date (and optionally time) when the search parameter was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changes.",
"comments": "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the search parameter. Additional specific dates may be added as extensions.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "when.recorded"
}
]
},
{
"id": "SearchParameter.publisher",
"path": "SearchParameter.publisher",
"short": "Name of the publisher (Organization or individual)",
"definition": "The name of the individual or organization that published the search parameter.",
"comments": "Usually an organization, but may be an individual. The publisher (or steward) of the search parameter is the organization or individual primarily responsible for the maintenance and upkeep of the search parameter. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the search parameter. This item SHOULD be populated unless the information is available from context.",
"requirements": "Helps establish the \"authority/credibility\" of the search parameter. May also allow for contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "who.witness"
}
]
},
{
"id": "SearchParameter.contact",
"path": "SearchParameter.contact",
"short": "Contact details for the publisher",
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"comments": "May be a web site, an email address, a telephone number, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactDetail"
}
],
"isSummary": true
},
{
"id": "SearchParameter.useContext",
"path": "SearchParameter.useContext",
"short": "Content intends to support these contexts",
"definition": "The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of code system definitions.",
"comments": "When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply.",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"max": "*",
"type": [
{
"code": "UsageContext"
}
],
"isSummary": true
},
{
"id": "SearchParameter.jurisdiction",
"path": "SearchParameter.jurisdiction",
"short": "Intended jurisdiction for search parameter (if applicable)",
"definition": "A jurisdiction in which the search parameter is intended to be used.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "Countries and regions within which this artifact is targeted for use",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/jurisdiction"
}
}
},
{
"id": "SearchParameter.purpose",
"path": "SearchParameter.purpose",
"short": "Why this search parameter is defined",
"definition": "Explains why this search parameter is needed and why it has been designed as it has.",
"comments": "This element does not describe the usage of the search parameter (See, e.g, the comments element, or relatedArtifacts), rather it's for traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this search parameter.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "SearchParameter.code",
"path": "SearchParameter.code",
"short": "Code used in URL",
"definition": "The code used in the URL or the parameter name in a parameters resource for this search parameter.",
"comments": "For maximum compatibility, use only lowercase ASCII characters.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true
},
{
"id": "SearchParameter.base",
"path": "SearchParameter.base",
"short": "The resource type(s) this search parameter applies to",
"definition": "The base resource type(s) that this search parameter can be used against.",
"comments": "A search parameter must always have at least one type. When search parameters have more than one resource, they can be used against any of the listed resource types, or in a cross-type search (see [Cross Resource Search](http.html#xres-search)).",
"min": 1,
"max": "*",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "One of the resource types defined as part of FHIR.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/resource-types"
}
}
},
{
"id": "SearchParameter.type",
"path": "SearchParameter.type",
"short": "number | date | string | token | reference | composite | quantity | uri",
"definition": "The type of value a search parameter refers to, and how the content is interpreted.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "Data types allowed to be used for search parameters.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/search-param-type"
}
}
},
{
"id": "SearchParameter.derivedFrom",
"path": "SearchParameter.derivedFrom",
"short": "Original Definition for the search parameter",
"definition": "Where this search parameter is originally defined. If a derivedFrom is provided, then the details in the search parameter must be consistent with the definition from which it is defined. I.e. the parameter should have the same meaning, and (usually) the functionality should be a proper subset of the underlying search parameter.",
"comments": "The intent of this is that a server can designate that it provides support for E.g. the \"value-quantity\" search parameter defined in the specification itself (http://hl7.org/fhir/SearchParameter/Observation-value-quantity), but detail how it is supported by the server.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"id": "SearchParameter.description",
"path": "SearchParameter.description",
"short": "Natural language description of the search parameter",
"definition": "A free text natural language description of the search parameter from the consumer's perspective. and how it used.",
"comments": "This description can be used to capture details such as why the search parameter was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context.",
"min": 1,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"isSummary": true
},
{
"id": "SearchParameter.expression",
"path": "SearchParameter.expression",
"short": "FluentPath expression that extracts the values",
"definition": "A FluentPath expression that returns a set of elements for the search parameter.",
"comments": "Note that the elements returned by the expression are sometimes complex elements where logic is required to determine quite how to handle them; e.g. CodeableConcepts may contain text and/or multiple codings, where the codings themselves contain a code and a system. For composite search parameters, the outcome of the expression must a collection of base elements from which the composites are derived.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"condition": [
"spd-1"
]
},
{
"id": "SearchParameter.xpath",
"path": "SearchParameter.xpath",
"short": "XPath that extracts the values",
"definition": "An XPath expression that returns a set of elements for the search parameter.",
"comments": "Note that the elements returned by the XPath are sometimes complex elements where logic is required to determine quite how to handle them; e.g. CodeableConcepts may contain text and/or multiple codings, where the codings themselves contain a code and a system.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"condition": [
"spd-1"
]
},
{
"id": "SearchParameter.xpathUsage",
"path": "SearchParameter.xpathUsage",
"short": "normal | phonetic | nearby | distance | other",
"definition": "How the search parameter relates to the set of elements returned by evaluating the xpath query.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"condition": [
"spd-1"
],
"binding": {
"strength": "required",
"description": "How a search parameter relates to the set of elements returned by evaluating its xpath query.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/search-xpath-usage"
}
}
},
{
"id": "SearchParameter.target",
"path": "SearchParameter.target",
"short": "Types of resource (if a resource reference)",
"definition": "Types of resource (if a resource is referenced).",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "One of the resource types defined as part of FHIR.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/resource-types"
}
}
},
{
"id": "SearchParameter.comparator",
"path": "SearchParameter.comparator",
"short": "eq | ne | gt | lt | ge | le | sa | eb | ap",
"definition": "Comparators supported for the search parameter.",
"comments": "If no comparators are listed, clients should not expect servers to support any comparators.",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "What Search Comparator Codes are supported in search",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/search-comparator"
}
}
},
{
"id": "SearchParameter.modifier",
"path": "SearchParameter.modifier",
"short": "missing | exact | contains | not | text | in | not-in | below | above | type",
"definition": "A modifier supported for the search parameter.",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "A supported modifier for a search parameter.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/search-modifier-code"
}
}
},
{
"id": "SearchParameter.chain",
"path": "SearchParameter.chain",
"short": "Chained names supported",
"definition": "Contains the names of any search parameters which may be chained to the containing search parameter. Chained parameters may be added to search parameters of type reference, and specify that resources will only be returned if they contain a reference to a resource which matches the chained parameter value. Values for this field should be drawn from SearchParameter.code for a parameter on the target resource type.",
"comments": "Systems are not required to list all the chain names they support, but if they don't list them, clients may not know to use them.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
]
},
{
"id": "SearchParameter.component",
"path": "SearchParameter.component",
"short": "For Composite resources to define the parts",
"definition": "Used to define the parts of a composite search parameter.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "children().count() > id.count()",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
]
},
{
"id": "SearchParameter.component.id",
"path": "SearchParameter.component.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "SearchParameter.component.extension",
"path": "SearchParameter.component.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "SearchParameter.component.modifierExtension",
"path": "SearchParameter.component.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "SearchParameter.component.definition",
"path": "SearchParameter.component.definition",
"short": "Defines how the part works",
"definition": "The definition of the search parameter that describes this part.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/SearchParameter"
}
]
},
{
"id": "SearchParameter.component.expression",
"path": "SearchParameter.component.expression",
"short": "Subexpression relative to main expression",
"definition": "A sub-expression that defines how to extract values for this component from the output of the main SearchParameter.expression.",
"comments": "This expression overrides the expression in the definition, and extracts the index values from the outcome of the composite expression.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
}
]
},
"differential": {
"element": [
{
"id": "SearchParameter",
"path": "SearchParameter",
"short": "Search Parameter for a resource",
"definition": "A search parameter that defines a named search item that can be used to search/filter on a resource.",
"comments": "In FHIR, search is not performed directly on a resource (by XML or JSON path), but on a named parameter that maps into the resource content.",
"min": 1,
"max": "1",
"constraint": [
{
"key": "spd-1",
"severity": "error",
"human": "If an xpath is present, there SHALL be an xpathUsage",
"expression": "xpath.empty() or xpathUsage.exists()",
"xpath": "not(exists(f:xpath)) or exists(f:xpathUsage)"
},
{
"key": "spd-2",
"severity": "error",
"human": "Search parameters can only have chain names when the search parameter type is 'reference'",
"expression": "chain.empty() or type = 'reference'",
"xpath": "not(exists(f:chain)) or (f:type/@value = 'reference')"
}
],
"mapping": [
{
"identity": "v2",
"map": "n/a"
},
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "w5",
"map": "conformance.behavior"
}
]
},
{
"id": "SearchParameter.url",
"path": "SearchParameter.url",
"short": "Logical uri to reference this search parameter (globally unique)",
"definition": "An absolute URL that is used to identify this search parameter when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this search parameter is (or will be) published. The URL SHOULD include the major version of the search parameter. For more information see [Technical and Business Versions](resource.html#versions).",
"comments": "Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred.",
"requirements": "Allows the search parameter to be referenced by a single globally unique identifier. To allow referencing and reusing search parameter definitions under other names on operational systems (in case of name clash).",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "SearchParameter.version",
"path": "SearchParameter.version",
"short": "Business version of the search parameter",
"definition": "The identifier that is used to identify this version of the search parameter when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the search parameter author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable.",
"comments": "There may be multiple different instances of a search parameter that have the same identifier but different versions.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "id.version"
}
]
},
{
"id": "SearchParameter.name",
"path": "SearchParameter.name",
"short": "Name for this search parameter (Computer friendly)",
"definition": "A natural language name identifying the search parameter. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comments": "The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure it is computable friendly.",
"requirements": "Support human navigation & code generation.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "SearchParameter.status",
"path": "SearchParameter.status",
"short": "draft | active | retired",
"definition": "The status of this search parameter. Enables tracking the life-cycle of the content.",
"comments": "Allows filtering of search parameter that are appropriate for use vs. not.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "The lifecycle status of a Value Set or Concept Map.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/publication-status"
}
},
"mapping": [
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "SearchParameter.experimental",
"path": "SearchParameter.experimental",
"short": "If for testing purposes, not real usage",
"definition": "A flag to indicate that this search parameter is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"comments": "Allows filtering of search parameter that are appropriate for use vs. not.",
"requirements": "Enables experimental content to be developed following the same life-cycle as a production-level search parameter would.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "class"
}
]
},
{
"id": "SearchParameter.date",
"path": "SearchParameter.date",
"short": "Date this was last changed",
"definition": "The date (and optionally time) when the search parameter was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changes.",
"comments": "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the search parameter. Additional specific dates may be added as extensions.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "when.recorded"
}
]
},
{
"id": "SearchParameter.publisher",
"path": "SearchParameter.publisher",
"short": "Name of the publisher (Organization or individual)",
"definition": "The name of the individual or organization that published the search parameter.",
"comments": "Usually an organization, but may be an individual. The publisher (or steward) of the search parameter is the organization or individual primarily responsible for the maintenance and upkeep of the search parameter. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the search parameter. This item SHOULD be populated unless the information is available from context.",
"requirements": "Helps establish the \"authority/credibility\" of the search parameter. May also allow for contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "who.witness"
}
]
},
{
"id": "SearchParameter.contact",
"path": "SearchParameter.contact",
"short": "Contact details for the publisher",
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"comments": "May be a web site, an email address, a telephone number, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactDetail"
}
],
"isSummary": true
},
{
"id": "SearchParameter.useContext",
"path": "SearchParameter.useContext",
"short": "Content intends to support these contexts",
"definition": "The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of code system definitions.",
"comments": "When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply.",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"max": "*",
"type": [
{
"code": "UsageContext"
}
],
"isSummary": true
},
{
"id": "SearchParameter.jurisdiction",
"path": "SearchParameter.jurisdiction",
"short": "Intended jurisdiction for search parameter (if applicable)",
"definition": "A jurisdiction in which the search parameter is intended to be used.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "Countries and regions within which this artifact is targeted for use",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/jurisdiction"
}
}
},
{
"id": "SearchParameter.purpose",
"path": "SearchParameter.purpose",
"short": "Why this search parameter is defined",
"definition": "Explains why this search parameter is needed and why it has been designed as it has.",
"comments": "This element does not describe the usage of the search parameter (See, e.g, the comments element, or relatedArtifacts), rather it's for traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this search parameter.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "SearchParameter.code",
"path": "SearchParameter.code",
"short": "Code used in URL",
"definition": "The code used in the URL or the parameter name in a parameters resource for this search parameter.",
"comments": "For maximum compatibility, use only lowercase ASCII characters.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true
},
{
"id": "SearchParameter.base",
"path": "SearchParameter.base",
"short": "The resource type(s) this search parameter applies to",
"definition": "The base resource type(s) that this search parameter can be used against.",
"comments": "A search parameter must always have at least one type. When search parameters have more than one resource, they can be used against any of the listed resource types, or in a cross-type search (see [Cross Resource Search](http.html#xres-search)).",
"min": 1,
"max": "*",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "One of the resource types defined as part of FHIR.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/resource-types"
}
}
},
{
"id": "SearchParameter.type",
"path": "SearchParameter.type",
"short": "number | date | string | token | reference | composite | quantity | uri",
"definition": "The type of value a search parameter refers to, and how the content is interpreted.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "Data types allowed to be used for search parameters.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/search-param-type"
}
}
},
{
"id": "SearchParameter.derivedFrom",
"path": "SearchParameter.derivedFrom",
"short": "Original Definition for the search parameter",
"definition": "Where this search parameter is originally defined. If a derivedFrom is provided, then the details in the search parameter must be consistent with the definition from which it is defined. I.e. the parameter should have the same meaning, and (usually) the functionality should be a proper subset of the underlying search parameter.",
"comments": "The intent of this is that a server can designate that it provides support for E.g. the \"value-quantity\" search parameter defined in the specification itself (http://hl7.org/fhir/SearchParameter/Observation-value-quantity), but detail how it is supported by the server.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"id": "SearchParameter.description",
"path": "SearchParameter.description",
"short": "Natural language description of the search parameter",
"definition": "A free text natural language description of the search parameter from the consumer's perspective. and how it used.",
"comments": "This description can be used to capture details such as why the search parameter was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context.",
"min": 1,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"isSummary": true
},
{
"id": "SearchParameter.expression",
"path": "SearchParameter.expression",
"short": "FluentPath expression that extracts the values",
"definition": "A FluentPath expression that returns a set of elements for the search parameter.",
"comments": "Note that the elements returned by the expression are sometimes complex elements where logic is required to determine quite how to handle them; e.g. CodeableConcepts may contain text and/or multiple codings, where the codings themselves contain a code and a system. For composite search parameters, the outcome of the expression must a collection of base elements from which the composites are derived.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"condition": [
"spd-1"
]
},
{
"id": "SearchParameter.xpath",
"path": "SearchParameter.xpath",
"short": "XPath that extracts the values",
"definition": "An XPath expression that returns a set of elements for the search parameter.",
"comments": "Note that the elements returned by the XPath are sometimes complex elements where logic is required to determine quite how to handle them; e.g. CodeableConcepts may contain text and/or multiple codings, where the codings themselves contain a code and a system.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"condition": [
"spd-1"
]
},
{
"id": "SearchParameter.xpathUsage",
"path": "SearchParameter.xpathUsage",
"short": "normal | phonetic | nearby | distance | other",
"definition": "How the search parameter relates to the set of elements returned by evaluating the xpath query.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"condition": [
"spd-1"
],
"binding": {
"strength": "required",
"description": "How a search parameter relates to the set of elements returned by evaluating its xpath query.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/search-xpath-usage"
}
}
},
{
"id": "SearchParameter.target",
"path": "SearchParameter.target",
"short": "Types of resource (if a resource reference)",
"definition": "Types of resource (if a resource is referenced).",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "One of the resource types defined as part of FHIR.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/resource-types"
}
}
},
{
"id": "SearchParameter.comparator",
"path": "SearchParameter.comparator",
"short": "eq | ne | gt | lt | ge | le | sa | eb | ap",
"definition": "Comparators supported for the search parameter.",
"comments": "If no comparators are listed, clients should not expect servers to support any comparators.",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "What Search Comparator Codes are supported in search",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/search-comparator"
}
}
},
{
"id": "SearchParameter.modifier",
"path": "SearchParameter.modifier",
"short": "missing | exact | contains | not | text | in | not-in | below | above | type",
"definition": "A modifier supported for the search parameter.",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "A supported modifier for a search parameter.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/search-modifier-code"
}
}
},
{
"id": "SearchParameter.chain",
"path": "SearchParameter.chain",
"short": "Chained names supported",
"definition": "Contains the names of any search parameters which may be chained to the containing search parameter. Chained parameters may be added to search parameters of type reference, and specify that resources will only be returned if they contain a reference to a resource which matches the chained parameter value. Values for this field should be drawn from SearchParameter.code for a parameter on the target resource type.",
"comments": "Systems are not required to list all the chain names they support, but if they don't list them, clients may not know to use them.",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
]
},
{
"id": "SearchParameter.component",
"path": "SearchParameter.component",
"short": "For Composite resources to define the parts",
"definition": "Used to define the parts of a composite search parameter.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "SearchParameter.component.definition",
"path": "SearchParameter.component.definition",
"short": "Defines how the part works",
"definition": "The definition of the search parameter that describes this part.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/SearchParameter"
}
]
},
{
"id": "SearchParameter.component.expression",
"path": "SearchParameter.component.expression",
"short": "Subexpression relative to main expression",
"definition": "A sub-expression that defines how to extract values for this component from the output of the main SearchParameter.expression.",
"comments": "This expression overrides the expression in the definition, and extracts the index values from the outcome of the composite expression.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
}
]
}
}
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.
© HL7.org 2011+. FHIR STU3 Candidate (v1.8.0-10521) generated on Tue, Dec 6, 2016 12:27+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Compare to DSTU2 |
|
Propose a change