Current Build

Переводит команда Health Samurai . Приглашаем поучаствовать в русификации стандарта FHIR: GitHub , Email.

5.5 Ресурс SearchParameter - Назначение

FHIR Infrastructure Work GroupMaturity Level: 3 Trial UseSecurity Category: Anonymous Compartments: Not linked to any defined compartments

Параметр поиска, определяющий именованный элемент поиска, который можно использовать для поиска/фильтрации по ресурсу.

Ресурс SearchParameter описывает параметр поиска, который можно использовать в RESTful API для описка или фильтрации по ресурсу. Ресурс SearchParameter декларирует: A SearchParameter resource specifies a search parameter that may be used on the RESTful API to search or filter on a resource. The SearchParameter resource declares:

  • как клиенту обращаться к этому параметру поиска how to refer to the search parameter from a client
  • как этот параметр поиска следует понимать серверу how the search parameter is to be understood by the server
  • какому элементу исходного ресурса соответствует этот параметр поиска where in the source resource the parameter matches

Реализаторы должны быть знакомы с основами и концепциями поиска в RESTful API перед началом работы с этим ресурсом. Implementers should be familiar with the background and concepts described in Search on the RESTful API before working with this resource.

Ссылка на реестр всех параметров поиска. There is a registry of all Search Parameters.

На этот ресурс ссылаются CapabilityStatement и itself

Структура

ИмяФлагиКард.ТипОписание и ограниченияdoco
.. SearchParameter ITUDomainResourceПараметр поиска для ресурса
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
+ Rule: Если указан xpath, то необходимо указать и xpathUsage
+ Rule: Search parameters can only have chain names when the search parameter type is 'reference'
Элементы, определённые в прародителе: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... url Σ1..1uriCanonical identifier for this search parameter, represented as a URI (globally unique)
... version Σ0..1stringBusiness version of the search parameter
... name ΣI1..1stringName for this search parameter (computer friendly)
... derivedFrom 0..1canonical(SearchParameter)Original definition for the search parameter
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description Σ1..1markdownNatural language description of the search parameter
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for search parameter (if applicable)
Jurisdiction (Extensible)
... purpose 0..1markdownWhy this search parameter is defined
... code Σ1..1codeКод, используемый в URL
... base Σ1..*codeТип ресурса, к которому применяется этот параметр поиска
ResourceType (Required)
... type Σ1..1codenumber | date | string | token | reference | composite | quantity | uri | special
SearchParamType (Required)
... expression I0..1stringFHIRPath expression that extracts the values
... xpath I0..1stringXPath that extracts the values
... xpathUsage I0..1codenormal | phonetic | nearby | distance | other
XPathUsageType (Required)
... target 0..*codeТипы ресурса (если это ссылка на ресурс)
ResourceType (Required)
... multipleOr 0..1booleanAllow multiple values per parameter (or)
... multipleAnd 0..1booleanAllow multiple parameters (and)
... comparator 0..*codeeq | ne | gt | lt | ge | le | sa | eb | ap
SearchComparator (Required)
... modifier 0..*codemissing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType
SearchModifierCode (Required)
... chain 0..*stringChained names supported
... component 0..*BackboneElementFor Composite resources to define the parts
.... definition 1..1canonical(SearchParameter)Defines how the part works
.... expression 1..1stringSubexpression relative to main expression

doco Документация по этому формату

UML-диаграмма (Legend)

