Class OperationDefinition

A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).

Inheritance
System.Object
Resource
DomainResource
OperationDefinition
Implements
Inherited Members
Namespace: fhirCsR2.Models
Assembly: fhirCsR2.dll
Syntax
public class OperationDefinition : DomainResource, IFhirJsonSerializable

Properties

| Improve this Doc View Source

_Code

Extension container element for Code

Declaration
public Element _Code { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Date

Extension container element for Date

Declaration
public Element _Date { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Description

Extension container element for Description

Declaration
public Element _Description { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Experimental

Extension container element for Experimental

Declaration
public Element _Experimental { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Idempotent

Extension container element for Idempotent

Declaration
public Element _Idempotent { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Instance

Extension container element for Instance

Declaration
public Element _Instance { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Kind

Extension container element for Kind

Declaration
public Element _Kind { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Name

Extension container element for Name

Declaration
public Element _Name { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Notes

Extension container element for Notes

Declaration
public Element _Notes { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Publisher

Extension container element for Publisher

Declaration
public Element _Publisher { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Requirements

Extension container element for Requirements

Declaration
public Element _Requirements { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Status

Extension container element for Status

Declaration
public Element _Status { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_System

Extension container element for System

Declaration
public Element _System { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Type

Extension container element for Type

Declaration
public List<Element> _Type { get; set; }
Property Value
Type Description
fhirCsR2.Models.List<Element>
| Improve this Doc View Source

_Url

Extension container element for Url

Declaration
public Element _Url { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

_Version

Extension container element for Version

Declaration
public Element _Version { get; set; }
Property Value
Type Description
Element
| Improve this Doc View Source

Base

Indicates that this operation definition is a constraining profile on the base.

Declaration
public Reference Base { get; set; }
Property Value
Type Description
Reference
| Improve this Doc View Source

Code

The name used to invoke the operation.

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

Contact

Contacts to assist a user in finding and communicating with the publisher.

Declaration
public List<OperationDefinitionContact> Contact { get; set; }
Property Value
Type Description
fhirCsR2.Models.List<OperationDefinitionContact>
| Improve this Doc View Source

Date

The date this version of the operation definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the Operation Definition changes.

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

Description

A free text natural language description of the profile and its use.

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

Experimental

Allows filtering of profiles that are appropriate for use vs. not.

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

Idempotent

Operations that are idempotent (see HTTP specification definition of idempotent) may be invoked by performing an HTTP GET operation instead of a POST.

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

Instance

Indicates whether this operation can be invoked on a particular instance of one of the given types.

Declaration
public bool Instance { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Kind

Whether this is an operation or a named query.

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

Name

A free text natural language name identifying the operation.

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

Notes

Additional information about how to use this operation or named query.

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

Parameter

The parameters for the operation/query.

Declaration
public List<OperationDefinitionParameter> Parameter { get; set; }
Property Value
Type Description
fhirCsR2.Models.List<OperationDefinitionParameter>
| Improve this Doc View Source

Publisher

Helps establish the "authority/credibility" of the operation definition. May also allow for contact.

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

Requirements

Explains why this operation definition is needed and why it's been constrained as it has.

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

ResourceType

Resource Type Name

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

Status

Allows filtering of profiles that are appropriate for use vs. not.

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

System

Indicates whether this operation or named query can be invoked at the system level (e.g. without needing to choose a resource type for the context).

Declaration
public bool System { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Type

Indicates whether this operation or named query can be invoked at the resource type level for any given resource type level (e.g. without needing to choose a resource type for the context).

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

Url

An absolute URL that is used to identify this operation definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this operation definition is (or will be) published.

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

Version

There may be multiple resource versions of the profile that have this same identifier. The resource version id will change for technical reasons, whereas the stated version number needs to be under the author's control.

Declaration
public string Version { get; set; }
Property Value
Type Description
System.String

Methods

| Improve this Doc View Source

DeserializeJson(ref Utf8JsonReader, JsonSerializerOptions)

Deserialize a JSON object

Declaration
public void DeserializeJson(ref Utf8JsonReader reader, JsonSerializerOptions options)
Parameters
Type Name Description
Utf8JsonReader reader
JsonSerializerOptions options
| Improve this Doc View Source

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
| Improve this Doc View Source

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

Implements