Content Repository Management Infrastructure Implementation Guide
3.0.0-ballot - STU 3 Ballot International flag

Content Repository Management Infrastructure Implementation Guide, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/crmi-ig/ and changes regularly. See the Directory of published versions

Resource Profile: CRMI Publishable SearchParameter

Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishablesearchparameter Version: 3.0.0-ballot
Standards status: Trial-use Maturity Level: 1 Computable Name: CRMIPublishableSearchParameter
Other Identifiers: OID:2.16.840.1.113883.4.642.40.38.42.42

Supports declaration of the SearchParameter metadata required by HL7 and other organizations that share and publish search parameters with a focus on the aspects of that metadata that are important for post-publication activities including distribution, inclusion in repositories, consumption, and implementation.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
SearchParameter C 1..1 SearchParameter Search parameter for a resource
Constraints: spd-0, spd-1, spd-2, pub-1
SearchParameter.meta This element is included in summaries. 0..1 Meta Metadata about the resource
SearchParameter.meta.Slices for extension Content/Rules for all slices
SearchParameter.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
SearchParameter.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
SearchParameter.Slices for extension Content/Rules for all slices
SearchParameter.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
SearchParameter.Slices for extension.extension:identifier This element must be supported. 0..* Identifier Additional identifier for the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
SearchParameter.Slices for extension.extension:usage This element must be supported. 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
SearchParameter.Slices for extension.extension:copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
SearchParameter.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
SearchParameter.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
SearchParameter.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
SearchParameter.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
SearchParameter.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
SearchParameter.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
SearchParameter.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
SearchParameter.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
SearchParameter.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
SearchParameter.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
SearchParameter.Slices for extension.extension:relatedArtifact.extension 0..0 Extension
Slice: Unordered, Open by value:url
SearchParameter.Slices for extension.extension:relatedArtifact.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
SearchParameter.Slices for extension.extension:relatedArtifact.value[x] 1..1 RelatedArtifact Value of extension
SearchParameter.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
SearchParameter.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
SearchParameter.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
SearchParameter.Slices for extension.extension:relatedArtifact.value[x].type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
SearchParameter.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
SearchParameter.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
SearchParameter.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
SearchParameter.url This element is included in summaries. 1..1 uri Canonical identifier for this search parameter, represented as a URI (globally unique)
SearchParameter.name This element is included in summaries. C 1..1 string Name for this search parameter (computer friendly)
SearchParameter.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
SearchParameter.date This element must be supported. This element is included in summaries. 1..1 dateTime Date last changed
SearchParameter.contact This element must be supported. This element is included in summaries. 0..* ContactDetail Contact details for the publisher
SearchParameter.description This element is included in summaries. 1..1 markdown Natural language description of the search parameter
SearchParameter.useContext This element must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
SearchParameter.jurisdiction This element must be supported. This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for search parameter (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
SearchParameter.purpose This element must be supported. 0..1 markdown Why this search parameter is defined
SearchParameter.code This element is included in summaries. 1..1 code Code used in URL
SearchParameter.base This element is included in summaries. 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.
SearchParameter.type This element is included in summaries. 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.extension:relatedArtifact.​value[x].type Base required RelatedArtifactType 📍4.0.1 FHIR Std.
SearchParameter.status Base required PublicationStatus 📍4.0.1 FHIR Std.
SearchParameter.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
SearchParameter.base Base required ResourceType 📍4.0.1 FHIR Std.
SearchParameter.type Base required SearchParamType 📍4.0.1 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 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(canonical) = '#').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 **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pub-1 error SearchParameter If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()
spd-0 warning SearchParameter Name should be usable as an identifier for the module by machine processing applications such as code generation 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: doco
SearchParameter C 1..1 SearchParameter Search parameter for a resource
Constraints: pub-1
SearchParameter.meta
SearchParameter.meta.Slices for extension Content/Rules for all slices
SearchParameter.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
SearchParameter.Slices for extension Content/Rules for all slices
SearchParameter.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
SearchParameter.Slices for extension.extension:identifier This element must be supported. 0..* Identifier Additional identifier for the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
SearchParameter.Slices for extension.extension:usage This element must be supported. 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
SearchParameter.Slices for extension.extension:copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
SearchParameter.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
SearchParameter.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
SearchParameter.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
SearchParameter.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
SearchParameter.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
SearchParameter.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
SearchParameter.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
SearchParameter.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
SearchParameter.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
SearchParameter.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
SearchParameter.Slices for extension.extension:relatedArtifact.value[x]
SearchParameter.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
SearchParameter.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
SearchParameter.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
SearchParameter.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
SearchParameter.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
SearchParameter.date This element must be supported. 1..1 dateTime Date last changed
SearchParameter.useContext This element must be supported. 0..* UsageContext The context that the content is intended to support
SearchParameter.jurisdiction This element must be supported. 0..* CodeableConcept Intended jurisdiction for search parameter (if applicable)
SearchParameter.purpose This element must be supported. 0..1 markdown Why this search parameter is defined

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
pub-1 error SearchParameter If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()
NameFlagsCard.TypeDescription & Constraints    Filter: doco
SearchParameter C 1..1 SearchParameter Search parameter for a resource
Constraints: spd-0, spd-1, spd-2, pub-1
SearchParameter.id This element is included in summaries. 0..1 id Logical id of this artifact
SearchParameter.meta This element is included in summaries. 0..1 Meta Metadata about the resource
SearchParameter.meta.id 0..1 string Unique id for inter-element referencing
SearchParameter.meta.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
SearchParameter.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
SearchParameter.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
SearchParameter.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource version last changed
SearchParameter.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
SearchParameter.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
SearchParameter.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
SearchParameter.meta.tag This element is included in summaries. 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".
SearchParameter.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
SearchParameter.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
SearchParameter.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
SearchParameter.contained 0..* Resource Contained, inline Resources
SearchParameter.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
SearchParameter.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
SearchParameter.Slices for extension.extension:identifier This element must be supported. 0..* Identifier Additional identifier for the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
SearchParameter.Slices for extension.extension:usage This element must be supported. 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
SearchParameter.Slices for extension.extension:copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
SearchParameter.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
SearchParameter.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
SearchParameter.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
SearchParameter.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
SearchParameter.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
SearchParameter.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
SearchParameter.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
SearchParameter.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
SearchParameter.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
SearchParameter.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
SearchParameter.Slices for extension.extension:relatedArtifact.id 0..1 string Unique id for inter-element referencing
SearchParameter.Slices for extension.extension:relatedArtifact.extension 0..0 Extension
Slice: Unordered, Open by value:url
SearchParameter.Slices for extension.extension:relatedArtifact.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
SearchParameter.Slices for extension.extension:relatedArtifact.value[x] 1..1 RelatedArtifact Value of extension
SearchParameter.Slices for extension.extension:relatedArtifact.value[x].id 0..1 string Unique id for inter-element referencing
SearchParameter.Slices for extension.extension:relatedArtifact.value[x].Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
SearchParameter.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
SearchParameter.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
SearchParameter.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
SearchParameter.Slices for extension.extension:relatedArtifact.value[x].type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
SearchParameter.Slices for extension.extension:relatedArtifact.value[x].label This element is included in summaries. 0..1 string Short label
SearchParameter.Slices for extension.extension:relatedArtifact.value[x].display This element is included in summaries. 0..1 string Brief description of the related artifact
SearchParameter.Slices for extension.extension:relatedArtifact.value[x].citation This element is included in summaries. 0..1 markdown Bibliographic citation for the artifact
SearchParameter.Slices for extension.extension:relatedArtifact.value[x].url This element is included in summaries. 0..1 url Where the artifact can be accessed
SearchParameter.Slices for extension.extension:relatedArtifact.value[x].document This element is included in summaries. 0..1 Attachment What document is being referenced
SearchParameter.Slices for extension.extension:relatedArtifact.value[x].resource This element is included in summaries. 0..1 canonical(Resource) What resource is being referenced
SearchParameter.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
SearchParameter.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
SearchParameter.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
SearchParameter.url This element is included in summaries. 1..1 uri Canonical identifier for this search parameter, represented as a URI (globally unique)
SearchParameter.version This element is included in summaries. 0..1 string Business version of the search parameter
SearchParameter.name This element is included in summaries. C 1..1 string Name for this search parameter (computer friendly)
SearchParameter.derivedFrom 0..1 canonical(SearchParameter) Original definition for the search parameter
SearchParameter.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
SearchParameter.experimental This element is included in summaries. 0..1 boolean For testing purposes, not real usage
SearchParameter.date This element must be supported. This element is included in summaries. 1..1 dateTime Date last changed
SearchParameter.publisher This element is included in summaries. 0..1 string Name of the publisher (organization or individual)
SearchParameter.contact This element must be supported. This element is included in summaries. 0..* ContactDetail Contact details for the publisher
SearchParameter.description This element is included in summaries. 1..1 markdown Natural language description of the search parameter
SearchParameter.useContext This element must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
SearchParameter.jurisdiction This element must be supported. This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for search parameter (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
SearchParameter.purpose This element must be supported. 0..1 markdown Why this search parameter is defined
SearchParameter.code This element is included in summaries. 1..1 code Code used in URL
SearchParameter.base This element is included in summaries. 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.
SearchParameter.type This element is included in summaries. 1..1 code number | date | string | token | reference | composite | quantity | uri | special
Binding: SearchParamType (required): Data types allowed to be used for search parameters.
SearchParameter.expression C 0..1 string FHIRPath expression that extracts the values
SearchParameter.xpath C 0..1 string XPath that extracts the values
SearchParameter.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.
SearchParameter.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.
SearchParameter.multipleOr 0..1 boolean Allow multiple values per parameter (or)
SearchParameter.multipleAnd 0..1 boolean Allow multiple parameters (and)
SearchParameter.comparator 0..* code eq | ne | gt | lt | ge | le | sa | eb | ap
Binding: SearchComparator (required): What Search Comparator Codes are supported in search.
SearchParameter.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.
SearchParameter.chain 0..* string Chained names supported
SearchParameter.component 0..* BackboneElement For Composite resources to define the parts
SearchParameter.component.id 0..1 string Unique id for inter-element referencing
SearchParameter.component.extension 0..* Extension Additional content defined by implementations
SearchParameter.component.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
SearchParameter.component.definition 1..1 canonical(SearchParameter) Defines how the part works
SearchParameter.component.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.0.1 FHIR Std.
SearchParameter.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
SearchParameter.language Base preferred Common Languages 📍4.0.1 FHIR Std.
SearchParameter.extension:relatedArtifact.​value[x].type Base required RelatedArtifactType 📍4.0.1 FHIR Std.
SearchParameter.status Base required PublicationStatus 📍4.0.1 FHIR Std.
SearchParameter.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
SearchParameter.base Base required ResourceType 📍4.0.1 FHIR Std.
SearchParameter.type Base required SearchParamType 📍4.0.1 FHIR Std.
SearchParameter.xpathUsage Base required XPathUsageType 📍4.0.1 FHIR Std.
SearchParameter.target Base required ResourceType 📍4.0.1 FHIR Std.
SearchParameter.comparator Base required SearchComparator 📍4.0.1 FHIR Std.
SearchParameter.modifier Base required SearchModifierCode 📍4.0.1 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 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(canonical) = '#').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 **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pub-1 error SearchParameter If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()
spd-0 warning SearchParameter Name should be usable as an identifier for the module by machine processing applications such as code generation 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'

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
SearchParameter C 1..1 SearchParameter Search parameter for a resource
Constraints: spd-0, spd-1, spd-2, pub-1
SearchParameter.meta This element is included in summaries. 0..1 Meta Metadata about the resource
SearchParameter.meta.Slices for extension Content/Rules for all slices
SearchParameter.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
SearchParameter.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
SearchParameter.Slices for extension Content/Rules for all slices
SearchParameter.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
SearchParameter.Slices for extension.extension:identifier This element must be supported. 0..* Identifier Additional identifier for the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
SearchParameter.Slices for extension.extension:usage This element must be supported. 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
SearchParameter.Slices for extension.extension:copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
SearchParameter.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
SearchParameter.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
SearchParameter.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
SearchParameter.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
SearchParameter.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
SearchParameter.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
SearchParameter.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
SearchParameter.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
SearchParameter.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
SearchParameter.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
SearchParameter.Slices for extension.extension:relatedArtifact.extension 0..0 Extension
Slice: Unordered, Open by value:url
SearchParameter.Slices for extension.extension:relatedArtifact.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
SearchParameter.Slices for extension.extension:relatedArtifact.value[x] 1..1 RelatedArtifact Value of extension
SearchParameter.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
SearchParameter.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
SearchParameter.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
SearchParameter.Slices for extension.extension:relatedArtifact.value[x].type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
SearchParameter.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
SearchParameter.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
SearchParameter.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
SearchParameter.url This element is included in summaries. 1..1 uri Canonical identifier for this search parameter, represented as a URI (globally unique)
SearchParameter.name This element is included in summaries. C 1..1 string Name for this search parameter (computer friendly)
SearchParameter.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
SearchParameter.date This element must be supported. This element is included in summaries. 1..1 dateTime Date last changed
SearchParameter.contact This element must be supported. This element is included in summaries. 0..* ContactDetail Contact details for the publisher
SearchParameter.description This element is included in summaries. 1..1 markdown Natural language description of the search parameter
SearchParameter.useContext This element must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
SearchParameter.jurisdiction This element must be supported. This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for search parameter (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
SearchParameter.purpose This element must be supported. 0..1 markdown Why this search parameter is defined
SearchParameter.code This element is included in summaries. 1..1 code Code used in URL
SearchParameter.base This element is included in summaries. 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.
SearchParameter.type This element is included in summaries. 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.extension:relatedArtifact.​value[x].type Base required RelatedArtifactType 📍4.0.1 FHIR Std.
SearchParameter.status Base required PublicationStatus 📍4.0.1 FHIR Std.
SearchParameter.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
SearchParameter.base Base required ResourceType 📍4.0.1 FHIR Std.
SearchParameter.type Base required SearchParamType 📍4.0.1 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 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(canonical) = '#').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 **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pub-1 error SearchParameter If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()
spd-0 warning SearchParameter Name should be usable as an identifier for the module by machine processing applications such as code generation 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: doco
SearchParameter C 1..1 SearchParameter Search parameter for a resource
Constraints: pub-1
SearchParameter.meta
SearchParameter.meta.Slices for extension Content/Rules for all slices
SearchParameter.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
SearchParameter.Slices for extension Content/Rules for all slices
SearchParameter.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
SearchParameter.Slices for extension.extension:identifier This element must be supported. 0..* Identifier Additional identifier for the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
SearchParameter.Slices for extension.extension:usage This element must be supported. 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
SearchParameter.Slices for extension.extension:copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
SearchParameter.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
SearchParameter.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
SearchParameter.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
SearchParameter.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
SearchParameter.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
SearchParameter.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
SearchParameter.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
SearchParameter.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
SearchParameter.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
SearchParameter.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
SearchParameter.Slices for extension.extension:relatedArtifact.value[x]
SearchParameter.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
SearchParameter.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
SearchParameter.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
SearchParameter.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
SearchParameter.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
SearchParameter.date This element must be supported. 1..1 dateTime Date last changed
SearchParameter.contact This element must be supported. 0..* ContactDetail Contact details for the publisher
SearchParameter.useContext This element must be supported. 0..* UsageContext The context that the content is intended to support
SearchParameter.jurisdiction This element must be supported. 0..* CodeableConcept Intended jurisdiction for search parameter (if applicable)
SearchParameter.purpose This element must be supported. 0..1 markdown Why this search parameter is defined

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
pub-1 error SearchParameter If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
SearchParameter C 1..1 SearchParameter Search parameter for a resource
Constraints: spd-0, spd-1, spd-2, pub-1
SearchParameter.id This element is included in summaries. 0..1 id Logical id of this artifact
SearchParameter.meta This element is included in summaries. 0..1 Meta Metadata about the resource
SearchParameter.meta.id 0..1 string Unique id for inter-element referencing
SearchParameter.meta.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
SearchParameter.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
SearchParameter.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
SearchParameter.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource version last changed
SearchParameter.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
SearchParameter.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
SearchParameter.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
SearchParameter.meta.tag This element is included in summaries. 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".
SearchParameter.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
SearchParameter.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
SearchParameter.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
SearchParameter.contained 0..* Resource Contained, inline Resources
SearchParameter.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
SearchParameter.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
SearchParameter.Slices for extension.extension:identifier This element must be supported. 0..* Identifier Additional identifier for the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
SearchParameter.Slices for extension.extension:usage This element must be supported. 0..1 markdown Describes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
SearchParameter.Slices for extension.extension:copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright
SearchParameter.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
SearchParameter.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
SearchParameter.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
SearchParameter.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
SearchParameter.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
SearchParameter.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
SearchParameter.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
SearchParameter.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
SearchParameter.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
SearchParameter.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
SearchParameter.Slices for extension.extension:relatedArtifact.id 0..1 string Unique id for inter-element referencing
SearchParameter.Slices for extension.extension:relatedArtifact.extension 0..0 Extension
Slice: Unordered, Open by value:url
SearchParameter.Slices for extension.extension:relatedArtifact.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
SearchParameter.Slices for extension.extension:relatedArtifact.value[x] 1..1 RelatedArtifact Value of extension
SearchParameter.Slices for extension.extension:relatedArtifact.value[x].id 0..1 string Unique id for inter-element referencing
SearchParameter.Slices for extension.extension:relatedArtifact.value[x].Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
SearchParameter.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
SearchParameter.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
SearchParameter.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
SearchParameter.Slices for extension.extension:relatedArtifact.value[x].type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
SearchParameter.Slices for extension.extension:relatedArtifact.value[x].label This element is included in summaries. 0..1 string Short label
SearchParameter.Slices for extension.extension:relatedArtifact.value[x].display This element is included in summaries. 0..1 string Brief description of the related artifact
SearchParameter.Slices for extension.extension:relatedArtifact.value[x].citation This element is included in summaries. 0..1 markdown Bibliographic citation for the artifact
SearchParameter.Slices for extension.extension:relatedArtifact.value[x].url This element is included in summaries. 0..1 url Where the artifact can be accessed
SearchParameter.Slices for extension.extension:relatedArtifact.value[x].document This element is included in summaries. 0..1 Attachment What document is being referenced
SearchParameter.Slices for extension.extension:relatedArtifact.value[x].resource This element is included in summaries. 0..1 canonical(Resource) What resource is being referenced
SearchParameter.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
SearchParameter.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
SearchParameter.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
SearchParameter.url This element is included in summaries. 1..1 uri Canonical identifier for this search parameter, represented as a URI (globally unique)
SearchParameter.version This element is included in summaries. 0..1 string Business version of the search parameter
SearchParameter.name This element is included in summaries. C 1..1 string Name for this search parameter (computer friendly)
SearchParameter.derivedFrom 0..1 canonical(SearchParameter) Original definition for the search parameter
SearchParameter.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
SearchParameter.experimental This element is included in summaries. 0..1 boolean For testing purposes, not real usage
SearchParameter.date This element must be supported. This element is included in summaries. 1..1 dateTime Date last changed
SearchParameter.publisher This element is included in summaries. 0..1 string Name of the publisher (organization or individual)
SearchParameter.contact This element must be supported. This element is included in summaries. 0..* ContactDetail Contact details for the publisher
SearchParameter.description This element is included in summaries. 1..1 markdown Natural language description of the search parameter
SearchParameter.useContext This element must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
SearchParameter.jurisdiction This element must be supported. This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for search parameter (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
SearchParameter.purpose This element must be supported. 0..1 markdown Why this search parameter is defined
SearchParameter.code This element is included in summaries. 1..1 code Code used in URL
SearchParameter.base This element is included in summaries. 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.
SearchParameter.type This element is included in summaries. 1..1 code number | date | string | token | reference | composite | quantity | uri | special
Binding: SearchParamType (required): Data types allowed to be used for search parameters.
SearchParameter.expression C 0..1 string FHIRPath expression that extracts the values
SearchParameter.xpath C 0..1 string XPath that extracts the values
SearchParameter.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.
SearchParameter.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.
SearchParameter.multipleOr 0..1 boolean Allow multiple values per parameter (or)
SearchParameter.multipleAnd 0..1 boolean Allow multiple parameters (and)
SearchParameter.comparator 0..* code eq | ne | gt | lt | ge | le | sa | eb | ap
Binding: SearchComparator (required): What Search Comparator Codes are supported in search.
SearchParameter.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.
SearchParameter.chain 0..* string Chained names supported
SearchParameter.component 0..* BackboneElement For Composite resources to define the parts
SearchParameter.component.id 0..1 string Unique id for inter-element referencing
SearchParameter.component.extension 0..* Extension Additional content defined by implementations
SearchParameter.component.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
SearchParameter.component.definition 1..1 canonical(SearchParameter) Defines how the part works
SearchParameter.component.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.0.1 FHIR Std.
SearchParameter.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
SearchParameter.language Base preferred Common Languages 📍4.0.1 FHIR Std.
SearchParameter.extension:relatedArtifact.​value[x].type Base required RelatedArtifactType 📍4.0.1 FHIR Std.
SearchParameter.status Base required PublicationStatus 📍4.0.1 FHIR Std.
SearchParameter.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
SearchParameter.base Base required ResourceType 📍4.0.1 FHIR Std.
SearchParameter.type Base required SearchParamType 📍4.0.1 FHIR Std.
SearchParameter.xpathUsage Base required XPathUsageType 📍4.0.1 FHIR Std.
SearchParameter.target Base required ResourceType 📍4.0.1 FHIR Std.
SearchParameter.comparator Base required SearchComparator 📍4.0.1 FHIR Std.
SearchParameter.modifier Base required SearchModifierCode 📍4.0.1 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 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(canonical) = '#').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 **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pub-1 error SearchParameter If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()
spd-0 warning SearchParameter Name should be usable as an identifier for the module by machine processing applications such as code generation 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'

 

Other representations of profile: CSV, Excel, Schematron