SearchParameter (DomainResource)An absolute URI that is used to identify this search parameter when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this search parameter is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the search parameter is stored on different serversurl : uri [1..1]The identifier that is used to identify this version of the search parameter when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the search parameter author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequenceversion : string [0..1]A natural language name identifying the search parameter. This name should be usable as an identifier for the module by machine processing applications such as code generationname : string [1..1]Where this search parameter is originally defined. If a derivedFrom is provided, then the details in the search parameter must be consistent with the definition from which it is defined. i.e. the parameter should have the same meaning, and (usually) the functionality should be a proper subset of the underlying search parameterderivedFrom : canonical [0..1] « SearchParameter »The status of this search parameter. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « The lifecycle status of an artifact. (Strength=Required)PublicationStatus! »A Boolean value to indicate that this search parameter is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usageexperimental : boolean [0..1]The date (and optionally time) when the search parameter was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changesdate : dateTime [0..1]The name of the organization or individual that published the search parameterpublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]And how it useddescription : markdown [1..1]The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate search parameter instancesuseContext : UsageContext [0..*]A legal or geographic region in which the search parameter is intended to be usedjurisdiction : CodeableConcept [0..*] « Countries and regions within which this artifact is targeted for use. (Strength=Extensible)Jurisdiction ValueSet+ »Explanation of why this search parameter is needed and why it has been designed as it haspurpose : markdown [0..1]Код, используемый в URL, или имя параметра в ресурсе Parameters, для данного параметра поискаcode : code [1..1]The base resource type(s) that this search parameter can be used againstbase : code [1..*] « One of the resource types defined as part of this version of FHIR. (Strength=Required)ResourceType! »Тип значения, к которому относится параметр поиска, и как интерпретируется его содержимоеtype : code [1..1] « Data types allowed to be used for search parameters. (Strength=Required)SearchParamType! »A FHIRPath expression that returns a set of elements for the search parameterexpression : string [0..1]An XPath expression that returns a set of elements for the search parameterxpath : string [0..1]Каким образом параметр поиска соотносится с набором элементов, возвращаемых при вычислении этого xpath-выраженияxpathUsage : code [0..1] « Каким образом параметр поиска соотносится с набором элементов, возвращаемых при вычислении этого xpath-выражения. (Strength=Required)XPathUsageType! »Типы ресурса (если это ссылка на ресурс)target : code [0..*] « One of the resource types defined as part of this version of FHIR. (Strength=Required)ResourceType! »Whether multiple values are allowed for each time the parameter exists. Values are separated by commas, and the parameter matches if any of the values matchmultipleOr : boolean [0..1]Whether multiple parameters are allowed - e.g. more than one parameter with the same name. The search matches if all the parameters matchmultipleAnd : boolean [0..1]Comparators supported for the search parametercomparator : code [0..*] « What Search Comparator Codes are supported in search. (Strength=Required)SearchComparator! »A modifier supported for the search parametermodifier : code [0..*] « A supported modifier for a search parameter. (Strength=Required)SearchModifierCode! »Contains the names of any search parameters which may be chained to the containing search parameter. Chained parameters may be added to search parameters of type reference and specify that resources will only be returned if they contain a reference to a resource which matches the chained parameter value. Values for this field should be drawn from SearchParameter.code for a parameter on the target resource typechain : string [0..*]ComponentThe definition of the search parameter that describes this partdefinition : canonical [1..1] « SearchParameter »A sub-expression that defines how to extract values for this component from the output of the main SearchParameter.expressionexpression : string [1..1]Used to define the parts of a composite search parametercomponent[0..*]

XML-шаблон

<SearchParameter xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 1..1 Canonical identifier for this search parameter, represented as a URI (globally unique) -->
 <version value="[string]"/><!-- 0..1 Business version of the search parameter -->
 <name value="[string]"/><!-- ?? 1..1 Name for this search parameter (computer friendly) -->
 <derivedFrom><!-- 0..1 canonical(SearchParameter) Original definition for the search parameter --></derivedFrom>
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 1..1 Natural language description of the search parameter -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for search parameter (if applicable) --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this search parameter is defined -->
 <code value="[code]"/><!-- 1..1 Код, используемый в URL -->
 <base value="[code]"/><!-- 1..* Тип ресурса, к которому применяется этот параметр поиска -->
 <type value="[code]"/><!-- 1..1 number | date | string | token | reference | composite | quantity | uri | special -->
 <expression value="[string]"/><!-- ?? 0..1 FHIRPath expression that extracts the values -->
 <xpath value="[string]"/><!-- ?? 0..1 XPath that extracts the values -->
 <xpathUsage value="[code]"/><!-- ?? 0..1 normal | phonetic | nearby | distance | other -->
 <target value="[code]"/><!-- 0..* Типы ресурса (если это ссылка на ресурс) -->
 <multipleOr value="[boolean]"/><!-- 0..1 Allow multiple values per parameter (or) -->
 <multipleAnd value="[boolean]"/><!-- 0..1 Allow multiple parameters (and) -->
 <comparator value="[code]"/><!-- 0..* eq | ne | gt | lt | ge | le | sa | eb | ap -->
 <modifier value="[code]"/><!-- 0..* missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType -->
 <chain value="[string]"/><!-- 0..* Chained names supported -->
 <component>  <!-- 0..* For Composite resources to define the parts -->
  <definition><!-- 1..1 canonical(SearchParameter) Defines how the part works --></definition>
  <expression value="[string]"/><!-- 1..1 Subexpression relative to main expression -->
 </component>
</SearchParameter>

JSON-шаблон

