Class SearchParameter

A search parameter that defines a named search item that can be used to search/filter on a resource.

Inheritance
System.Object
Resource
DomainResource
SearchParameter
Implements
Inherited Members
Namespace: fhirCsR2.Models
Assembly: fhirCsR2.dll
Syntax
public class SearchParameter : DomainResource, IFhirJsonSerializable

Properties

| Improve this Doc View Source

_Base

Extension container element for Base

Declaration
public Element _Base { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Code

Extension container element for Code

Declaration
public Element _Code { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Date

Extension container element for Date

Declaration
public Element _Date { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Description

Extension container element for Description

Declaration
public Element _Description { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Experimental

Extension container element for Experimental

Declaration
public Element _Experimental { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Name

Extension container element for Name

Declaration
public Element _Name { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Publisher

Extension container element for Publisher

Declaration
public Element _Publisher { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Requirements

Extension container element for Requirements

Declaration
public Element _Requirements { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Status

Extension container element for Status

Declaration
public Element _Status { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Target

Extension container element for Target

Declaration
public List<Element> _Target { get; set; }
Property Value
Type Description
fhirCsR2.Models.List<Element>
| Improve this Doc View Source

_Type

Extension container element for Type

Declaration
public Element _Type { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Url

Extension container element for Url

Declaration
public Element _Url { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Xpath

Extension container element for Xpath

Declaration
public Element _Xpath { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_XpathUsage

Extension container element for XpathUsage

Declaration
public Element _XpathUsage { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

Base

The base resource type that this search parameter refers to.

Declaration
public string Base { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Code

The code used in the URL or the parameter name in a parameters resource for this search parameter.

Declaration
public string Code { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Contact

Contacts to assist a user in finding and communicating with the publisher.

Declaration
public List<SearchParameterContact> Contact { get; set; }
Property Value
Type Description
fhirCsR2.Models.List<SearchParameterContact>
| Improve this Doc View Source

Date

The date (and optionally time) when the search parameter definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changes.

Declaration
public string Date { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Description

A description of the search parameters and how it used.

Declaration
public string Description { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Experimental

A flag to indicate that this search parameter definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

Declaration
public bool? Experimental { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>
| Improve this Doc View Source

Name

A free text natural language name identifying the search parameter.

Declaration
public string Name { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Publisher

Helps establish the "authority/credibility" of the search parameter. May also allow for contact.

Declaration
public string Publisher { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Requirements

The Scope and Usage that this search parameter was created to meet.

Declaration
public string Requirements { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

ResourceType

Resource Type Name

Declaration
public override string ResourceType { get; }
Property Value
Type Description
System.String
Overrides
| Improve this Doc View Source

Status

The status of this search parameter definition.

Declaration
public string Status { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Target

Types of resource (if a resource is referenced).

Declaration
public List<string> Target { get; set; }
Property Value
Type Description
fhirCsR2.Models.List<System.String>
| Improve this Doc View Source

Type

The type of value a search parameter refers to, and how the content is interpreted.

Declaration
public string Type { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Url

To allow referencing and reusing search parameter definitions under other names on operational systems (in case of name clash).

Declaration
public string Url { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Xpath

An XPath expression that returns a set of elements for the search parameter.

Declaration
public string Xpath { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

XpathUsage

How the search parameter relates to the set of elements returned by evaluating the xpath query.

Declaration
public string XpathUsage { get; set; }
Property Value
Type Description
System.String

Methods

| Improve this Doc View Source

DeserializeJson(ref Utf8JsonReader, JsonSerializerOptions)

Deserialize a JSON object

Declaration
public void DeserializeJson(ref Utf8JsonReader reader, JsonSerializerOptions options)
Parameters
Type Name Description
Utf8JsonReader reader
JsonSerializerOptions options
| Improve this Doc View Source

DeserializeJsonProperty(ref Utf8JsonReader, JsonSerializerOptions, String)

Deserialize a JSON property

Declaration
public void DeserializeJsonProperty(ref Utf8JsonReader reader, JsonSerializerOptions options, string propertyName)
Parameters
Type Name Description
Utf8JsonReader reader
JsonSerializerOptions options
System.String propertyName
| Improve this Doc View Source

SerializeJson(Utf8JsonWriter, JsonSerializerOptions, Boolean)

Serialize to a JSON object

Declaration
public void SerializeJson(Utf8JsonWriter writer, JsonSerializerOptions options, bool includeStartObject = true)
Parameters
Type Name Description
Utf8JsonWriter writer
JsonSerializerOptions options
System.Boolean includeStartObject

Implements