Smart Bear Implementation Guide - Local Development build (v0.3.2). See the Directory of published versions
Resource Profile: SearchParameter Ecounter
| Official URL: https://smart-bear.eu/fhir/StructureDefinition/SearchParameterEcounter | Version: 0.3.2 | |||
| Active as of 2023-08-01 | Computable Name: SearchParameterEcounter | |||
SearchParameter for Family Member History by Encounter
Usage:
- This Resource Profile is not used by any profiles in this Implementation Guide
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from SearchParameter
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  SearchParameter | 0..* | SearchParameter | Search parameter for a resource | |
  url | 1..1 | uri | Canonical identifier for this search parameter, represented as a URI (globally unique) Required Pattern: http://140.164.14.210/fhirV3/SearchParameter/FamilyMemberHistoryByEncounter | |
 description | S | 1..1 | markdown | Natural language description of the search parameter |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| SearchParameter | C | 0..* | SearchParameter | Search parameter for a resource |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| url | Σ | 1..1 | uri | Canonical identifier for this search parameter, represented as a URI (globally unique) Required Pattern: http://140.164.14.210/fhirV3/SearchParameter/FamilyMemberHistoryByEncounter |
| name | ΣC | 1..1 | string | Name for this search parameter (computer friendly) |
| status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| description | SΣ | 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. |
| 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. |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| SearchParameter.status | required | PublicationStatus |
| SearchParameter.base | required | ResourceType |
| SearchParameter.type | required | SearchParamType |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| SearchParameter | C | 0..* | SearchParameter | Search parameter for a resource | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
 meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| 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): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url | Σ | 1..1 | uri | Canonical identifier for this search parameter, represented as a URI (globally unique) Required Pattern: http://140.164.14.210/fhirV3/SearchParameter/FamilyMemberHistoryByEncounter | ||||
| version | Σ | 0..1 | string | Business version of the search parameter | ||||
| name | ΣC | 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 | ||||
| description | SΣ | 1..1 | markdown | Natural language description of the search parameter | ||||
| useContext | Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for search parameter (if applicable) Binding: 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. | ||||
| 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. | |||||
| 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 | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| definition | 1..1 | canonical(SearchParameter) | Defines how the part works | |||||
| expression | 1..1 | string | Subexpression relative to main expression | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| SearchParameter.language | preferred | CommonLanguages
| ||||
| SearchParameter.status | required | PublicationStatus | ||||
| SearchParameter.jurisdiction | extensible | Jurisdiction ValueSet | ||||
| SearchParameter.base | required | ResourceType | ||||
| SearchParameter.type | required | SearchParamType | ||||
| SearchParameter.xpathUsage | required | XPathUsageType | ||||
| SearchParameter.target | required | ResourceType | ||||
| SearchParameter.comparator | required | SearchComparator | ||||
| SearchParameter.modifier | required | SearchModifierCode |
This structure is derived from SearchParameter
Differential View
This structure is derived from SearchParameter
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| SearchParameter | 0..* | SearchParameter | Search parameter for a resource | |
| url | 1..1 | uri | Canonical identifier for this search parameter, represented as a URI (globally unique) Required Pattern: http://140.164.14.210/fhirV3/SearchParameter/FamilyMemberHistoryByEncounter | |
| description | S | 1..1 | markdown | Natural language description of the search parameter |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| SearchParameter | C | 0..* | SearchParameter | Search parameter for a resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| url | Σ | 1..1 | uri | Canonical identifier for this search parameter, represented as a URI (globally unique) Required Pattern: http://140.164.14.210/fhirV3/SearchParameter/FamilyMemberHistoryByEncounter |
| name | ΣC | 1..1 | string | Name for this search parameter (computer friendly) |
| status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| description | SΣ | 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. |
| 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. |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| SearchParameter.status | required | PublicationStatus |
| SearchParameter.base | required | ResourceType |
| SearchParameter.type | required | SearchParamType |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| SearchParameter | C | 0..* | SearchParameter | Search parameter for a resource | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| 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): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url | Σ | 1..1 | uri | Canonical identifier for this search parameter, represented as a URI (globally unique) Required Pattern: http://140.164.14.210/fhirV3/SearchParameter/FamilyMemberHistoryByEncounter | ||||
| version | Σ | 0..1 | string | Business version of the search parameter | ||||
| name | ΣC | 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 | ||||
| description | SΣ | 1..1 | markdown | Natural language description of the search parameter | ||||
| useContext | Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for search parameter (if applicable) Binding: 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. | ||||
| 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. | |||||
| 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 | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| definition | 1..1 | canonical(SearchParameter) | Defines how the part works | |||||
| expression | 1..1 | string | Subexpression relative to main expression | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| SearchParameter.language | preferred | CommonLanguages
| ||||
| SearchParameter.status | required | PublicationStatus | ||||
| SearchParameter.jurisdiction | extensible | Jurisdiction ValueSet | ||||
| SearchParameter.base | required | ResourceType | ||||
| SearchParameter.type | required | SearchParamType | ||||
| SearchParameter.xpathUsage | required | XPathUsageType | ||||
| SearchParameter.target | required | ResourceType | ||||
| SearchParameter.comparator | required | SearchComparator | ||||
| SearchParameter.modifier | required | SearchModifierCode |
This structure is derived from SearchParameter
Other representations of profile: CSV, Excel, Schematron