{doco
  "resourceType" : "SearchParameter",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // R!  Canonical identifier for this search parameter, represented as a URI (globally unique)
  "version" : "<string>", // Business version of the search parameter
  "name" : "<string>", // C? R!  Name for this search parameter (computer friendly)
  "derivedFrom" : { canonical(SearchParameter) }, // Original definition for the search parameter
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // R!  Natural language description of the search parameter
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for search parameter (if applicable)
  "purpose" : "<markdown>", // Why this search parameter is defined
  "code" : "<code>", // R!  Код, используемый в URL
  "base" : ["<code>"], // R!  Тип ресурса, к которому применяется этот параметр поиска
  "type" : "<code>", // R!  number | date | string | token | reference | composite | quantity | uri | special
  "expression" : "<string>", // C? FHIRPath expression that extracts the values
  "xpath" : "<string>", // C? XPath that extracts the values
  "xpathUsage" : "<code>", // C? normal | phonetic | nearby | distance | other
  "target" : ["<code>"], // Типы ресурса (если это ссылка на ресурс)
  "multipleOr" : <boolean>, // Allow multiple values per parameter (or)
  "multipleAnd" : <boolean>, // Allow multiple parameters (and)
  "comparator" : ["<code>"], // eq | ne | gt | lt | ge | le | sa | eb | ap
  "modifier" : ["<code>"], // missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType
  "chain" : ["<string>"], // Chained names supported
  "component" : [{ // For Composite resources to define the parts
    "definition" : { canonical(SearchParameter) }, // R!  Defines how the part works
    "expression" : "<string>" // R!  Subexpression relative to main expression
  }]
}

Turtle-шаблон

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:SearchParameter;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:SearchParameter.url [ uri ]; # 1..1 Canonical identifier for this search parameter, represented as a URI (globally unique)
  fhir:SearchParameter.version [ string ]; # 0..1 Business version of the search parameter
  fhir:SearchParameter.name [ string ]; # 1..1 Name for this search parameter (computer friendly)
  fhir:SearchParameter.derivedFrom [ canonical(SearchParameter) ]; # 0..1 Original definition for the search parameter
  fhir:SearchParameter.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:SearchParameter.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  fhir:SearchParameter.date [ dateTime ]; # 0..1 Date last changed
  fhir:SearchParameter.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:SearchParameter.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:SearchParameter.description [ markdown ]; # 1..1 Natural language description of the search parameter
  fhir:SearchParameter.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support
  fhir:SearchParameter.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for search parameter (if applicable)
  fhir:SearchParameter.purpose [ markdown ]; # 0..1 Why this search parameter is defined
  fhir:SearchParameter.code [ code ]; # 1..1 Код, используемый в URL
  fhir:SearchParameter.base [ code ], ... ; # 1..* Тип ресурса, к которому применяется этот параметр поиска
  fhir:SearchParameter.type [ code ]; # 1..1 number | date | string | token | reference | composite | quantity | uri | special
  fhir:SearchParameter.expression [ string ]; # 0..1 FHIRPath expression that extracts the values
  fhir:SearchParameter.xpath [ string ]; # 0..1 XPath that extracts the values
  fhir:SearchParameter.xpathUsage [ code ]; # 0..1 normal | phonetic | nearby | distance | other
  fhir:SearchParameter.target [ code ], ... ; # 0..* Типы ресурса (если это ссылка на ресурс)
  fhir:SearchParameter.multipleOr [ boolean ]; # 0..1 Allow multiple values per parameter (or)
  fhir:SearchParameter.multipleAnd [ boolean ]; # 0..1 Allow multiple parameters (and)
  fhir:SearchParameter.comparator [ code ], ... ; # 0..* eq | ne | gt | lt | ge | le | sa | eb | ap
  fhir:SearchParameter.modifier [ code ], ... ; # 0..* missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType
  fhir:SearchParameter.chain [ string ], ... ; # 0..* Chained names supported
  fhir:SearchParameter.component [ # 0..* For Composite resources to define the parts
    fhir:SearchParameter.component.definition [ canonical(SearchParameter) ]; # 1..1 Defines how the part works
    fhir:SearchParameter.component.expression [ string ]; # 1..1 Subexpression relative to main expression
  ], ...;
]

Changes since R3

SearchParameter
SearchParameter
  • Min Cardinality changed from 1 to 0
  • Max Cardinality changed from 1 to *
SearchParameter.derivedFrom
  • Type changed from uri to canonical(SearchParameter)
SearchParameter.experimental
  • No longer marked as Modifier
