Class FhirCapabiltyStatement

A FHIR server.

Inheritance

System.Object

FhirTypeBase

FhirModelBase

FhirCapabiltyStatement

Implements

ICloneable

Inherited Members

FhirModelBase.PublicationStatus

FhirModelBase.StandardStatus

FhirModelBase.FhirMaturityLevel

FhirModelBase.IsExperimental

FhirModelBase.ArtifactClass

FhirModelBase.FhirVersion

FhirModelBase.NarrativeText

FhirModelBase.NarrativeStatus

FhirModelBase.Url

FhirModelBase.Version

FhirModelBase.VersionAlgorithm

FhirModelBase.Title

FhirModelBase.Description

FhirTypeBase.Id

FhirTypeBase.Name

FhirTypeBase.NameCapitalized

FhirTypeBase.Path

FhirTypeBase.URL

FhirTypeBase.BaseTypeName

FhirTypeBase.BaseTypeCanonical

FhirTypeBase.ShortDescription

FhirTypeBase.Purpose

FhirTypeBase.Comment

FhirTypeBase.ValidationRegEx

FhirTypeBase.TypeForExport(FhirTypeBase.NamingConvention, Dictionary<String, String>, Boolean, String, HashSet<String>)

FhirTypeBase.NameForExport(FhirTypeBase.NamingConvention, Boolean, String, HashSet<String>)

Namespace: Microsoft.Health.Fhir.CodeGenCommon.Models

Assembly: Microsoft.Health.Fhir.CodeGenCommon.dll

Syntax

public class FhirCapabiltyStatement : FhirModelBase

Constructors

FhirCapabiltyStatement(List<String>, List<String>, String, String, String, String, String, String, String, Nullable<Int32>, Boolean, String, String, String, String, String, IEnumerable<String>, IEnumerable<String>, IEnumerable<String>, IEnumerable<String>, String, String, String, String, String, IEnumerable<String>, IEnumerable<String>, IEnumerable<String>, IEnumerable<String>, Dictionary<String, FhirCapResource>, Dictionary<String, FhirCapSearchParam>, Dictionary<String, FhirCapOperation>, IEnumerable<FhirCapSecurityScheme>)

Initializes a new instance of the FhirCapabiltyStatement class.

Declaration

public FhirCapabiltyStatement(List<string> serverInteractions, List<string> serverInteractionExpectations, string id, string url, string name, string title, string version, string publicationStatus, string standardStatus, int? fmmLevel, bool isExperimental, string description, string narrative, string narrativeStatus, string fhirVersion, string capabilityStatementKind, IEnumerable<string> fhirMimeTypes, IEnumerable<string> fhirMimeTypeExpectations, IEnumerable<string> patchMimeTypes, IEnumerable<string> patchMimeTypeExpectations, string softwareName, string softwareVersion, string softwareReleaseDate, string implementationDescription, string implementationUrl, IEnumerable<string> instantiates, IEnumerable<string> instantiateExpectations, IEnumerable<string> implementationGuides, IEnumerable<string> implementationGuideExpectations, Dictionary<string, FhirCapResource> resourceInteractions, Dictionary<string, FhirCapSearchParam> serverSearchParameters, Dictionary<string, FhirCapOperation> serverOperations, IEnumerable<FhirCapSecurityScheme> securitySchemes)

Parameters

