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

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

Resource Profile: Profile_R3_SearchParameter_R4B

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

This cross-version profile allows STU3 SearchParameter content to be represented via FHIR R4B 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 0..* SearchParameter(4.3.0) Search parameter for a resource
Constraints: spd-0, spd-1, spd-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... url Σ 1..1 uri Canonical identifier for this search parameter, represented as a URI (globally unique)
... 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 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 this version of FHIR.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:base 0..* code STU3: base additional codes
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-SearchParameter.base
Binding: R3ResourceTypesForR4B (0.1.0) (required): One of the resource types defined as part of FHIR.
Constraints: ext-1
... type Σ 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 📍4.3.0 FHIR Std.
SearchParameter.base Base required ResourceType 📍4.3.0 FHIR Std.
SearchParameter.type Base required SearchParamType 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 or SHALL refer to the containing resource contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).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()
dom-5 error SearchParameter If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice SearchParameter A resource should have narrative for robust management text.`div`.exists()
ele-1 error SearchParameter.implicitRules, SearchParameter.modifierExtension, SearchParameter.url, SearchParameter.name, SearchParameter.status, SearchParameter.description, SearchParameter.code, SearchParameter.base, SearchParameter.base.extension, SearchParameter.base.extension:base, SearchParameter.type All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error SearchParameter.modifierExtension, SearchParameter.base.extension, SearchParameter.base.extension:base Must have either extensions or value[x], not both extension.exists() != value.exists()
spd-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_]){0,254}')
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 0..* SearchParameter(4.3.0) Search parameter for a resource
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-SearchParameter.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-SearchParameter.text
... contact
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:contact 0..* ContactDetail STU3: contact additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-SearchParameter.contact
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:useContext 0..* UsageContext STU3: Context the content is intended to support additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-SearchParameter.useContext
... base
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:base 0..* code STU3: base additional codes
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-SearchParameter.base
Binding: R3ResourceTypesForR4B (0.1.0) (required): One of the resource types defined as part of FHIR.
... target
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:target 0..* code STU3: target additional codes
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-SearchParameter.target
Binding: R3ResourceTypesForR4B (0.1.0) (required): One of the resource types defined as part of FHIR.
... component
.... definition
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:definition 0..1 Reference(Cross-version Profile for STU3.SearchParameter for use in FHIR R4B(0.1.0) | SearchParameter) STU3: definition additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-SearchParameter.component.definition

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SearchParameter C 0..* SearchParameter(4.3.0) Search parameter for a resource
Constraints: spd-0, spd-1, spd-2
... 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 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.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: All Security Labels (extensible)
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): IETF language tag
Additional BindingsPurpose
AllLanguages 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 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) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-SearchParameter.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required)
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... url Σ 1..1 uri Canonical identifier for this search parameter, represented as a URI (globally unique)
... version Σ 0..1 string Business version of the search parameter
... name Σ 1..1 string Name for this search parameter (computer friendly)
... derivedFrom 0..1 canonical(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 (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:contact 0..* ContactDetail STU3: contact additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-SearchParameter.contact
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
.... 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:useContext 0..* UsageContext STU3: Context the content is intended to support additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-SearchParameter.useContext
Constraints: ext-1
.... code Σ 1..1 Coding Type of context being specified
Binding: UsageContextType (extensible)
.... value[x] Σ 1..1 Value that defines the context
Binding: Context of Use ValueSet (example)
..... valueCodeableConcept CodeableConcept
..... valueQuantity Quantity
..... valueRange Range
..... valueReference Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization)
... 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 this version of FHIR.
.... 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:base 0..* code STU3: base additional codes
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-SearchParameter.base
Binding: R3ResourceTypesForR4B (0.1.0) (required): One of the resource types defined as part of FHIR.
Constraints: ext-1
.... value 0..1 code Primitive value for code
... type Σ 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
... 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 this version of FHIR.
.... 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:target 0..* code STU3: target additional codes
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-SearchParameter.target
Binding: R3ResourceTypesForR4B (0.1.0) (required): One of the resource types defined as part of FHIR.
Constraints: ext-1
.... value 0..1 code Primitive value for code
... multipleOr 0..1 boolean Allow multiple values per parameter (or)
... multipleAnd 0..1 boolean Allow multiple parameters (and)
... comparator 0..* code eq | ne | gt | lt | ge | le | sa | eb | 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 | ofType
Binding: SearchModifierCode (required): A supported modifier for a search parameter.
... chain 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
..... 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:definition 0..1 Reference(Cross-version Profile for STU3.SearchParameter for use in FHIR R4B(0.1.0) | SearchParameter) STU3: definition additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-SearchParameter.component.definition
Constraints: ext-1
..... value 0..1 canonical Primitive value for canonical
.... 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 SecurityLabels 📍4.3.0 FHIR Std.
SearchParameter.meta.​tag Base example Common Tags 📍4.3.0 FHIR Std.
SearchParameter.language Base preferred Common Languages 📍4.3.0 FHIR Std.
SearchParameter.text.​status Base required NarrativeStatus 📍4.3.0 FHIR Std.
SearchParameter.status Base required PublicationStatus 📍4.3.0 FHIR Std.
SearchParameter.useContext.​code Base extensible UsageContextType 📍4.3.0 FHIR Std.
SearchParameter.useContext.​value[x] Base example ConformanceUseContext 📍4.3.0 FHIR Std.
SearchParameter.jurisdiction Base extensible Jurisdiction 📍4.3.0 FHIR Std.
SearchParameter.base Base required ResourceType 📍4.3.0 FHIR Std.
SearchParameter.type Base required SearchParamType 📍4.3.0 FHIR Std.
SearchParameter.xpathUsage Base required XPathUsageType 📍4.3.0 FHIR Std.
SearchParameter.target Base required ResourceType 📍4.3.0 FHIR Std.
SearchParameter.comparator Base required SearchComparator 📍4.3.0 FHIR Std.
SearchParameter.modifier Base required SearchModifierCode 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 or SHALL refer to the containing resource contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).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()
dom-5 error SearchParameter If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice SearchParameter A resource should have narrative for robust management text.`div`.exists()
dom-r4b warning SearchParameter.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
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.modifierExtension, SearchParameter.url, SearchParameter.version, SearchParameter.name, SearchParameter.derivedFrom, SearchParameter.status, SearchParameter.experimental, SearchParameter.date, SearchParameter.publisher, SearchParameter.contact, SearchParameter.contact.extension, SearchParameter.contact.extension:contact, SearchParameter.contact.name, SearchParameter.contact.telecom, SearchParameter.description, SearchParameter.useContext, SearchParameter.useContext.extension, SearchParameter.useContext.extension:useContext, SearchParameter.useContext.code, SearchParameter.useContext.value[x], SearchParameter.jurisdiction, SearchParameter.purpose, SearchParameter.code, SearchParameter.base, SearchParameter.base.extension, SearchParameter.base.extension:base, SearchParameter.type, SearchParameter.expression, SearchParameter.xpath, SearchParameter.xpathUsage, SearchParameter.target, SearchParameter.target.extension, SearchParameter.target.extension:target, SearchParameter.multipleOr, SearchParameter.multipleAnd, SearchParameter.comparator, SearchParameter.modifier, SearchParameter.chain, SearchParameter.component, SearchParameter.component.extension, SearchParameter.component.modifierExtension, SearchParameter.component.definition, SearchParameter.component.definition.extension, SearchParameter.component.definition.extension: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.modifierExtension, SearchParameter.contact.extension, SearchParameter.contact.extension:contact, SearchParameter.useContext.extension, SearchParameter.useContext.extension:useContext, SearchParameter.base.extension, SearchParameter.base.extension:base, SearchParameter.target.extension, SearchParameter.target.extension:target, SearchParameter.component.extension, SearchParameter.component.modifierExtension, SearchParameter.component.definition.extension, SearchParameter.component.definition.extension:definition Must have either extensions or value[x], not both extension.exists() != value.exists()
spd-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_]){0,254}')
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 0..* SearchParameter(4.3.0) Search parameter for a resource
Constraints: spd-0, spd-1, spd-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... url Σ 1..1 uri Canonical identifier for this search parameter, represented as a URI (globally unique)
... 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 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 this version of FHIR.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:base 0..* code STU3: base additional codes
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-SearchParameter.base
Binding: R3ResourceTypesForR4B (0.1.0) (required): One of the resource types defined as part of FHIR.
Constraints: ext-1
... type Σ 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 📍4.3.0 FHIR Std.
SearchParameter.base Base required ResourceType 📍4.3.0 FHIR Std.
SearchParameter.type Base required SearchParamType 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 or SHALL refer to the containing resource contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).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()
dom-5 error SearchParameter If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice SearchParameter A resource should have narrative for robust management text.`div`.exists()
ele-1 error SearchParameter.implicitRules, SearchParameter.modifierExtension, SearchParameter.url, SearchParameter.name, SearchParameter.status, SearchParameter.description, SearchParameter.code, SearchParameter.base, SearchParameter.base.extension, SearchParameter.base.extension:base, SearchParameter.type All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error SearchParameter.modifierExtension, SearchParameter.base.extension, SearchParameter.base.extension:base Must have either extensions or value[x], not both extension.exists() != value.exists()
spd-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_]){0,254}')
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 0..* SearchParameter(4.3.0) Search parameter for a resource
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-SearchParameter.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-SearchParameter.text
... contact
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:contact 0..* ContactDetail STU3: contact additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-SearchParameter.contact
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:useContext 0..* UsageContext STU3: Context the content is intended to support additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-SearchParameter.useContext
... base
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:base 0..* code STU3: base additional codes
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-SearchParameter.base
Binding: R3ResourceTypesForR4B (0.1.0) (required): One of the resource types defined as part of FHIR.
... target
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:target 0..* code STU3: target additional codes
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-SearchParameter.target
Binding: R3ResourceTypesForR4B (0.1.0) (required): One of the resource types defined as part of FHIR.
... component
.... definition
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:definition 0..1 Reference(Cross-version Profile for STU3.SearchParameter for use in FHIR R4B(0.1.0) | SearchParameter) STU3: definition additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-SearchParameter.component.definition

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SearchParameter C 0..* SearchParameter(4.3.0) Search parameter for a resource
Constraints: spd-0, spd-1, spd-2
... 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 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.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: All Security Labels (extensible)
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): IETF language tag
Additional BindingsPurpose
AllLanguages 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 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) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-SearchParameter.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required)
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... url Σ 1..1 uri Canonical identifier for this search parameter, represented as a URI (globally unique)
... version Σ 0..1 string Business version of the search parameter
... name Σ 1..1 string Name for this search parameter (computer friendly)
... derivedFrom 0..1 canonical(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 (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:contact 0..* ContactDetail STU3: contact additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-SearchParameter.contact
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
.... 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:useContext 0..* UsageContext STU3: Context the content is intended to support additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-SearchParameter.useContext
Constraints: ext-1
.... code Σ 1..1 Coding Type of context being specified
Binding: UsageContextType (extensible)
.... value[x] Σ 1..1 Value that defines the context
Binding: Context of Use ValueSet (example)
..... valueCodeableConcept CodeableConcept
..... valueQuantity Quantity
..... valueRange Range
..... valueReference Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization)
... 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 this version of FHIR.
.... 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:base 0..* code STU3: base additional codes
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-SearchParameter.base
Binding: R3ResourceTypesForR4B (0.1.0) (required): One of the resource types defined as part of FHIR.
Constraints: ext-1
.... value 0..1 code Primitive value for code
... type Σ 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
... 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 this version of FHIR.
.... 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:target 0..* code STU3: target additional codes
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-SearchParameter.target
Binding: R3ResourceTypesForR4B (0.1.0) (required): One of the resource types defined as part of FHIR.
Constraints: ext-1
.... value 0..1 code Primitive value for code
... multipleOr 0..1 boolean Allow multiple values per parameter (or)
... multipleAnd 0..1 boolean Allow multiple parameters (and)
... comparator 0..* code eq | ne | gt | lt | ge | le | sa | eb | 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 | ofType
Binding: SearchModifierCode (required): A supported modifier for a search parameter.
... chain 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
..... 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:definition 0..1 Reference(Cross-version Profile for STU3.SearchParameter for use in FHIR R4B(0.1.0) | SearchParameter) STU3: definition additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-SearchParameter.component.definition
Constraints: ext-1
..... value 0..1 canonical Primitive value for canonical
.... 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 SecurityLabels 📍4.3.0 FHIR Std.
SearchParameter.meta.​tag Base example Common Tags 📍4.3.0 FHIR Std.
SearchParameter.language Base preferred Common Languages 📍4.3.0 FHIR Std.
SearchParameter.text.​status Base required NarrativeStatus 📍4.3.0 FHIR Std.
SearchParameter.status Base required PublicationStatus 📍4.3.0 FHIR Std.
SearchParameter.useContext.​code Base extensible UsageContextType 📍4.3.0 FHIR Std.
SearchParameter.useContext.​value[x] Base example ConformanceUseContext 📍4.3.0 FHIR Std.
SearchParameter.jurisdiction Base extensible Jurisdiction 📍4.3.0 FHIR Std.
SearchParameter.base Base required ResourceType 📍4.3.0 FHIR Std.
SearchParameter.type Base required SearchParamType 📍4.3.0 FHIR Std.
SearchParameter.xpathUsage Base required XPathUsageType 📍4.3.0 FHIR Std.
SearchParameter.target Base required ResourceType 📍4.3.0 FHIR Std.
SearchParameter.comparator Base required SearchComparator 📍4.3.0 FHIR Std.
SearchParameter.modifier Base required SearchModifierCode 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 or SHALL refer to the containing resource contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).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()
dom-5 error SearchParameter If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice SearchParameter A resource should have narrative for robust management text.`div`.exists()
dom-r4b warning SearchParameter.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
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.modifierExtension, SearchParameter.url, SearchParameter.version, SearchParameter.name, SearchParameter.derivedFrom, SearchParameter.status, SearchParameter.experimental, SearchParameter.date, SearchParameter.publisher, SearchParameter.contact, SearchParameter.contact.extension, SearchParameter.contact.extension:contact, SearchParameter.contact.name, SearchParameter.contact.telecom, SearchParameter.description, SearchParameter.useContext, SearchParameter.useContext.extension, SearchParameter.useContext.extension:useContext, SearchParameter.useContext.code, SearchParameter.useContext.value[x], SearchParameter.jurisdiction, SearchParameter.purpose, SearchParameter.code, SearchParameter.base, SearchParameter.base.extension, SearchParameter.base.extension:base, SearchParameter.type, SearchParameter.expression, SearchParameter.xpath, SearchParameter.xpathUsage, SearchParameter.target, SearchParameter.target.extension, SearchParameter.target.extension:target, SearchParameter.multipleOr, SearchParameter.multipleAnd, SearchParameter.comparator, SearchParameter.modifier, SearchParameter.chain, SearchParameter.component, SearchParameter.component.extension, SearchParameter.component.modifierExtension, SearchParameter.component.definition, SearchParameter.component.definition.extension, SearchParameter.component.definition.extension: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.modifierExtension, SearchParameter.contact.extension, SearchParameter.contact.extension:contact, SearchParameter.useContext.extension, SearchParameter.useContext.extension:useContext, SearchParameter.base.extension, SearchParameter.base.extension:base, SearchParameter.target.extension, SearchParameter.target.extension:target, SearchParameter.component.extension, SearchParameter.component.modifierExtension, SearchParameter.component.definition.extension, SearchParameter.component.definition.extension:definition Must have either extensions or value[x], not both extension.exists() != value.exists()
spd-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_]){0,254}')
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