Class FhirParameter

A fhir parameter.

Inheritance

System.Object

FhirParameter

Namespace: Microsoft.Health.Fhir.CodeGenCommon.Models

Assembly: Microsoft.Health.Fhir.CodeGenCommon.dll

Syntax

public class FhirParameter : object

Constructors

| Improve this Doc View Source

FhirParameter(String, String, IEnumerable<String>, Int32, Nullable<Int32>, String, String, IEnumerable<String>, IEnumerable<String>, String, Int32)

Initializes a new instance of the FhirParameter class.

Declaration

public FhirParameter(string name, string use, IEnumerable<string> scopes, int min, int? max, string documentation, string valueType, IEnumerable<string> allowedSubTypes, IEnumerable<string> targetProfiles, string searchType, int fieldOrder)

Parameters

Type	Name	Description
System.String	name	The name.
System.String	use	The use.
IEnumerable<System.String>	scopes
System.Int32	min	The minimum value.
System.Nullable<System.Int32>	max	The maximum value.
System.String	documentation	The documentation.
System.String	valueType	The type.
IEnumerable<System.String>	allowedSubTypes	Allowed sub-type this parameter can have (if type is abstract).
IEnumerable<System.String>	targetProfiles	Target profiles.
System.String	searchType	If this is a search parameter, the search type.
System.Int32	fieldOrder	The field order.

| Improve this Doc View Source

FhirParameter(String, String, IEnumerable<String>, Int32, String, String, String, IEnumerable<String>, IEnumerable<String>, String, Int32)

Initializes a new instance of the FhirParameter class.

Declaration

public FhirParameter(string name, string use, IEnumerable<string> scopes, int min, string max, string documentation, string valueType, IEnumerable<string> allowedSubTypes, IEnumerable<string> targetProfiles, string searchType, int fieldOrder)

Parameters

Type	Name	Description
System.String	name	The name.
System.String	use	The use.
IEnumerable<System.String>	scopes	The scopes.
System.Int32	min	The minimum value.
System.String	max	The maximum value.
System.String	documentation	The documentation.
System.String	valueType	The type.
IEnumerable<System.String>	allowedSubTypes	Allowed sub-type this parameter can have (if type is abstract).
IEnumerable<System.String>	targetProfiles	Target profiles.
System.String	searchType	If this is a search parameter, the search type.
System.Int32	fieldOrder	The field order.

Properties

| Improve this Doc View Source

AllowedSubTypes

Gets the allowed sub-type this parameter can have (if type is abstract).

Declaration

public IEnumerable<string> AllowedSubTypes { get; }

Property Value

Type	Description
IEnumerable<System.String>

| Improve this Doc View Source

Documentation

Gets the documentation.

Declaration

public string Documentation { get; }

Property Value

Type	Description
System.String	The documentation.

| Improve this Doc View Source

FhirCardinality

Gets the FHIR cardinality string: min..max.

Declaration

public string FhirCardinality { get; }

Property Value

Type	Description
System.String	The FHIR cardinality.

| Improve this Doc View Source

FieldOrder

Gets the field order.

Declaration

public int FieldOrder { get; }

Property Value

Type	Description
System.Int32	The field order.

| Improve this Doc View Source

Max

Gets the maximum.

Declaration

public int? Max { get; }

Property Value

Type	Description
System.Nullable<System.Int32>	The maximum value.

| Improve this Doc View Source

MaxString

Gets the cardinality maximum string.

Declaration

public string MaxString { get; }

Property Value

Type	Description
System.String	The cardinality maximum string.

| Improve this Doc View Source

Min

Gets the minimum.

Declaration

public int Min { get; }

Property Value

Type	Description
System.Int32	The minimum value.

| 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

Scopes

Gets the scopes.

Declaration

public IEnumerable<string> Scopes { get; }

Property Value

Type	Description
IEnumerable<System.String>

| Improve this Doc View Source

SearchType

Gets the search type, if this is a search parameter.

Declaration

public string SearchType { get; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

TargetProfiles

Gets target profiles.

Declaration

public IEnumerable<string> TargetProfiles { get; }

Property Value

Type	Description
IEnumerable<System.String>

| Improve this Doc View Source

Use

Gets the use.

Declaration

public string Use { get; }

Property Value

Type	Description
System.String	The use.

| Improve this Doc View Source

ValueType

Gets the value type.

Declaration

public string ValueType { get; }

Property Value

Type	Description
System.String	The value type.

Methods

| Improve this Doc View Source

DeepCopy()

Deep copy.

Declaration

public FhirParameter DeepCopy()

Returns

Type	Description
FhirParameter	A FhirParameter.