Extensions for Using Data Elements from FHIR DSTU2 in FHIR R5
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR DSTU2 in FHIR R5 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R2_SearchParameter_R5

Official URL: http://hl7.org/fhir/1.0/StructureDefinition/profile-SearchParameter Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R2_SearchParameter_R5

This cross-version profile allows DSTU2 SearchParameter content to be represented via FHIR R5 SearchParameter resources.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SearchParameter C 0..* SearchParameter(5.0.0) Search parameter for a resource
Constraints: cnl-0, spd-1, spd-2, spd-3
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:xpath 0..1 string DSTU2: XPath that extracts the values (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-SearchParameter.xpath
Constraints: ext-1
... url ΣC 1..1 uri Canonical identifier for this search parameter, represented as a URI (globally unique)
Constraints: cnl-1
... name ΣC 1..1 string Name for this search parameter (computer friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... description Σ 1..1 markdown Natural language description of the search parameter
... code Σ 1..1 code Recommended name for parameter in search url
... base Σ 1..* code The resource type(s) this search parameter applies to
Binding: VersionIndependentResourceTypesAll (required): A type of resource, or a Reference (from all versions)
Additional BindingsPurpose
AllResourceTypes UI Binding

... type ΣC 1..1 code number | date | string | token | reference | composite | quantity | uri | special
Binding: SearchParamType (required): Data types allowed to be used for search parameters.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
SearchParameter.status Base required PublicationStatus 📍5.0.0 FHIR Std.
SearchParameter.base Base required Version Independent Resource Types (All) 📍5.0.0 FHIR Std.
SearchParameter.type Base required SearchParamType 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cnl-0 warning SearchParameter Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
cnl-1 warning SearchParameter.url URL should not contain | or # - these characters make processing canonical references problematic exists() implies matches('^[^|# ]+$')
ele-1 error SearchParameter.implicitRules, SearchParameter.extension, SearchParameter.extension:xpath, SearchParameter.modifierExtension, SearchParameter.url, SearchParameter.name, SearchParameter.status, SearchParameter.description, SearchParameter.code, SearchParameter.base, SearchParameter.type All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error SearchParameter.extension, SearchParameter.extension:xpath, SearchParameter.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
spd-1 error SearchParameter If an expression is present, there SHALL be a processingMode expression.empty() or processingMode.exists()
spd-2 error SearchParameter Search parameters can only have chain names when the search parameter type is 'reference' chain.empty() or type = 'reference'
spd-3 error SearchParameter Search parameters comparator can only be used on type 'number', 'date', 'quantity' or 'special'. comparator.empty() or (type in ('number' | 'date' | 'quantity' | 'special'))

This structure is derived from SearchParameter

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SearchParameter 0..* SearchParameter(5.0.0) Search parameter for a resource
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 Meta DSTU2: meta additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-SearchParameter.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) DSTU2: text additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-SearchParameter.text
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:xpath 0..1 string DSTU2: XPath that extracts the values (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-SearchParameter.xpath
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:name 0..1 string DSTU2: Name of a individual to contact (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-SearchParameter.contact.name
..... extension:telecom 0..* ContactPoint DSTU2: Contact details for individual or publisher (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-SearchParameter.contact.telecom
... processingMode
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:xpathUsage 0..1 code DSTU2: normal | phonetic | nearby | distance | other additional codes
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-SearchParameter.xpathUsage
Binding: SearchProcessingModeType (required): How a search parameter relates to the set of elements returned by evaluating its xpath query.

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SearchParameter C 0..* SearchParameter(5.0.0) Search parameter for a resource
Constraints: cnl-0, spd-1, spd-2, spd-3
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:meta 0..1 Meta DSTU2: meta additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-SearchParameter.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: AllSecurityLabels . (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:text 0..1 (Complex) DSTU2: text additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-SearchParameter.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative.
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:xpath 0..1 string DSTU2: XPath that extracts the values (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-SearchParameter.xpath
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... url ΣC 1..1 uri Canonical identifier for this search parameter, represented as a URI (globally unique)
Constraints: cnl-1
... identifier Σ 0..* Identifier Additional identifier for the search parameter (business identifier)
... version Σ 0..1 string Business version of the search parameter
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name ΣC 1..1 string Name for this search parameter (computer friendly)
... title Σ 0..1 string Name for this search parameter (human friendly)
... derivedFrom 0..1 canonical(SearchParameter) Original definition for the search parameter
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... 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/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:name 0..1 string DSTU2: Name of a individual to contact (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-SearchParameter.contact.name
Constraints: ext-1
..... extension:telecom 0..* ContactPoint DSTU2: Contact details for individual or publisher (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-SearchParameter.contact.telecom
Constraints: ext-1
.... name Σ 0..1 string Name of an individual to contact
.... telecom Σ 0..* ContactPoint Contact details for individual or organization
... 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)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... purpose 0..1 markdown Why this search parameter is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... copyrightLabel 0..1 string Copyright holder and year(s)
... code Σ 1..1 code Recommended name for parameter in search url
... base Σ 1..* code The resource type(s) this search parameter applies to
Binding: VersionIndependentResourceTypesAll (required): A type of resource, or a Reference (from all versions)
Additional BindingsPurpose
AllResourceTypes UI Binding

... type ΣC 1..1 code number | date | string | token | reference | composite | quantity | uri | special
Binding: SearchParamType (required): Data types allowed to be used for search parameters.
... expression C 0..1 string FHIRPath expression that extracts the values
... processingMode C 0..1 code normal | phonetic | other
Binding: SearchProcessingModeType (required): How a search parameter relates to the set of elements returned by evaluating its expression query.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:xpathUsage 0..1 code DSTU2: normal | phonetic | nearby | distance | other additional codes
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-SearchParameter.xpathUsage
Binding: SearchProcessingModeType (required): How a search parameter relates to the set of elements returned by evaluating its xpath query.
Constraints: ext-1
.... value 0..1 code Primitive value for code
... constraint 0..1 string FHIRPath expression that constraints the usage of this SearchParamete
... target 0..* code Types of resource (if a resource reference)
Binding: VersionIndependentResourceTypesAll (required): A type of resource, or a Reference (from all versions)
Additional BindingsPurpose
AllResourceTypes UI Binding

... multipleOr 0..1 boolean Allow multiple values per parameter (or)
... multipleAnd 0..1 boolean Allow multiple parameters (and)
... comparator C 0..* code eq | ne | gt | lt | ge | le | sa | eb | ap
Binding: SearchComparator (required): What Search Comparator Codes are supported in search.
... modifier 0..* code missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate
Binding: SearchModifierCode (required): A supported modifier for a search parameter.
... chain C 0..* string Chained names supported
... component 0..* BackboneElement For Composite resources to define the parts
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... definition 1..1 canonical(SearchParameter) Defines how the part works
.... expression 1..1 string Subexpression relative to main expression

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
SearchParameter.meta.​security Base extensible All Security Labels . 📍5.0.0 tx.fhir.org
SearchParameter.meta.​tag Base example Common Tags 📍5.0.0 FHIR Std.
SearchParameter.language Base required All Languages 📍5.0.0 FHIR Std.
SearchParameter.text.​status Base required NarrativeStatus 📍5.0.0 FHIR Std.
SearchParameter.versionAlgorithm[x] Base extensible Version Algorithm 📍5.0.0 FHIR Std.
SearchParameter.status Base required PublicationStatus 📍5.0.0 FHIR Std.
SearchParameter.jurisdiction Base extensible Jurisdiction ValueSet 📍5.0.0 FHIR Std.
SearchParameter.base Base required Version Independent Resource Types (All) 📍5.0.0 FHIR Std.
SearchParameter.type Base required SearchParamType 📍5.0.0 FHIR Std.
SearchParameter.processingMode Base required Search Processing Mode Type 📍5.0.0 FHIR Std.
SearchParameter.target Base required Version Independent Resource Types (All) 📍5.0.0 FHIR Std.
SearchParameter.comparator Base required Search Comparator 📍5.0.0 FHIR Std.
SearchParameter.modifier Base required Search Modifier Code 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cnl-0 warning SearchParameter Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
cnl-1 warning SearchParameter.url URL should not contain | or # - these characters make processing canonical references problematic exists() implies matches('^[^|# ]+$')
ele-1 error SearchParameter.meta, SearchParameter.meta.extension, SearchParameter.meta.extension:meta, SearchParameter.meta.versionId, SearchParameter.meta.lastUpdated, SearchParameter.meta.source, SearchParameter.meta.profile, SearchParameter.meta.security, SearchParameter.meta.tag, SearchParameter.implicitRules, SearchParameter.language, SearchParameter.text, SearchParameter.text.extension, SearchParameter.text.extension:text, SearchParameter.text.status, SearchParameter.text.div, SearchParameter.extension, SearchParameter.extension:xpath, SearchParameter.modifierExtension, SearchParameter.url, SearchParameter.identifier, SearchParameter.version, SearchParameter.versionAlgorithm[x], SearchParameter.name, SearchParameter.title, SearchParameter.derivedFrom, SearchParameter.status, SearchParameter.experimental, SearchParameter.date, SearchParameter.publisher, SearchParameter.contact, SearchParameter.contact.extension, SearchParameter.contact.extension:name, SearchParameter.contact.extension:telecom, SearchParameter.contact.name, SearchParameter.contact.telecom, SearchParameter.description, SearchParameter.useContext, SearchParameter.jurisdiction, SearchParameter.purpose, SearchParameter.copyright, SearchParameter.copyrightLabel, SearchParameter.code, SearchParameter.base, SearchParameter.type, SearchParameter.expression, SearchParameter.processingMode, SearchParameter.processingMode.extension, SearchParameter.processingMode.extension:xpathUsage, SearchParameter.constraint, SearchParameter.target, SearchParameter.multipleOr, SearchParameter.multipleAnd, SearchParameter.comparator, SearchParameter.modifier, SearchParameter.chain, SearchParameter.component, SearchParameter.component.extension, SearchParameter.component.modifierExtension, SearchParameter.component.definition, SearchParameter.component.expression All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error SearchParameter.meta.extension, SearchParameter.meta.extension:meta, SearchParameter.text.extension, SearchParameter.text.extension:text, SearchParameter.extension, SearchParameter.extension:xpath, SearchParameter.modifierExtension, SearchParameter.contact.extension, SearchParameter.contact.extension:name, SearchParameter.contact.extension:telecom, SearchParameter.processingMode.extension, SearchParameter.processingMode.extension:xpathUsage, SearchParameter.component.extension, SearchParameter.component.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
spd-1 error SearchParameter If an expression is present, there SHALL be a processingMode expression.empty() or processingMode.exists()
spd-2 error SearchParameter Search parameters can only have chain names when the search parameter type is 'reference' chain.empty() or type = 'reference'
spd-3 error SearchParameter Search parameters comparator can only be used on type 'number', 'date', 'quantity' or 'special'. comparator.empty() or (type in ('number' | 'date' | 'quantity' | 'special'))
txt-1 error SearchParameter.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error SearchParameter.text.div The narrative SHALL have some non-whitespace content htmlChecks()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SearchParameter C 0..* SearchParameter(5.0.0) Search parameter for a resource
Constraints: cnl-0, spd-1, spd-2, spd-3
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:xpath 0..1 string DSTU2: XPath that extracts the values (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-SearchParameter.xpath
Constraints: ext-1
... url ΣC 1..1 uri Canonical identifier for this search parameter, represented as a URI (globally unique)
Constraints: cnl-1
... name ΣC 1..1 string Name for this search parameter (computer friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... description Σ 1..1 markdown Natural language description of the search parameter
... code Σ 1..1 code Recommended name for parameter in search url
... base Σ 1..* code The resource type(s) this search parameter applies to
Binding: VersionIndependentResourceTypesAll (required): A type of resource, or a Reference (from all versions)
Additional BindingsPurpose
AllResourceTypes UI Binding

... type ΣC 1..1 code number | date | string | token | reference | composite | quantity | uri | special
Binding: SearchParamType (required): Data types allowed to be used for search parameters.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
SearchParameter.status Base required PublicationStatus 📍5.0.0 FHIR Std.
SearchParameter.base Base required Version Independent Resource Types (All) 📍5.0.0 FHIR Std.
SearchParameter.type Base required SearchParamType 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cnl-0 warning SearchParameter Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
cnl-1 warning SearchParameter.url URL should not contain | or # - these characters make processing canonical references problematic exists() implies matches('^[^|# ]+$')
ele-1 error SearchParameter.implicitRules, SearchParameter.extension, SearchParameter.extension:xpath, SearchParameter.modifierExtension, SearchParameter.url, SearchParameter.name, SearchParameter.status, SearchParameter.description, SearchParameter.code, SearchParameter.base, SearchParameter.type All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error SearchParameter.extension, SearchParameter.extension:xpath, SearchParameter.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
spd-1 error SearchParameter If an expression is present, there SHALL be a processingMode expression.empty() or processingMode.exists()
spd-2 error SearchParameter Search parameters can only have chain names when the search parameter type is 'reference' chain.empty() or type = 'reference'
spd-3 error SearchParameter Search parameters comparator can only be used on type 'number', 'date', 'quantity' or 'special'. comparator.empty() or (type in ('number' | 'date' | 'quantity' | 'special'))

Differential View

This structure is derived from SearchParameter

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SearchParameter 0..* SearchParameter(5.0.0) Search parameter for a resource
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 Meta DSTU2: meta additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-SearchParameter.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) DSTU2: text additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-SearchParameter.text
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:xpath 0..1 string DSTU2: XPath that extracts the values (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-SearchParameter.xpath
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:name 0..1 string DSTU2: Name of a individual to contact (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-SearchParameter.contact.name
..... extension:telecom 0..* ContactPoint DSTU2: Contact details for individual or publisher (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-SearchParameter.contact.telecom
... processingMode
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:xpathUsage 0..1 code DSTU2: normal | phonetic | nearby | distance | other additional codes
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-SearchParameter.xpathUsage
Binding: SearchProcessingModeType (required): How a search parameter relates to the set of elements returned by evaluating its xpath query.

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SearchParameter C 0..* SearchParameter(5.0.0) Search parameter for a resource
Constraints: cnl-0, spd-1, spd-2, spd-3
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:meta 0..1 Meta DSTU2: meta additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-SearchParameter.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: AllSecurityLabels . (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:text 0..1 (Complex) DSTU2: text additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-SearchParameter.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required): The status of a resource narrative.
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:xpath 0..1 string DSTU2: XPath that extracts the values (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-SearchParameter.xpath
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... url ΣC 1..1 uri Canonical identifier for this search parameter, represented as a URI (globally unique)
Constraints: cnl-1
... identifier Σ 0..* Identifier Additional identifier for the search parameter (business identifier)
... version Σ 0..1 string Business version of the search parameter
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name ΣC 1..1 string Name for this search parameter (computer friendly)
... title Σ 0..1 string Name for this search parameter (human friendly)
... derivedFrom 0..1 canonical(SearchParameter) Original definition for the search parameter
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... 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/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:name 0..1 string DSTU2: Name of a individual to contact (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-SearchParameter.contact.name
Constraints: ext-1
..... extension:telecom 0..* ContactPoint DSTU2: Contact details for individual or publisher (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-SearchParameter.contact.telecom
Constraints: ext-1
.... name Σ 0..1 string Name of an individual to contact
.... telecom Σ 0..* ContactPoint Contact details for individual or organization
... 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)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... purpose 0..1 markdown Why this search parameter is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... copyrightLabel 0..1 string Copyright holder and year(s)
... code Σ 1..1 code Recommended name for parameter in search url
... base Σ 1..* code The resource type(s) this search parameter applies to
Binding: VersionIndependentResourceTypesAll (required): A type of resource, or a Reference (from all versions)
Additional BindingsPurpose
AllResourceTypes UI Binding

... type ΣC 1..1 code number | date | string | token | reference | composite | quantity | uri | special
Binding: SearchParamType (required): Data types allowed to be used for search parameters.
... expression C 0..1 string FHIRPath expression that extracts the values
... processingMode C 0..1 code normal | phonetic | other
Binding: SearchProcessingModeType (required): How a search parameter relates to the set of elements returned by evaluating its expression query.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:xpathUsage 0..1 code DSTU2: normal | phonetic | nearby | distance | other additional codes
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-SearchParameter.xpathUsage
Binding: SearchProcessingModeType (required): How a search parameter relates to the set of elements returned by evaluating its xpath query.
Constraints: ext-1
.... value 0..1 code Primitive value for code
... constraint 0..1 string FHIRPath expression that constraints the usage of this SearchParamete
... target 0..* code Types of resource (if a resource reference)
Binding: VersionIndependentResourceTypesAll (required): A type of resource, or a Reference (from all versions)
Additional BindingsPurpose
AllResourceTypes UI Binding

... multipleOr 0..1 boolean Allow multiple values per parameter (or)
... multipleAnd 0..1 boolean Allow multiple parameters (and)
... comparator C 0..* code eq | ne | gt | lt | ge | le | sa | eb | ap
Binding: SearchComparator (required): What Search Comparator Codes are supported in search.
... modifier 0..* code missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate
Binding: SearchModifierCode (required): A supported modifier for a search parameter.
... chain C 0..* string Chained names supported
... component 0..* BackboneElement For Composite resources to define the parts
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... definition 1..1 canonical(SearchParameter) Defines how the part works
.... expression 1..1 string Subexpression relative to main expression

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
SearchParameter.meta.​security Base extensible All Security Labels . 📍5.0.0 tx.fhir.org
SearchParameter.meta.​tag Base example Common Tags 📍5.0.0 FHIR Std.
SearchParameter.language Base required All Languages 📍5.0.0 FHIR Std.
SearchParameter.text.​status Base required NarrativeStatus 📍5.0.0 FHIR Std.
SearchParameter.versionAlgorithm[x] Base extensible Version Algorithm 📍5.0.0 FHIR Std.
SearchParameter.status Base required PublicationStatus 📍5.0.0 FHIR Std.
SearchParameter.jurisdiction Base extensible Jurisdiction ValueSet 📍5.0.0 FHIR Std.
SearchParameter.base Base required Version Independent Resource Types (All) 📍5.0.0 FHIR Std.
SearchParameter.type Base required SearchParamType 📍5.0.0 FHIR Std.
SearchParameter.processingMode Base required Search Processing Mode Type 📍5.0.0 FHIR Std.
SearchParameter.target Base required Version Independent Resource Types (All) 📍5.0.0 FHIR Std.
SearchParameter.comparator Base required Search Comparator 📍5.0.0 FHIR Std.
SearchParameter.modifier Base required Search Modifier Code 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cnl-0 warning SearchParameter Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
cnl-1 warning SearchParameter.url URL should not contain | or # - these characters make processing canonical references problematic exists() implies matches('^[^|# ]+$')
ele-1 error SearchParameter.meta, SearchParameter.meta.extension, SearchParameter.meta.extension:meta, SearchParameter.meta.versionId, SearchParameter.meta.lastUpdated, SearchParameter.meta.source, SearchParameter.meta.profile, SearchParameter.meta.security, SearchParameter.meta.tag, SearchParameter.implicitRules, SearchParameter.language, SearchParameter.text, SearchParameter.text.extension, SearchParameter.text.extension:text, SearchParameter.text.status, SearchParameter.text.div, SearchParameter.extension, SearchParameter.extension:xpath, SearchParameter.modifierExtension, SearchParameter.url, SearchParameter.identifier, SearchParameter.version, SearchParameter.versionAlgorithm[x], SearchParameter.name, SearchParameter.title, SearchParameter.derivedFrom, SearchParameter.status, SearchParameter.experimental, SearchParameter.date, SearchParameter.publisher, SearchParameter.contact, SearchParameter.contact.extension, SearchParameter.contact.extension:name, SearchParameter.contact.extension:telecom, SearchParameter.contact.name, SearchParameter.contact.telecom, SearchParameter.description, SearchParameter.useContext, SearchParameter.jurisdiction, SearchParameter.purpose, SearchParameter.copyright, SearchParameter.copyrightLabel, SearchParameter.code, SearchParameter.base, SearchParameter.type, SearchParameter.expression, SearchParameter.processingMode, SearchParameter.processingMode.extension, SearchParameter.processingMode.extension:xpathUsage, SearchParameter.constraint, SearchParameter.target, SearchParameter.multipleOr, SearchParameter.multipleAnd, SearchParameter.comparator, SearchParameter.modifier, SearchParameter.chain, SearchParameter.component, SearchParameter.component.extension, SearchParameter.component.modifierExtension, SearchParameter.component.definition, SearchParameter.component.expression All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error SearchParameter.meta.extension, SearchParameter.meta.extension:meta, SearchParameter.text.extension, SearchParameter.text.extension:text, SearchParameter.extension, SearchParameter.extension:xpath, SearchParameter.modifierExtension, SearchParameter.contact.extension, SearchParameter.contact.extension:name, SearchParameter.contact.extension:telecom, SearchParameter.processingMode.extension, SearchParameter.processingMode.extension:xpathUsage, SearchParameter.component.extension, SearchParameter.component.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
spd-1 error SearchParameter If an expression is present, there SHALL be a processingMode expression.empty() or processingMode.exists()
spd-2 error SearchParameter Search parameters can only have chain names when the search parameter type is 'reference' chain.empty() or type = 'reference'
spd-3 error SearchParameter Search parameters comparator can only be used on type 'number', 'date', 'quantity' or 'special'. comparator.empty() or (type in ('number' | 'date' | 'quantity' | 'special'))
txt-1 error SearchParameter.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error SearchParameter.text.div The narrative SHALL have some non-whitespace content htmlChecks()

 

Other representations of profile: CSV, Excel, Schematron