Class FhirSearchParam

A fhir search parameter.

Inheritance

System.Object

FhirSearchParam

Namespace: Microsoft.Health.Fhir.CodeGenCommon.Models

Assembly: Microsoft.Health.Fhir.CodeGenCommon.dll

Syntax

public class FhirSearchParam : ICloneable

Constructors

| Improve this Doc View Source

FhirSearchParam(String, Uri, String, String, String, String, String, List<String>, List<String>, String, String, String, Nullable<Int32>, Boolean, String, String, String, List<FhirSearchParamComponent>)

Initializes a new instance of the FhirSearchParam class.

Declaration

public FhirSearchParam(string id, Uri url, string version, string name, string description, string definition, string code, List<string> resourceTypes, List<string> targets, string valueType, string publicationStatus, string standardStatus, int? fmmLevel, bool isExperimental, string xpath, string xpathUsage, string expression, List<FhirSearchParamComponent> components = null)

Parameters

Type	Name	Description
System.String	id	The identifier.
Uri	url	The URL.
System.String	version	The version.
System.String	name	The name.
System.String	description	The description.
System.String	definition	The purpose.
System.String	code	The code.
List<System.String>	resourceTypes	The type of the resource.
List<System.String>	targets	The targets.
System.String	valueType	The type of the value.
System.String	publicationStatus	The publication status.
System.String	standardStatus	The standard status.
System.Nullable<System.Int32>	fmmLevel	The fmm level.
System.Boolean	isExperimental	True if is experimental, false if not.
System.String	xpath	The xpath.
System.String	xpathUsage	The xpath usage.
System.String	expression	The expression.
List<FhirSearchParamComponent>	components

Properties

| Improve this Doc View Source

Code

Gets the code.

Declaration

public string Code { get; }

Property Value

Type	Description
System.String	The code.

| Improve this Doc View Source

Components

Gets the components.

Declaration

public List<FhirSearchParamComponent> Components { get; }

Property Value

Type	Description
List<FhirSearchParamComponent>

| Improve this Doc View Source

CompositeResolvesCorrectly

Declaration

public bool? CompositeResolvesCorrectly { get; }

Property Value

Type	Description
System.Nullable<System.Boolean>

| Improve this Doc View Source

Description

Gets the description.

Declaration

public string Description { get; }

Property Value

Type	Description
System.String	The description.

| Improve this Doc View Source

Expression

Gets the expression.

Declaration

public string Expression { get; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

FhirMaturityLevel

Gets the FHIR maturity level.

Declaration

public int? FhirMaturityLevel { get; }

Property Value

Type	Description
System.Nullable<System.Int32>

| Improve this Doc View Source

Id

Gets the identifier.

Declaration

public string Id { get; }

Property Value

Type	Description
System.String	The identifier.

| Improve this Doc View Source

IsExperimental

Gets a value indicating whether this object is experimental.

Declaration

public bool IsExperimental { get; }

Property Value

Type	Description
System.Boolean	True if this object is experimental, false if not.

| Improve this Doc View Source

Name

Gets the name.

Declaration

public string Name { get; }

Property Value

Type	Description
System.String	The name.

| Improve this Doc View Source

PublicationStatus

Gets the standard status.

Declaration

public string PublicationStatus { get; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

Purpose

Gets the purpose.

Declaration

public string Purpose { get; }

Property Value

Type	Description
System.String	The purpose.

| Improve this Doc View Source

ResourceTypes

Gets the type of the resource.

Declaration

public List<string> ResourceTypes { get; }

Property Value

Type	Description
List<System.String>	The type of the resource.

| Improve this Doc View Source

StandardStatus

Gets status of this type in the standards process see: http://hl7.org/fhir/valueset-standards-status.html.

Declaration

public string StandardStatus { get; }

Property Value

Type	Description
System.String	The standard status.

| Improve this Doc View Source

Targets

Gets the resource (e.g., reference) targets.

Declaration

public List<string> Targets { get; }

Property Value

Type	Description
List<System.String>

| Improve this Doc View Source

URL

Gets URL of the document.

Declaration

public Uri URL { get; }

Property Value

Type	Description
Uri	The URL.

| Improve this Doc View Source

ValueType

Gets the type of the value.

Declaration

public string ValueType { get; }

Property Value

Type	Description
System.String	The type of the value.

| Improve this Doc View Source

Version

Gets the version.

Declaration

public string Version { get; }

Property Value

Type	Description
System.String	The version.

| Improve this Doc View Source

XPath

Gets the XPath specification for this search parameter.

Declaration

public string XPath { get; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

XPathUsage

Gets the XPath usage information.

Declaration

public string XPathUsage { get; }

Property Value

Type	Description
System.String

Methods

| Improve this Doc View Source

Clone()

Deep copy.

Declaration

public object Clone()

Returns

Type	Description
System.Object	A FhirSearchParam.

| Improve this Doc View Source

Resolve(Dictionary<String, FhirSearchParam>)

Declaration

public void Resolve(Dictionary<string, FhirSearchParam> searchParameters)

Parameters

Type	Name	Description
Dictionary<System.String, FhirSearchParam>	searchParameters