SearchParameter.base
  • Remove Codes BodySite, DataElement, DeviceComponent, EligibilityRequest, EligibilityResponse, ExpansionProfile, ImagingManifest, ProcedureRequest, ProcessRequest, ProcessResponse, ReferralRequest, Sequence, ServiceDefinition
  • Add Codes BiologicallyDerivedProduct, BodyStructure, CatalogEntry, ChargeItemDefinition, CoverageEligibilityRequest, CoverageEligibilityResponse, DeviceDefinition, EffectEvidenceSynthesis, EventDefinition, Evidence, EvidenceVariable, ExampleScenario, ImmunizationEvaluation, InsurancePlan, Invoice, ItemInstance, MedicationKnowledge, MedicinalProduct, MedicinalProductAuthorization, MedicinalProductContraindication, MedicinalProductIndication, MedicinalProductIngredient, MedicinalProductInteraction, MedicinalProductManufactured, MedicinalProductPackaged, MedicinalProductPharmaceutical, MedicinalProductUndesirableEffect, MolecularSequence, ObservationDefinition, OrganizationAffiliation, ResearchDefinition, ResearchElementDefinition, RiskEvidenceSynthesis, ServiceRequest, SpecimenDefinition, SubstanceNucleicAcid, SubstancePolymer, SubstanceProtein, SubstanceReferenceInformation, SubstanceSourceMaterial, SubstanceSpecification, TerminologyCapabilities, VerificationResult
SearchParameter.type
  • Add Code special
SearchParameter.target
  • Remove Codes BodySite, DataElement, DeviceComponent, EligibilityRequest, EligibilityResponse, ExpansionProfile, ImagingManifest, ProcedureRequest, ProcessRequest, ProcessResponse, ReferralRequest, Sequence, ServiceDefinition
  • Add Codes BiologicallyDerivedProduct, BodyStructure, CatalogEntry, ChargeItemDefinition, CoverageEligibilityRequest, CoverageEligibilityResponse, DeviceDefinition, EffectEvidenceSynthesis, EventDefinition, Evidence, EvidenceVariable, ExampleScenario, ImmunizationEvaluation, InsurancePlan, Invoice, ItemInstance, MedicationKnowledge, MedicinalProduct, MedicinalProductAuthorization, MedicinalProductContraindication, MedicinalProductIndication, MedicinalProductIngredient, MedicinalProductInteraction, MedicinalProductManufactured, MedicinalProductPackaged, MedicinalProductPharmaceutical, MedicinalProductUndesirableEffect, MolecularSequence, ObservationDefinition, OrganizationAffiliation, ResearchDefinition, ResearchElementDefinition, RiskEvidenceSynthesis, ServiceRequest, SpecimenDefinition, SubstanceNucleicAcid, SubstancePolymer, SubstanceProtein, SubstanceReferenceInformation, SubstanceSourceMaterial, SubstanceSpecification, TerminologyCapabilities, VerificationResult
SearchParameter.multipleOr
  • Added Element
SearchParameter.multipleAnd
  • Added Element
SearchParameter.modifier
  • Add Codes identifier, ofType
SearchParameter.component.definition
  • Type changed from Reference(SearchParameter) to canonical(SearchParameter)

See the Full Difference for further information

This analysis is available as XML or JSON.

See R3 <--> R4 Conversion Maps (status = 3 tests that all execute ok. All tests pass round-trip testing and 3 r3 resources are invalid (0 errors).)

Структура

ИмяФлагиКард.ТипОписание и ограниченияdoco
.. SearchParameter ITUDomainResourceПараметр поиска для ресурса
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
+ Rule: Если указан xpath, то необходимо указать и xpathUsage
+ Rule: Search parameters can only have chain names when the search parameter type is 'reference'
Элементы, определённые в прародителе: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... url Σ1..1uriCanonical identifier for this search parameter, represented as a URI (globally unique)
... version Σ0..1stringBusiness version of the search parameter
... name ΣI1..1stringName for this search parameter (computer friendly)
... derivedFrom 0..1canonical(SearchParameter)Original definition for the search parameter
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description Σ1..1markdownNatural language description of the search parameter
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for search parameter (if applicable)
Jurisdiction (Extensible)
... purpose 0..1markdownWhy this search parameter is defined
... code Σ1..1codeКод, используемый в URL
... base Σ1..*codeТип ресурса, к которому применяется этот параметр поиска
ResourceType (Required)
... type Σ1..1codenumber | date | string | token | reference | composite | quantity | uri | special
SearchParamType (Required)
... expression I0..1stringFHIRPath expression that extracts the values
... xpath I0..1stringXPath that extracts the values
... xpathUsage I0..1codenormal | phonetic | nearby | distance | other
XPathUsageType (Required)
... target 0..*codeТипы ресурса (если это ссылка на ресурс)
ResourceType (Required)
... multipleOr 0..1booleanAllow multiple values per parameter (or)
... multipleAnd 0..1booleanAllow multiple parameters (and)
... comparator 0..*codeeq | ne | gt | lt | ge | le | sa | eb | ap
SearchComparator (Required)
... modifier 0..*codemissing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType
SearchModifierCode (Required)
... chain 0..*stringChained names supported
... component 0..*BackboneElementFor Composite resources to define the parts
.... definition 1..1canonical(SearchParameter)Defines how the part works
.... expression 1..1stringSubexpression relative to main expression

