This is the set of resources that conform to either of the profiles CRMI Shareable SearchParameter (http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablesearchparameter) and CRMI Shareable SearchParameter (http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablesearchparameter). E.g. what you have to deal with if you get resources conforming to one of them
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
SearchParameter | C | 1..1 | Search parameter for a resource dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management spd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation spd-1: If an xpath is present, there SHALL be an xpathUsage spd-2: Search parameters can only have chain names when the search parameter type is 'reference' | |
meta | Σ | 0..1 | Meta | Metadata about the resource ele-1: All FHIR elements must have a @value or children |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
language | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language. ele-1: All FHIR elements must have a @value or children | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation ele-1: All FHIR elements must have a @value or children | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 1..* | Extension | Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
url | SΣ | 1..1 | uri | Canonical identifier for this search parameter, represented as a URI (globally unique) ele-1: All FHIR elements must have a @value or children |
version | SΣ | 1..1 | string | Business version of the search parameter ele-1: All FHIR elements must have a @value or children |
name | SΣ | 1..1 | string | Name for this search parameter (computer friendly) ele-1: All FHIR elements must have a @value or children |
derivedFrom | 0..1 | canonical(SearchParameter) | Original definition for the search parameter ele-1: All FHIR elements must have a @value or children | |
status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: ?? (required): The lifecycle status of an artifact. ele-1: All FHIR elements must have a @value or children |
experimental | SΣ | 1..1 | boolean | For testing purposes, not real usage ele-1: All FHIR elements must have a @value or children |
date | Σ | 0..1 | dateTime | Date last changed ele-1: All FHIR elements must have a @value or children |
publisher | SΣ | 0..1 | string | Name of the publisher (organization or individual) ele-1: All FHIR elements must have a @value or children |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher ele-1: All FHIR elements must have a @value or children |
description | SΣ | 1..1 | markdown | Natural language description of the search parameter ele-1: All FHIR elements must have a @value or children |
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support ele-1: All FHIR elements must have a @value or children |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for search parameter (if applicable) Binding: ?? (extensible): Countries and regions within which this artifact is targeted for use. ele-1: All FHIR elements must have a @value or children |
purpose | 0..1 | markdown | Why this search parameter is defined ele-1: All FHIR elements must have a @value or children | |
code | Σ | 1..1 | code | Code used in URL ele-1: All FHIR elements must have a @value or children |
base | Σ | 1..* | code | The resource type(s) this search parameter applies to Binding: ?? (required): One of the resource types defined as part of this version of FHIR. ele-1: All FHIR elements must have a @value or children |
type | Σ | 1..1 | code | number | date | string | token | reference | composite | quantity | uri | special Binding: ?? (required): Data types allowed to be used for search parameters. ele-1: All FHIR elements must have a @value or children |
expression | 0..1 | string | FHIRPath expression that extracts the values ele-1: All FHIR elements must have a @value or children | |
xpath | 0..1 | string | XPath that extracts the values ele-1: All FHIR elements must have a @value or children | |
xpathUsage | 0..1 | code | normal | phonetic | nearby | distance | other Binding: ?? (required): How a search parameter relates to the set of elements returned by evaluating its xpath query. ele-1: All FHIR elements must have a @value or children | |
target | 0..* | code | Types of resource (if a resource reference) Binding: ?? (required): One of the resource types defined as part of this version of FHIR. ele-1: All FHIR elements must have a @value or children | |
multipleOr | 0..1 | boolean | Allow multiple values per parameter (or) ele-1: All FHIR elements must have a @value or children | |
multipleAnd | 0..1 | boolean | Allow multiple parameters (and) ele-1: All FHIR elements must have a @value or children | |
comparator | 0..* | code | eq | ne | gt | lt | ge | le | sa | eb | ap Binding: ?? (required): What Search Comparator Codes are supported in search. ele-1: All FHIR elements must have a @value or children | |
modifier | 0..* | code | missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType Binding: ?? (required): A supported modifier for a search parameter. ele-1: All FHIR elements must have a @value or children | |
chain | 0..* | string | Chained names supported ele-1: All FHIR elements must have a @value or children | |
component | 0..* | BackboneElement | For Composite resources to define the parts ele-1: All FHIR elements must have a @value or children | |
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
definition | 1..1 | canonical(SearchParameter) | Defines how the part works ele-1: All FHIR elements must have a @value or children | |
expression | 1..1 | string | Subexpression relative to main expression ele-1: All FHIR elements must have a @value or children | |
Documentation for this format |