Type	Name	Description
List<System.String>	serverInteractions	The server interaction flags.
List<System.String>	serverInteractionExpectations	Conformance expectations for server interactions.
System.String	id	The identifier.
System.String	url	FHIR Base URL for the server.
System.String	name	The name.
System.String	title	The title.
System.String	version	Version of this Capability Statement.
System.String	publicationStatus	Publication Status (draft,etc.).
System.String	standardStatus	Standard status (e.g., STU, Normative).
System.Nullable<System.Int32>	fmmLevel	FHIR Maturity Model number.
System.Boolean	isExperimental	A value indicating whether this object is experimental.
System.String	description	The description.
System.String	narrative	The narrative.
System.String	narrativeStatus	The narrative status.
System.String	fhirVersion	The server-reported FHIR version.
System.String	capabilityStatementKind	The capability statement kind.
IEnumerable<System.String>	fhirMimeTypes	List of supported FHIR MIME types.
IEnumerable<System.String>	fhirMimeTypeExpectations	List of conformance expectations for FHIR MIME types.
IEnumerable<System.String>	patchMimeTypes	List of supported patch MIME types.
IEnumerable<System.String>	patchMimeTypeExpectations	List of conformance expectations for patch MIME types.
System.String	softwareName	The FHIR Server software name.
System.String	softwareVersion	The FHIR Server software version.
System.String	softwareReleaseDate	The FHIR Server software release date.
System.String	implementationDescription	Information describing the implementation.
System.String	implementationUrl	URL of the implementation.
IEnumerable<System.String>	instantiates	Canonical URL of another capability statement this CS implements.
IEnumerable<System.String>	instantiateExpectations	Conformance expectations for supported capability statements,.
IEnumerable<System.String>	implementationGuides	Implementation guides supported.
IEnumerable<System.String>	implementationGuideExpectations	Implementation guide conformance expectations.
Dictionary<System.String, FhirCapResource>	resourceInteractions	The server interactions by resource.
Dictionary<System.String, FhirCapSearchParam>	serverSearchParameters	The search parameters for searching all resources.
Dictionary<System.String, FhirCapOperation>	serverOperations	The operations defined at the system level operation.
IEnumerable<FhirCapSecurityScheme>	securitySchemes	The security schemes supported by the server.

FhirCapabiltyStatement(FhirCapabiltyStatement)

Initializes a new instance of the FhirCapabiltyStatement class.

Declaration

public FhirCapabiltyStatement(FhirCapabiltyStatement source)

Parameters

Type	Name	Description
FhirCapabiltyStatement	source	Source for the.

Properties

FhirMimeTypes

Gets the FHIR MIME types.

Declaration

public IEnumerable<string> FhirMimeTypes { get; }

Property Value

Type	Description
IEnumerable<System.String>

FhirMimeTypesEx

Gets the FHIR MIME types, with conformance expectations.

Declaration

public IEnumerable<FhirCapabiltyStatement.ValWithExpectation<string>> FhirMimeTypesEx { get; }

Property Value

Type	Description
IEnumerable<FhirCapabiltyStatement.ValWithExpectation<System.String>>

ImplementationDescription

Gets information describing the implementation.

Declaration

public string ImplementationDescription { get; }

Property Value

Type	Description
System.String

ImplementationGuides

Gets the Implementation guides supported.

Declaration

public IEnumerable<string> ImplementationGuides { get; }

Property Value

Type	Description
IEnumerable<System.String>

ImplementationGuidesEx

Gets the implementation guides supported, with conformance expectations.

Declaration

public IEnumerable<FhirCapabiltyStatement.ValWithExpectation<string>> ImplementationGuidesEx { get; }

Property Value

Type	Description
IEnumerable<FhirCapabiltyStatement.ValWithExpectation<System.String>>

ImplementationUrl

Gets URL of the implementation.

Declaration

public string ImplementationUrl { get; }

Property Value

Type	Description
System.String

Instantiates

Gets the Canonical URLs of other capability statement this implements.

Declaration

public IEnumerable<string> Instantiates { get; }

Property Value

Type	Description
IEnumerable<System.String>

InstantiatesEx

Gets the instantiate information, with conformation expectations.

Declaration

public IEnumerable<FhirCapabiltyStatement.ValWithExpectation<string>> InstantiatesEx { get; }

Property Value

Type	Description
IEnumerable<FhirCapabiltyStatement.ValWithExpectation<System.String>>

PatchMimeTypes

Gets the patch MIME types.

Declaration

public IEnumerable<string> PatchMimeTypes { get; }

Property Value

Type	Description
IEnumerable<System.String>

PatchMimeTypesEx

Gets the patch MIME types, with conformance expectations.

Declaration

public IEnumerable<FhirCapabiltyStatement.ValWithExpectation<string>> PatchMimeTypesEx { get; }

Property Value

Type	Description
IEnumerable<FhirCapabiltyStatement.ValWithExpectation<System.String>>

ResourceInteractions

Gets the server interactions by resource.

Declaration

public Dictionary<string, FhirCapResource> ResourceInteractions { get; }