doco Документация по этому формату

UML-диаграмма (Legend)

SearchParameter (DomainResource)An absolute URI that is used to identify this search parameter when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this search parameter is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the search parameter is stored on different serversurl : uri [1..1]The identifier that is used to identify this version of the search parameter when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the search parameter author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequenceversion : string [0..1]A natural language name identifying the search parameter. This name should be usable as an identifier for the module by machine processing applications such as code generationname : string [1..1]Where this search parameter is originally defined. If a derivedFrom is provided, then the details in the search parameter must be consistent with the definition from which it is defined. i.e. the parameter should have the same meaning, and (usually) the functionality should be a proper subset of the underlying search parameterderivedFrom : canonical [0..1] « SearchParameter »The status of this search parameter. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « The lifecycle status of an artifact. (Strength=Required)PublicationStatus! »A Boolean value to indicate that this search parameter is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usageexperimental : boolean [0..1]The date (and optionally time) when the search parameter was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changesdate : dateTime [0..1]The name of the organization or individual that published the search parameterpublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]And how it useddescription : markdown [1..1]The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate search parameter instancesuseContext : UsageContext [0..*]A legal or geographic region in which the search parameter is intended to be usedjurisdiction : CodeableConcept [0..*] « Countries and regions within which this artifact is targeted for use. (Strength=Extensible)Jurisdiction ValueSet+ »Explanation of why this search parameter is needed and why it has been designed as it haspurpose : markdown [0..1]Код, используемый в URL, или имя параметра в ресурсе Parameters, для данного параметра поискаcode : code [1..1]The base resource type(s) that this search parameter can be used againstbase : code [1..*] « One of the resource types defined as part of this version of FHIR. (Strength=Required)ResourceType! »Тип значения, к которому относится параметр поиска, и как интерпретируется его содержимоеtype : code [1..1] « Data types allowed to be used for search parameters. (Strength=Required)SearchParamType! »A FHIRPath expression that returns a set of elements for the search parameterexpression : string [0..1]An XPath expression that returns a set of elements for the search parameterxpath : string [0..1]Каким образом параметр поиска соотносится с набором элементов, возвращаемых при вычислении этого xpath-выраженияxpathUsage : code [0..1] « Каким образом параметр поиска соотносится с набором элементов, возвращаемых при вычислении этого xpath-выражения. (Strength=Required)XPathUsageType! »Типы ресурса (если это ссылка на ресурс)target : code [0..*] « One of the resource types defined as part of this version of FHIR. (Strength=Required)ResourceType! »Whether multiple values are allowed for each time the parameter exists. Values are separated by commas, and the parameter matches if any of the values matchmultipleOr : boolean [0..1]Whether multiple parameters are allowed - e.g. more than one parameter with the same name. The search matches if all the parameters matchmultipleAnd : boolean [0..1]Comparators supported for the search parametercomparator : code [0..*] « What Search Comparator Codes are supported in search. (Strength=Required)SearchComparator! »A modifier supported for the search parametermodifier : code [0..*] « A supported modifier for a search parameter. (Strength=Required)SearchModifierCode! »Contains the names of any search parameters which may be chained to the containing search parameter. Chained parameters may be added to search parameters of type reference and specify that resources will only be returned if they contain a reference to a resource which matches the chained parameter value. Values for this field should be drawn from SearchParameter.code for a parameter on the target resource typechain : string [0..*]ComponentThe definition of the search parameter that describes this partdefinition : canonical [1..1] « SearchParameter »A sub-expression that defines how to extract values for this component from the output of the main SearchParameter.expressionexpression : string [1..1]Used to define the parts of a composite search parametercomponent[0..*]

XML-шаблон

