Class ConformanceRestResourceSearchParam
Search parameters for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.
Implements
Inherited Members
Namespace: fhirCsR2.Models
Assembly: fhirCsR2.dll
Syntax
public class ConformanceRestResourceSearchParam : BackboneElement, IFhirJsonSerializable
Properties
| Improve this Doc View Source_Chain
Extension container element for Chain
Declaration
public List<Element> _Chain { get; set; }
Property Value
| Type | Description |
|---|---|
| fhirCsR2.Models.List<Element> |
_Definition
Extension container element for Definition
Declaration
public Element _Definition { get; set; }
Property Value
| Type | Description |
|---|---|
| Element |
_Documentation
Extension container element for Documentation
Declaration
public Element _Documentation { get; set; }
Property Value
| Type | Description |
|---|---|
| Element |
_Modifier
Extension container element for Modifier
Declaration
public List<Element> _Modifier { get; set; }
Property Value
| Type | Description |
|---|---|
| fhirCsR2.Models.List<Element> |
_Name
Extension container element for Name
Declaration
public Element _Name { get; set; }
Property Value
| Type | Description |
|---|---|
| Element |
_Target
Extension container element for Target
Declaration
public List<Element> _Target { get; set; }
Property Value
| Type | Description |
|---|---|
| fhirCsR2.Models.List<Element> |
_Type
Extension container element for Type
Declaration
public Element _Type { get; set; }
Property Value
| Type | Description |
|---|---|
| Element |
Chain
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 Conformance.rest.resource.searchParam.name on the target resource type.
Declaration
public List<string> Chain { get; set; }
Property Value
| Type | Description |
|---|---|
| fhirCsR2.Models.List<System.String> |
Definition
An absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to [[[SearchParameter.url]]]).
Declaration
public string Definition { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Documentation
This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.
Declaration
public string Documentation { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Modifier
A modifier supported for the search parameter.
Declaration
public List<string> Modifier { get; set; }
Property Value
| Type | Description |
|---|---|
| fhirCsR2.Models.List<System.String> |
Name
The name of the search parameter used in the interface.
Declaration
public string Name { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
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> |
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 |
Methods
| Improve this Doc View SourceDeserializeJson(ref Utf8JsonReader, JsonSerializerOptions)
Deserialize a JSON object
Declaration
public void DeserializeJson(ref Utf8JsonReader reader, JsonSerializerOptions options)
Parameters
| Type | Name | Description |
|---|---|---|
| Utf8JsonReader | reader | |
| JsonSerializerOptions | options |
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 |
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 |