Class FhirResourceCapability

A fhir capability.

Inheritance

System.Object

FhirResourceCapability

Namespace: Microsoft.Health.Fhir.CodeGenCommon.Models

Assembly: Microsoft.Health.Fhir.CodeGenCommon.dll

Syntax

public class FhirResourceCapability : object

Constructors

| Improve this Doc View Source

FhirResourceCapability(String, Uri, String, String, String[], Boolean, Boolean, Boolean, String, Boolean, String, List<String>, List<String>, List<FhirSearchParam>, List<FhirOperation>)

Initializes a new instance of the FhirResourceCapability class.

Declaration

public FhirResourceCapability(string name, Uri url, string resourceName, string resourceProfile, string[] interactions, bool readHistory, bool updateCreate, bool conditionalCreate, string conditionalRead, bool conditionalUpdate, string conditionalDelete, List<string> searchIncludes, List<string> searchRevIncludes, List<FhirSearchParam> searchParams, List<FhirOperation> operations)

Parameters

Type	Name	Description
System.String	name	The name.
Uri	url	The URL.
System.String	resourceName	The name of the resource.
System.String	resourceProfile	The resource profile.
System.String[]	interactions	The interactions.
System.Boolean	readHistory	True if read history, false if not.
System.Boolean	updateCreate	True if update create, false if not.
System.Boolean	conditionalCreate	True if conditional create, false if not.
System.String	conditionalRead	The conditional read.
System.Boolean	conditionalUpdate	True if conditional update, false if not.
System.String	conditionalDelete	The conditional delete.
List<System.String>	searchIncludes	The _include values supported by the server.
List<System.String>	searchRevIncludes	The _revinclude values supported by the server.
List<FhirSearchParam>	searchParams	Options for controlling the search.
List<FhirOperation>	operations	The operations.

Properties

| Improve this Doc View Source

ConditionalCreate

Gets a value indicating whether the system allows/uses conditional create.

Declaration

public bool ConditionalCreate { get; }

Property Value

Type	Description
System.Boolean	True if conditional create, false if not.

| Improve this Doc View Source

ConditionalDelete

Gets the conditional delete support.

Declaration

public FhirResourceCapability.ConditionalDeleteStatus ConditionalDelete { get; }

Property Value

Type	Description
FhirResourceCapability.ConditionalDeleteStatus	The conditional delete.

| Improve this Doc View Source

ConditionalRead

Gets the conditional read support.

Declaration

public FhirResourceCapability.ConditionalReadStatus ConditionalRead { get; }

Property Value

Type	Description
FhirResourceCapability.ConditionalReadStatus	The conditional read.

| Improve this Doc View Source

ConditionalUpdate

Gets a value indicating whether the system allows/uses conditional update.

Declaration

public bool ConditionalUpdate { get; }

Property Value

Type	Description
System.Boolean	True if conditional update, false if not.

| Improve this Doc View Source

InteractionCreate

Gets a value indicating whether the system supports creating a resource with a system-assigned id.

Declaration

public bool InteractionCreate { get; }

Property Value

Type	Description
System.Boolean	True if the system supports typed create, false if not.

| Improve this Doc View Source

InteractionDelete

Gets a value indicating whether the system supports deleting a resource.

Declaration

public bool InteractionDelete { get; }

Property Value

Type	Description
System.Boolean	True if the system supports instance delete, false if not.

| Improve this Doc View Source

InteractionHistoryInstance

Gets a value indicating whether the system supports retrieving the change history for a particular resource.

Declaration

public bool InteractionHistoryInstance { get; }

Property Value

Type	Description
System.Boolean	True if the system supports instance history, false if not.

| Improve this Doc View Source

InteractionHistoryType

Gets a value indicating whether the system supports retrieving the change history for all resources of a particular type.

Declaration

public bool InteractionHistoryType { get; }

Property Value

Type	Description
System.Boolean	True if supports history type, false if not.

| Improve this Doc View Source

InteractionPatch

Gets a value indicating whether the system supports updates to an existing resource by posting a set of changes to it.

Declaration

public bool InteractionPatch { get; }

Property Value

Type	Description
System.Boolean	True if the system supports instance patch, false if not.

| Improve this Doc View Source

InteractionRead

Gets a value indicating whether the system supports reading the current state of the resource.

Declaration

public bool InteractionRead { get; }

Property Value

Type	Description
System.Boolean	True if the system supports instance read, false if not.

| Improve this Doc View Source

InteractionSearchType

Gets a value indicating whether the system supports searching all resources of the specified type.

Declaration

public bool InteractionSearchType { get; }

Property Value

Type	Description
System.Boolean	True if the system supports typed search, false if not.

| Improve this Doc View Source

InteractionUpdate

Gets a value indicating whether the system supports updating an existing resource by its id (or create it if it is new).

Declaration

public bool InteractionUpdate { get; }

Property Value

Type	Description
System.Boolean	True if the system supports instance update, false if not.

| Improve this Doc View Source

InteractionVRead

Gets a value indicating whether the system supports reading the state of a specific version of the resource.

Declaration

public bool InteractionVRead { get; }

Property Value

Type	Description
System.Boolean	True if the system supports instance vRead, 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

Operations

Gets the operations.

Declaration

public Dictionary<string, FhirOperation> Operations { get; }

Property Value

Type	Description
Dictionary<System.String, FhirOperation>	The operations.

| 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.Boolean	True if read history, false if not.

| Improve this Doc View Source

ResourceName

Gets the name of the resource.

Declaration

public string ResourceName { get; }

Property Value

Type	Description
System.String	The name of the resource.

| Improve this Doc View Source

ResourceProfile

Gets the resource profile.

Declaration

public string ResourceProfile { get; }

Property Value

Type	Description
System.String	The resource profile.

| 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>	The _include values supported by the server.

| Improve this Doc View Source

SearchParameters

Gets the list of search parameters for this capability.

Declaration

public Dictionary<string, FhirSearchParam> SearchParameters { get; }

Property Value

Type	Description
Dictionary<System.String, FhirSearchParam>	Search parameters for this capability.

| 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>	The _revinclude values supported by the server.

| Improve this Doc View Source

UpdateCreate

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

Declaration

public bool UpdateCreate { get; }

Property Value

Type	Description
System.Boolean	True if update create, false if not.

| Improve this Doc View Source

URL

Gets URL of the document.

Declaration

public Uri URL { get; }

Property Value

Type	Description
Uri	The URL.