<SearchParameter xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 1..1 Canonical identifier for this search parameter, represented as a URI (globally unique) -->
 <version value="[string]"/><!-- 0..1 Business version of the search parameter -->
 <name value="[string]"/><!-- ?? 1..1 Name for this search parameter (computer friendly) -->
 <derivedFrom><!-- 0..1 canonical(SearchParameter) Original definition for the search parameter --></derivedFrom>
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 1..1 Natural language description of the search parameter -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for search parameter (if applicable) --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this search parameter is defined -->
 <code value="[code]"/><!-- 1..1 Код, используемый в URL -->
 <base value="[code]"/><!-- 1..* Тип ресурса, к которому применяется этот параметр поиска -->
 <type value="[code]"/><!-- 1..1 number | date | string | token | reference | composite | quantity | uri | special -->
 <expression value="[string]"/><!-- ?? 0..1 FHIRPath expression that extracts the values -->
 <xpath value="[string]"/><!-- ?? 0..1 XPath that extracts the values -->
 <xpathUsage value="[code]"/><!-- ?? 0..1 normal | phonetic | nearby | distance | other -->
 <target value="[code]"/><!-- 0..* Типы ресурса (если это ссылка на ресурс) -->
 <multipleOr value="[boolean]"/><!-- 0..1 Allow multiple values per parameter (or) -->
 <multipleAnd value="[boolean]"/><!-- 0..1 Allow multiple parameters (and) -->
 <comparator value="[code]"/><!-- 0..* eq | ne | gt | lt | ge | le | sa | eb | ap -->
 <modifier value="[code]"/><!-- 0..* missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType -->
 <chain value="[string]"/><!-- 0..* Chained names supported -->
 <component>  <!-- 0..* For Composite resources to define the parts -->
  <definition><!-- 1..1 canonical(SearchParameter) Defines how the part works --></definition>
  <expression value="[string]"/><!-- 1..1 Subexpression relative to main expression -->
 </component>
</SearchParameter>

JSON-шаблон

{doco
  "resourceType" : "SearchParameter",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // R!  Canonical identifier for this search parameter, represented as a URI (globally unique)
  "version" : "<string>", // Business version of the search parameter
  "name" : "<string>", // C? R!  Name for this search parameter (computer friendly)
  "derivedFrom" : { canonical(SearchParameter) }, // Original definition for the search parameter
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // R!  Natural language description of the search parameter
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for search parameter (if applicable)
  "purpose" : "<markdown>", // Why this search parameter is defined
  "code" : "<code>", // R!  Код, используемый в URL
  "base" : ["<code>"], // R!  Тип ресурса, к которому применяется этот параметр поиска
  "type" : "<code>", // R!  number | date | string | token | reference | composite | quantity | uri | special
  "expression" : "<string>", // C? FHIRPath expression that extracts the values
  "xpath" : "<string>", // C? XPath that extracts the values
  "xpathUsage" : "<code>", // C? normal | phonetic | nearby | distance | other
  "target" : ["<code>"], // Типы ресурса (если это ссылка на ресурс)
  "multipleOr" : <boolean>, // Allow multiple values per parameter (or)
  "multipleAnd" : <boolean>, // Allow multiple parameters (and)
  "comparator" : ["<code>"], // eq | ne | gt | lt | ge | le | sa | eb | ap
  "modifier" : ["<code>"], // missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType
  "chain" : ["<string>"], // Chained names supported
  "component" : [{ // For Composite resources to define the parts
    "definition" : { canonical(SearchParameter) }, // R!  Defines how the part works
    "expression" : "<string>" // R!  Subexpression relative to main expression
  }]
}

Turtle-шаблон

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:SearchParameter;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:SearchParameter.url [ uri ]; # 1..1 Canonical identifier for this search parameter, represented as a URI (globally unique)
  fhir:SearchParameter.version [ string ]; # 0..1 Business version of the search parameter
  fhir:SearchParameter.name [ string ]; # 1..1 Name for this search parameter (computer friendly)
  fhir:SearchParameter.derivedFrom [ canonical(SearchParameter) ]; # 0..1 Original definition for the search parameter
  fhir:SearchParameter.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:SearchParameter.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  fhir:SearchParameter.date [ dateTime ]; # 0..1 Date last changed
  fhir:SearchParameter.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:SearchParameter.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:SearchParameter.description [ markdown ]; # 1..1 Natural language description of the search parameter
  fhir:SearchParameter.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support
  fhir:SearchParameter.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for search parameter (if applicable)
  fhir:SearchParameter.purpose [ markdown ]; # 0..1 Why this search parameter is defined
  fhir:SearchParameter.code [ code ]; # 1..1 Код, используемый в URL
  fhir:SearchParameter.base [ code ], ... ; # 1..* Тип ресурса, к которому применяется этот параметр поиска
  fhir:SearchParameter.type [ code ]; # 1..1 number | date | string | token | reference | composite | quantity | uri | special
  fhir:SearchParameter.expression [ string ]; # 0..1 FHIRPath expression that extracts the values
  fhir:SearchParameter.xpath [ string ]; # 0..1 XPath that extracts the values
  fhir:SearchParameter.xpathUsage [ code ]; # 0..1 normal | phonetic | nearby | distance | other
  fhir:SearchParameter.target [ code ], ... ; # 0..* Типы ресурса (если это ссылка на ресурс)
  fhir:SearchParameter.multipleOr [ boolean ]; # 0..1 Allow multiple values per parameter (or)
  fhir:SearchParameter.multipleAnd [ boolean ]; # 0..1 Allow multiple parameters (and)
  fhir:SearchParameter.comparator [ code ], ... ; # 0..* eq | ne | gt | lt | ge | le | sa | eb | ap
  fhir:SearchParameter.modifier [ code ], ... ; # 0..* missing | exact | contains | not | text | in | not-in | below | above | type | identifier | ofType
  fhir:SearchParameter.chain [ string ], ... ; # 0..* Chained names supported
  fhir:SearchParameter.component [ # 0..* For Composite resources to define the parts
    fhir:SearchParameter.component.definition [ canonical(SearchParameter) ]; # 1..1 Defines how the part works
    fhir:SearchParameter.component.expression [ string ]; # 1..1 Subexpression relative to main expression
  ], ...;
]

