Class FhirCapResource

A FHIR Resource support record from a CapabilityStatement.

Inheritance
System.Object
FhirCapResource
Namespace: Microsoft.Health.Fhir.CodeGenCommon.Models
Assembly: Microsoft.Health.Fhir.CodeGenCommon.dll
Syntax
public class FhirCapResource : ICloneable

Constructors

| Improve this Doc View Source

FhirCapResource(FhirCapResource)

Initializes a new instance of the FhirCapResource class.

Declaration
public FhirCapResource(FhirCapResource source)
Parameters
Type Name Description
FhirCapResource source

Source to copy.
| Improve this Doc View Source

FhirCapResource(String, String, List<String>, List<String>, List<String>, List<String>, String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, String, Nullable<Boolean>, Nullable<Boolean>, String, List<String>, List<String>, List<String>, List<String>, List<String>, Dictionary<String, FhirCapSearchParam>, Dictionary<String, FhirCapOperation>, IEnumerable<FhirCapSearchParamCombination>)

Initializes a new instance of the FhirCapResource class.

Declaration
public FhirCapResource(string resourceType, string expectation, List<string> interactions, List<string> interactionExpectations, List<string> supportedProfiles, List<string> supportedProfileExpectations, string versionSupport, bool? readHistory, bool? updateCreate, bool? conditionalCreate, string conditionalRead, bool? conditionalUpdate, bool? conditionalPatch, string conditionalDelete, List<string> referencePolicies, List<string> searchIncludes, List<string> searchIncludeExpectations, List<string> searchRevIncludes, List<string> searchRevIncludeExpectations, Dictionary<string, FhirCapSearchParam> searchParameters, Dictionary<string, FhirCapOperation> operations, IEnumerable<FhirCapSearchParamCombination> spCombinations)
Parameters
Type Name Description
System.String resourceType

The resource type.
System.String expectation

The conformance expectation.
List<System.String> interactions

The interactions.
List<System.String> interactionExpectations

The conformance expectations for the interactions.
List<System.String> supportedProfiles

The list of supported profile URLs.
List<System.String> supportedProfileExpectations

The conformance expectations for the supported profiles.
System.String versionSupport

The supported version policy.
System.Nullable<System.Boolean> readHistory

A value indicating whether vRead can return past versions.
System.Nullable<System.Boolean> updateCreate

A value indicating whether update can commit to a new identity.
System.Nullable<System.Boolean> conditionalCreate

A value indicating whether allows/uses conditional create.
System.String conditionalRead

The conditional read policy for this resource.
System.Nullable<System.Boolean> conditionalUpdate

A value indicating whether the conditional update.
System.Nullable<System.Boolean> conditionalPatch

If the server allows/uses conditional patch.
System.String conditionalDelete

The conditional delete.
List<System.String> referencePolicies

The reference policy.
List<System.String> searchIncludes

The _include values supported by the server.
List<System.String> searchIncludeExpectations

The conformance expectations for the search includes.
List<System.String> searchRevIncludes

The _revinclude values supported by the server.
List<System.String> searchRevIncludeExpectations

The conformance expectations for the reverse search includes.
Dictionary<System.String, FhirCapSearchParam> searchParameters

The search parameters supported by implementation.
Dictionary<System.String, FhirCapOperation> operations

The operations supported by implementation.
IEnumerable<FhirCapSearchParamCombination> spCombinations

Defined search parameter combinations.

Properties

| Improve this Doc View Source

ConditionalCreate

Gets a value indicating whether allows/uses conditional create.

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

ConditionalDelete

Gets the conditional delete.

Declaration
public FhirCapResource.ConditionalDeletePolicy? ConditionalDelete { get; }
Property Value
Type Description
System.Nullable<FhirCapResource.ConditionalDeletePolicy>
| Improve this Doc View Source

ConditionalPatch

If the server allows/uses conditional patch.

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

ConditionalRead

Gets the conditional read policy for this resource.

Declaration
public FhirCapResource.ConditionalReadPolicy? ConditionalRead { get; }
Property Value
Type Description
System.Nullable<FhirCapResource.ConditionalReadPolicy>
| Improve this Doc View Source