Property Value

Type	Description
Dictionary<System.String, FhirCapResource>

SecuritySchemes

Declaration

public IEnumerable<FhirCapSecurityScheme> SecuritySchemes { get; }

Property Value

Type	Description
IEnumerable<FhirCapSecurityScheme>

ServerInteractions

Gets the server interactions.

Declaration

public IEnumerable<FhirCapabiltyStatement.SystemRestfulInteraction> ServerInteractions { get; }

Property Value

Type	Description
IEnumerable<FhirCapabiltyStatement.SystemRestfulInteraction>

ServerInteractionsEx

Gets the server interactions, with conformance expectations.

Declaration

public IEnumerable<FhirCapabiltyStatement.ValWithExpectation<FhirCapabiltyStatement.SystemRestfulInteraction>> ServerInteractionsEx { get; }

Property Value

Type	Description
IEnumerable<FhirCapabiltyStatement.ValWithExpectation<FhirCapabiltyStatement.SystemRestfulInteraction>>

ServerOperations

Gets the operations defined at the system level operation.

Declaration

public Dictionary<string, FhirCapOperation> ServerOperations { get; }

Property Value

Type	Description
Dictionary<System.String, FhirCapOperation>

ServerSearchParameters

Gets the search parameters for searching all resources.

Declaration

public Dictionary<string, FhirCapSearchParam> ServerSearchParameters { get; }

Property Value

Type	Description
Dictionary<System.String, FhirCapSearchParam>

SoftwareName

Gets the FHIR Server software name.

Declaration

public string SoftwareName { get; }

Property Value

Type	Description
System.String

SoftwareReleaseDate

Gets the FHIR Server software release date.

Declaration

public string SoftwareReleaseDate { get; }

Property Value

Type	Description
System.String

SoftwareVersion

Gets the FHIR Server software version.

Declaration

public string SoftwareVersion { get; }

Property Value

Type	Description
System.String

Methods

Clone()

Creates a new object that is a copy of the current instance.

Declaration

public object Clone()

Returns

Type	Description
System.Object	A new object that is a copy of this instance.

ProcessExpectationEnumerables<T>(IEnumerable<T>, IEnumerable<String>)

Process the expectation enumerables.

Declaration

public static IEnumerable<FhirCapabiltyStatement.ValWithExpectation<T>> ProcessExpectationEnumerables<T>(IEnumerable<T> sourceValues, IEnumerable<string> sourceExpectations)

Parameters

Type	Name	Description
IEnumerable<T>	sourceValues
IEnumerable<System.String>	sourceExpectations

Returns

Type	Description
IEnumerable<FhirCapabiltyStatement.ValWithExpectation<T>>

Type Parameters

Name	Description
T

SupportsFhirJson()

Determines if we can supports FHIR JSON.

Declaration

public bool SupportsFhirJson()

Returns

Type	Description
System.Boolean	True if it succeeds, false if it fails.

SupportsFhirTurtle()

Determines if we can supports FHIR turtle.

Declaration

public bool SupportsFhirTurtle()

Returns

Type	Description
System.Boolean	True if it succeeds, false if it fails.

SupportsFhirXml()

Determines if we can supports FHIR XML.

Declaration

public bool SupportsFhirXml()

Returns

Type	Description
System.Boolean	True if it succeeds, false if it fails.

SupportsPatchFhirJson()

Determines if we can supports patch FHIR JSON.

Declaration

public bool SupportsPatchFhirJson()

Returns

Type	Description
System.Boolean	True if it succeeds, false if it fails.

SupportsPatchFhirXml()

Determines if we can supports patch FHIR XML.

Declaration

public bool SupportsPatchFhirXml()

Returns

Type	Description
System.Boolean	True if it succeeds, false if it fails.

SupportsPatchJson()

Determines if we can supports patch JSON.

Declaration

public bool SupportsPatchJson()

Returns

Type	Description
System.Boolean	True if it succeeds, false if it fails.

SupportsPatchXml()

Determines if we can supports patch XML.

Declaration

public bool SupportsPatchXml()

Returns

Type	Description
System.Boolean	True if it succeeds, false if it fails.

Implements

ICloneable