Changes since Release 3

SearchParameter
SearchParameter
  • Min Cardinality changed from 1 to 0
  • Max Cardinality changed from 1 to *
SearchParameter.derivedFrom
  • Type changed from uri to canonical(SearchParameter)
SearchParameter.experimental
  • No longer marked as Modifier
SearchParameter.base
  • Remove Codes BodySite, DataElement, DeviceComponent, EligibilityRequest, EligibilityResponse, ExpansionProfile, ImagingManifest, ProcedureRequest, ProcessRequest, ProcessResponse, ReferralRequest, Sequence, ServiceDefinition
  • Add Codes BiologicallyDerivedProduct, BodyStructure, CatalogEntry, ChargeItemDefinition, CoverageEligibilityRequest, CoverageEligibilityResponse, DeviceDefinition, EffectEvidenceSynthesis, EventDefinition, Evidence, EvidenceVariable, ExampleScenario, ImmunizationEvaluation, InsurancePlan, Invoice, ItemInstance, MedicationKnowledge, MedicinalProduct, MedicinalProductAuthorization, MedicinalProductContraindication, MedicinalProductIndication, MedicinalProductIngredient, MedicinalProductInteraction, MedicinalProductManufactured, MedicinalProductPackaged, MedicinalProductPharmaceutical, MedicinalProductUndesirableEffect, MolecularSequence, ObservationDefinition, OrganizationAffiliation, ResearchDefinition, ResearchElementDefinition, RiskEvidenceSynthesis, ServiceRequest, SpecimenDefinition, SubstanceNucleicAcid, SubstancePolymer, SubstanceProtein, SubstanceReferenceInformation, SubstanceSourceMaterial, SubstanceSpecification, TerminologyCapabilities, VerificationResult
SearchParameter.type
  • Add Code special
SearchParameter.target
  • Remove Codes BodySite, DataElement, DeviceComponent, EligibilityRequest, EligibilityResponse, ExpansionProfile, ImagingManifest, ProcedureRequest, ProcessRequest, ProcessResponse, ReferralRequest, Sequence, ServiceDefinition
  • Add Codes BiologicallyDerivedProduct, BodyStructure, CatalogEntry, ChargeItemDefinition, CoverageEligibilityRequest, CoverageEligibilityResponse, DeviceDefinition, EffectEvidenceSynthesis, EventDefinition, Evidence, EvidenceVariable, ExampleScenario, ImmunizationEvaluation, InsurancePlan, Invoice, ItemInstance, MedicationKnowledge, MedicinalProduct, MedicinalProductAuthorization, MedicinalProductContraindication, MedicinalProductIndication, MedicinalProductIngredient, MedicinalProductInteraction, MedicinalProductManufactured, MedicinalProductPackaged, MedicinalProductPharmaceutical, MedicinalProductUndesirableEffect, MolecularSequence, ObservationDefinition, OrganizationAffiliation, ResearchDefinition, ResearchElementDefinition, RiskEvidenceSynthesis, ServiceRequest, SpecimenDefinition, SubstanceNucleicAcid, SubstancePolymer, SubstanceProtein, SubstanceReferenceInformation, SubstanceSourceMaterial, SubstanceSpecification, TerminologyCapabilities, VerificationResult
SearchParameter.multipleOr
  • Added Element
SearchParameter.multipleAnd
  • Added Element
SearchParameter.modifier
  • Add Codes identifier, ofType
SearchParameter.component.definition
  • Type changed from Reference(SearchParameter) to canonical(SearchParameter)

See the Full Difference for further information

This analysis is available as XML or JSON.

See R3 <--> R4 Conversion Maps (status = 3 tests that all execute ok. All tests pass round-trip testing and 3 r3 resources are invalid (0 errors).)

 

