Extensions for Using Data Elements from FHIR R4B in FHIR STU3
0.1.0 - STU International flag

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

Resource Profile: Profile_R4B_SearchParameter_R3

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

This cross-version profile allows R4B SearchParameter content to be represented via FHIR STU3 SearchParameter resources.

Usages:

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 1..1 SearchParameter Search Parameter for a resource
Constraints: spd-1, spd-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:multipleOr 0..1 boolean R4B: Allow multiple values per parameter (or) (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.multipleOr
.... extension:multipleAnd 0..1 boolean R4B: Allow multiple parameters (and) (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.multipleAnd
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... name Σ 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 a Value Set or Concept Map.
... experimental ?!Σ 0..1 boolean For testing purposes, not real usage
... code Σ 1..1 code Code used in URL
... base Σ 1..* code The resource type(s) this search parameter applies to
Binding: ResourceType . (required): One of the resource types defined as part of FHIR.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:base 0..* code R4B: base additional codes
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.base
Binding: R4BResourceTypesForR3 (0.1.0) (required): One of the resource types defined as part of this version of FHIR.
... type Σ 1..1 code number | date | string | token | reference | composite | quantity | uri
Binding: SearchParamType (required): Data types allowed to be used for search parameters.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:type 0..1 code R4B: number | date | string | token | reference | composite | quantity | uri | special
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.type
Binding: SearchParamType (required): Data types allowed to be used for search parameters.
... description Σ 1..1 markdown Natural language description of the search parameter

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
SearchParameter.status Base required PublicationStatus 📍3.0.2 FHIR Std.
SearchParameter.base Base required ResourceType . 📍3.0.2 tx.fhir.org
SearchParameter.type Base required SearchParamType 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error SearchParameter If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error SearchParameter If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error SearchParameter If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4 error SearchParameter If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
spd-1 error SearchParameter If an xpath is present, there SHALL be an xpathUsage xpath.empty() or xpathUsage.exists()
spd-2 error SearchParameter Search parameters can only have chain names when the search parameter type is 'reference' chain.empty() or type = 'reference'

This structure is derived from SearchParameter

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SearchParameter 1..1 SearchParameter Search Parameter for a resource
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 Meta R4B: meta additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) R4B: text additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.text
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:multipleOr 0..1 boolean R4B: Allow multiple values per parameter (or) (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.multipleOr
.... extension:multipleAnd 0..1 boolean R4B: Allow multiple parameters (and) (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.multipleAnd
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:contact 0..* (Complex) R4B: contact additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.contact
... useContext
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:useContext 0..* (Complex) R4B: The context that the content is intended to support additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.useContext
... base
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:base 0..* code R4B: base additional codes
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.base
Binding: R4BResourceTypesForR3 (0.1.0) (required): One of the resource types defined as part of this version of FHIR.
... type
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:type 0..1 code R4B: number | date | string | token | reference | composite | quantity | uri | special
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.type
Binding: SearchParamType (required): Data types allowed to be used for search parameters.
... target
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:target 0..* code R4B: target additional codes
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.target
Binding: R4BResourceTypesForR3 (0.1.0) (required): One of the resource types defined as part of this version of FHIR.
... modifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:modifier 0..* code R4B: missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.modifier
Binding: SearchModifierCode (required): A supported modifier for a search parameter.
... component
.... definition
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:definition 0..1 uri R4B: definition additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.component.definition

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SearchParameter C 1..1 SearchParameter Search Parameter for a resource
Constraints: spd-1, spd-2
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 Meta R4B: meta additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.meta
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... profile Σ 0..* uri Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: Common Tags (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: Common Languages (extensible): A human language.
Additional BindingsPurpose
All Languages Max Binding
... 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 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) R4B: text additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.text
.... 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
.... extension:multipleOr 0..1 boolean R4B: Allow multiple values per parameter (or) (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.multipleOr
.... extension:multipleAnd 0..1 boolean R4B: Allow multiple parameters (and) (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.multipleAnd
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url Σ 1..1 uri Logical URI to reference this search parameter (globally unique)
... version Σ 0..1 string Business version of the search parameter
... name Σ 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 a Value Set or Concept Map.
... experimental ?!Σ 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date this was last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:contact 0..* (Complex) R4B: contact additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.contact
.... name Σ 0..1 string Name of an individual to contact
.... telecom Σ 0..* ContactPoint Contact details for individual or organization
... useContext Σ 0..* UsageContext Context the content is intended to support
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:useContext 0..* (Complex) R4B: The context that the content is intended to support additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.useContext
.... code Σ 1..1 Coding Type of context being specified
Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context
.... value[x] Σ 1..1 Value that defines the context
Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified
..... valueCodeableConcept CodeableConcept
..... valueQuantity Quantity
..... valueRange Range
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for search parameter (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use
... 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 to
Binding: ResourceType . (required): One of the resource types defined as part of FHIR.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:base 0..* code R4B: base additional codes
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.base
Binding: R4BResourceTypesForR3 (0.1.0) (required): One of the resource types defined as part of this version of FHIR.
.... value 0..1 code Primitive value for code
... type Σ 1..1 code number | date | string | token | reference | composite | quantity | uri
Binding: SearchParamType (required): Data types allowed to be used for search parameters.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:type 0..1 code R4B: number | date | string | token | reference | composite | quantity | uri | special
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.type
Binding: SearchParamType (required): Data types allowed to be used for search parameters.
.... value 0..1 code Primitive value for code
... derivedFrom 0..1 uri Original Definition for the search parameter
... description Σ 1..1 markdown Natural language description of the search parameter
... expression C 0..1 string FHIRPath expression that extracts the values
... xpath C 0..1 string XPath that extracts the values
... xpathUsage C 0..1 code normal | phonetic | nearby | distance | other
Binding: XPathUsageType (required): How a search parameter relates to the set of elements returned by evaluating its xpath query.
... target 0..* code Types of resource (if a resource reference)
Binding: ResourceType . (required): One of the resource types defined as part of FHIR.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:target 0..* code R4B: target additional codes
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.target
Binding: R4BResourceTypesForR3 (0.1.0) (required): One of the resource types defined as part of this version of FHIR.
.... value 0..1 code Primitive value for code
... comparator 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
Binding: SearchModifierCode (required): A supported modifier for a search parameter.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:modifier 0..* code R4B: missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.modifier
Binding: SearchModifierCode (required): A supported modifier for a search parameter.
.... value 0..1 code Primitive value for code
... chain 0..* string Chained names supported
... component 0..* BackboneElement For Composite resources to define the parts
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... definition 1..1 Reference(SearchParameter) Defines how the part works
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:definition 1..1 uri R4B: definition additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.component.definition
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... 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 📍3.0.2 FHIR Std.
SearchParameter.meta.​tag Base example Common Tags 📍3.0.2 FHIR Std.
SearchParameter.language Base extensible Common Languages 📍3.0.2 FHIR Std.
SearchParameter.text.​status Base required NarrativeStatus 📍3.0.2 FHIR Std.
SearchParameter.status Base required PublicationStatus 📍3.0.2 FHIR Std.
SearchParameter.useContext.​code Base extensible UsageContextType 📍3.0.2 FHIR Std.
SearchParameter.useContext.​value[x] Base example Context of Use ValueSet 📍3.0.2 FHIR Std.
SearchParameter.jurisdiction Base extensible Jurisdiction ValueSet 📍3.0.2 FHIR Std.
SearchParameter.base Base required ResourceType . 📍3.0.2 tx.fhir.org
SearchParameter.type Base required SearchParamType 📍3.0.2 FHIR Std.
SearchParameter.xpathUsage Base required XPathUsageType 📍3.0.2 FHIR Std.
SearchParameter.target Base required ResourceType . 📍3.0.2 tx.fhir.org
SearchParameter.comparator Base required SearchComparator 📍3.0.2 FHIR Std.
SearchParameter.modifier Base required SearchModifierCode 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error SearchParameter If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error SearchParameter If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error SearchParameter If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4 error SearchParameter If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
spd-1 error SearchParameter If an xpath is present, there SHALL be an xpathUsage xpath.empty() or xpathUsage.exists()
spd-2 error SearchParameter Search parameters can only have chain names when the search parameter type is 'reference' chain.empty() or type = 'reference'
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 1..1 SearchParameter Search Parameter for a resource
Constraints: spd-1, spd-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:multipleOr 0..1 boolean R4B: Allow multiple values per parameter (or) (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.multipleOr
.... extension:multipleAnd 0..1 boolean R4B: Allow multiple parameters (and) (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.multipleAnd
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... name Σ 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 a Value Set or Concept Map.
... experimental ?!Σ 0..1 boolean For testing purposes, not real usage
... code Σ 1..1 code Code used in URL
... base Σ 1..* code The resource type(s) this search parameter applies to
Binding: ResourceType . (required): One of the resource types defined as part of FHIR.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:base 0..* code R4B: base additional codes
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.base
Binding: R4BResourceTypesForR3 (0.1.0) (required): One of the resource types defined as part of this version of FHIR.
... type Σ 1..1 code number | date | string | token | reference | composite | quantity | uri
Binding: SearchParamType (required): Data types allowed to be used for search parameters.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:type 0..1 code R4B: number | date | string | token | reference | composite | quantity | uri | special
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.type
Binding: SearchParamType (required): Data types allowed to be used for search parameters.
... description Σ 1..1 markdown Natural language description of the search parameter

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
SearchParameter.status Base required PublicationStatus 📍3.0.2 FHIR Std.
SearchParameter.base Base required ResourceType . 📍3.0.2 tx.fhir.org
SearchParameter.type Base required SearchParamType 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error SearchParameter If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error SearchParameter If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error SearchParameter If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4 error SearchParameter If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
spd-1 error SearchParameter If an xpath is present, there SHALL be an xpathUsage xpath.empty() or xpathUsage.exists()
spd-2 error SearchParameter Search parameters can only have chain names when the search parameter type is 'reference' chain.empty() or type = 'reference'

Differential View

This structure is derived from SearchParameter

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SearchParameter 1..1 SearchParameter Search Parameter for a resource
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 Meta R4B: meta additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) R4B: text additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.text
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:multipleOr 0..1 boolean R4B: Allow multiple values per parameter (or) (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.multipleOr
.... extension:multipleAnd 0..1 boolean R4B: Allow multiple parameters (and) (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.multipleAnd
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:contact 0..* (Complex) R4B: contact additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.contact
... useContext
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:useContext 0..* (Complex) R4B: The context that the content is intended to support additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.useContext
... base
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:base 0..* code R4B: base additional codes
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.base
Binding: R4BResourceTypesForR3 (0.1.0) (required): One of the resource types defined as part of this version of FHIR.
... type
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:type 0..1 code R4B: number | date | string | token | reference | composite | quantity | uri | special
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.type
Binding: SearchParamType (required): Data types allowed to be used for search parameters.
... target
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:target 0..* code R4B: target additional codes
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.target
Binding: R4BResourceTypesForR3 (0.1.0) (required): One of the resource types defined as part of this version of FHIR.
... modifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:modifier 0..* code R4B: missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.modifier
Binding: SearchModifierCode (required): A supported modifier for a search parameter.
... component
.... definition
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:definition 0..1 uri R4B: definition additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.component.definition

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SearchParameter C 1..1 SearchParameter Search Parameter for a resource
Constraints: spd-1, spd-2
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 Meta R4B: meta additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.meta
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... profile Σ 0..* uri Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: Common Tags (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: Common Languages (extensible): A human language.
Additional BindingsPurpose
All Languages Max Binding
... 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 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) R4B: text additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.text
.... 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
.... extension:multipleOr 0..1 boolean R4B: Allow multiple values per parameter (or) (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.multipleOr
.... extension:multipleAnd 0..1 boolean R4B: Allow multiple parameters (and) (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.multipleAnd
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url Σ 1..1 uri Logical URI to reference this search parameter (globally unique)
... version Σ 0..1 string Business version of the search parameter
... name Σ 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 a Value Set or Concept Map.
... experimental ?!Σ 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date this was last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:contact 0..* (Complex) R4B: contact additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.contact
.... name Σ 0..1 string Name of an individual to contact
.... telecom Σ 0..* ContactPoint Contact details for individual or organization
... useContext Σ 0..* UsageContext Context the content is intended to support
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:useContext 0..* (Complex) R4B: The context that the content is intended to support additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.useContext
.... code Σ 1..1 Coding Type of context being specified
Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context
.... value[x] Σ 1..1 Value that defines the context
Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified
..... valueCodeableConcept CodeableConcept
..... valueQuantity Quantity
..... valueRange Range
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for search parameter (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use
... 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 to
Binding: ResourceType . (required): One of the resource types defined as part of FHIR.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:base 0..* code R4B: base additional codes
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.base
Binding: R4BResourceTypesForR3 (0.1.0) (required): One of the resource types defined as part of this version of FHIR.
.... value 0..1 code Primitive value for code
... type Σ 1..1 code number | date | string | token | reference | composite | quantity | uri
Binding: SearchParamType (required): Data types allowed to be used for search parameters.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:type 0..1 code R4B: number | date | string | token | reference | composite | quantity | uri | special
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.type
Binding: SearchParamType (required): Data types allowed to be used for search parameters.
.... value 0..1 code Primitive value for code
... derivedFrom 0..1 uri Original Definition for the search parameter
... description Σ 1..1 markdown Natural language description of the search parameter
... expression C 0..1 string FHIRPath expression that extracts the values
... xpath C 0..1 string XPath that extracts the values
... xpathUsage C 0..1 code normal | phonetic | nearby | distance | other
Binding: XPathUsageType (required): How a search parameter relates to the set of elements returned by evaluating its xpath query.
... target 0..* code Types of resource (if a resource reference)
Binding: ResourceType . (required): One of the resource types defined as part of FHIR.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:target 0..* code R4B: target additional codes
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.target
Binding: R4BResourceTypesForR3 (0.1.0) (required): One of the resource types defined as part of this version of FHIR.
.... value 0..1 code Primitive value for code
... comparator 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
Binding: SearchModifierCode (required): A supported modifier for a search parameter.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:modifier 0..* code R4B: missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.modifier
Binding: SearchModifierCode (required): A supported modifier for a search parameter.
.... value 0..1 code Primitive value for code
... chain 0..* string Chained names supported
... component 0..* BackboneElement For Composite resources to define the parts
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... definition 1..1 Reference(SearchParameter) Defines how the part works
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:definition 1..1 uri R4B: definition additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-SearchParameter.component.definition
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... 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 📍3.0.2 FHIR Std.
SearchParameter.meta.​tag Base example Common Tags 📍3.0.2 FHIR Std.
SearchParameter.language Base extensible Common Languages 📍3.0.2 FHIR Std.
SearchParameter.text.​status Base required NarrativeStatus 📍3.0.2 FHIR Std.
SearchParameter.status Base required PublicationStatus 📍3.0.2 FHIR Std.
SearchParameter.useContext.​code Base extensible UsageContextType 📍3.0.2 FHIR Std.
SearchParameter.useContext.​value[x] Base example Context of Use ValueSet 📍3.0.2 FHIR Std.
SearchParameter.jurisdiction Base extensible Jurisdiction ValueSet 📍3.0.2 FHIR Std.
SearchParameter.base Base required ResourceType . 📍3.0.2 tx.fhir.org
SearchParameter.type Base required SearchParamType 📍3.0.2 FHIR Std.
SearchParameter.xpathUsage Base required XPathUsageType 📍3.0.2 FHIR Std.
SearchParameter.target Base required ResourceType . 📍3.0.2 tx.fhir.org
SearchParameter.comparator Base required SearchComparator 📍3.0.2 FHIR Std.
SearchParameter.modifier Base required SearchModifierCode 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error SearchParameter If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error SearchParameter If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error SearchParameter If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4 error SearchParameter If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
spd-1 error SearchParameter If an xpath is present, there SHALL be an xpathUsage xpath.empty() or xpathUsage.exists()
spd-2 error SearchParameter Search parameters can only have chain names when the search parameter type is 'reference' chain.empty() or type = 'reference'
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