ConditionalUpdate

If the server allows/uses conditional update.

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

Expectation

Gets the conformance expectation.

Declaration
public FhirCapabiltyStatement.ExpectationCodes? Expectation { get; }
Property Value
Type Description
System.Nullable<FhirCapabiltyStatement.ExpectationCodes>
| Improve this Doc View Source

ExpectationLiteral

Gets the conformance expectation literal.

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

Interactions

Gets the supported interactions.

Declaration
public List<FhirCapResource.FhirInteractionCodes> Interactions { get; }
Property Value
Type Description
List<FhirCapResource.FhirInteractionCodes>
| Improve this Doc View Source

InteractionsEx

Gets the supported interactions, with conformance expectations.

Declaration
public IEnumerable<FhirCapabiltyStatement.ValWithExpectation<FhirCapResource.FhirInteractionCodes>> InteractionsEx { get; }
Property Value
Type Description
IEnumerable<FhirCapabiltyStatement.ValWithExpectation<FhirCapResource.FhirInteractionCodes>>
| Improve this Doc View Source

Operations

Gets the operations supported by implementation.

Declaration
public Dictionary<string, FhirCapOperation> Operations { get; }
Property Value
Type Description
Dictionary<System.String, FhirCapOperation>
| Improve this Doc View Source

ReadHistory

Gets a value indicating whether vRead can return past versions.

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

ReferencePolicies

Gets the reference policy.

Declaration
public List<FhirCapResource.ReferenceHandlingPolicy> ReferencePolicies { get; }
Property Value
Type Description
List<FhirCapResource.ReferenceHandlingPolicy>
| Improve this Doc View Source

ResourceType

Gets the resource type.

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

SearchIncludes

Gets the _include values supported by the server.

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

SearchIncludesEx

Gets the search includes, with conformance expectations.

Declaration
public IEnumerable<FhirCapabiltyStatement.ValWithExpectation<string>> SearchIncludesEx { get; }
Property Value
Type Description
IEnumerable<FhirCapabiltyStatement.ValWithExpectation<System.String>>
| Improve this Doc View Source

SearchParameterCombinations

Gets the search parameter combinations.

Declaration
public IEnumerable<FhirCapSearchParamCombination> SearchParameterCombinations { get; }
Property Value
Type Description
IEnumerable<FhirCapSearchParamCombination>
| Improve this Doc View Source

SearchParameters

Gets the search parameters supported by implementation.

Declaration
public Dictionary<string, FhirCapSearchParam> SearchParameters { get; }
Property Value
Type Description
Dictionary<System.String, FhirCapSearchParam>
| Improve this Doc View Source

SearchRevIncludes

Gets the _revinclude values supported by the server.

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

SearchRevIncludesEx

Gets the search reverse includes, with conformance expectations.

Declaration
public IEnumerable<FhirCapabiltyStatement.ValWithExpectation<string>> SearchRevIncludesEx { get; }
Property Value
Type Description
IEnumerable<FhirCapabiltyStatement.ValWithExpectation<System.String>>
| Improve this Doc View Source

SupportedProfiles

Gets the list of supported profile URLs.

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

SupportedProfilesEx

Gets the supported profile URLs, with conformance expectations.

Declaration
public IEnumerable<FhirCapabiltyStatement.ValWithExpectation<string>> SupportedProfilesEx { get; }
Property Value
Type Description
IEnumerable<FhirCapabiltyStatement.ValWithExpectation<System.String>>
| Improve this Doc View Source

UpdateCreate

Gets a value indicating whether update can commit to a new identity.

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

VersionSupport

Gets the supported version policy.

Declaration
public FhirCapResource.VersioningPolicy? VersionSupport { get; }
Property Value
Type Description
System.Nullable<FhirCapResource.VersioningPolicy>

Methods

| Improve this Doc View Source

Clone()

Makes a deep copy of this object.

Declaration
public object Clone()
Returns
Type Description
System.Object

A copy of this object.
| Improve this Doc View Source

ToStringWithExpectation()

Converts this object to a string with expectation.

Declaration
public string ToStringWithExpectation()
Returns
Type Description
System.String

This object as a string.