See the Profiles & Extensions and the Альтернативные определения: Основное определение XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions & the Анализ зависимостей

PathОписаниеТипСсылка
SearchParameter.status The lifecycle status of an artifact.RequiredPublicationStatus
SearchParameter.jurisdiction Countries and regions within which this artifact is targeted for use.ExtensibleJurisdiction ValueSet
SearchParameter.base
SearchParameter.target
One of the resource types defined as part of this version of FHIR.RequiredResource Types
SearchParameter.type Data types allowed to be used for search parameters.RequiredSearchParamType
SearchParameter.xpathUsage Каким образом параметр поиска соотносится с набором элементов, возвращаемых при вычислении этого xpath-выражения.RequiredXPathUsageType
SearchParameter.comparator What Search Comparator Codes are supported in search.RequiredSearchComparator
SearchParameter.modifier A supported modifier for a search parameter.RequiredSearchModifierCode

idLevelLocationОпределениеExpression
spd-0Warning (base)Name should be usable as an identifier for the module by machine processing applications such as code generationname.matches('[A-Z]([A-Za-z0-9_]){0,254}')
spd-1Rule (base)Если указан xpath, то необходимо указать и xpathUsagexpath.empty() or xpathUsage.exists()
spd-2Rule (base)Search parameters can only have chain names when the search parameter type is 'reference'chain.empty() or type = 'reference'

Ресурс SearchParameter можно использовать для определения различных поисков по расширениям. В зависимости от контекста расширения (типы контекста приводятся в StructureDefinition) может потребоваться несколько экземпляров элемента SearchParameter.xpath следующим образом: The SearchParameter resource may be used to define searches on extensions. Depending on the context of the extension (as defined in the StructureDefinition), this may require multiple instances of the SearchParameter.xpath element like so:

  • Если контекст расширения ограничивается одним ресурсом, в SearchParameter.base необходимо задать этот ресурс, а элементам, определенным в этом контексте расширения, может соответствовать один или несколько xpath-элементов, например "f:Patient/f:name/f:extension[@url='extension url']" If the extension's context is scoped by a single resource, SearchParameter.base must be set to that resource, and there may be one or more xpath elements corresponding to the elements specified in the extension's context, e.g. "f:Patient/f:name/f:extension[@url='extension url']"
  • Если контекст расширения охватывает несколько ресурсов, в SearchParameter.base необходимо задать значение "DomainResource". If the extension's context specifies multiple resources, SearchParameter.base must be set to "DomainResource".
  • Вы можете использовать один xpath-элемент с полным URL расширения для обозначения того, что SearchParameter будет искать по всем элементами заданного в SearchParameter.base ресурса для данного расширения. You may use a single xpath element with the full URL of the Extension to indicate that the SearchParameter would search in all elements of the given SearchParameter.base resource for the given extension.

Параметры поиска для этого ресурса. Также к нему применяются общие параметры. Более подробную информацию о поиске в REST, обмене сообщениями и сервисах см. в разделе Поиск.

ИмяТипОпределениеВыражениеIn Common
basetokenТип ресурса, к которому применяется этот параметр поискаSearchParameter.base
codetokenКод, используемый в URLSearchParameter.code
componentreferenceDefines how the part worksSearchParameter.component.definition
(SearchParameter)
contexttokenA use context assigned to the search parameter(SearchParameter.useContext.value as CodeableConcept)
context-quantityquantityA quantity- or range-valued use context assigned to the search parameter(SearchParameter.useContext.value as Quantity) | (SearchParameter.useContext.value as Range)
context-typetokenA type of use context assigned to the search parameterSearchParameter.useContext.code
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the search parameterOn SearchParameter.useContext:
  context-type: code
  context-quantity: value.as(Quantity) | value.as(Range)
context-type-valuecompositeA use context type and value assigned to the search parameterOn SearchParameter.useContext:
  context-type: code
  context: value.as(CodeableConcept)
datedateThe search parameter publication dateSearchParameter.date
derived-fromreferenceOriginal definition for the search parameterSearchParameter.derivedFrom
(SearchParameter)
descriptionstringThe description of the search parameterSearchParameter.description
jurisdictiontokenIntended jurisdiction for the search parameterSearchParameter.jurisdiction
namestringComputationally friendly name of the search parameterSearchParameter.name
publisherstringName of the publisher of the search parameterSearchParameter.publisher
statustokenThe current status of the search parameterSearchParameter.status
targettokenТипы ресурса (если это ссылка на ресурс)SearchParameter.target
typetokennumber | date | string | token | reference | composite | quantity | uri | specialSearchParameter.type
urluriThe uri that identifies the search parameterSearchParameter.url
versiontokenThe business version of the search parameterSearchParameter.version