Interface IFhirConverter

Interface for converter.

Namespace: Microsoft.Health.Fhir.SpecManager.Converters

Assembly: Microsoft.Health.Fhir.SpecManager.dll

Syntax

public interface IFhirConverter

Methods

DisplayIssues()

Displays the issues.

Declaration

void DisplayIssues()

HasIssues(out Int32, out Int32)

Query if 'errorCount' has issues.

Declaration

bool HasIssues(out int errorCount, out int warningCount)

Parameters

Type	Name	Description
System.Int32	errorCount	[out] Number of errors.
System.Int32	warningCount	[out] Number of warnings.

Returns

Type	Description
System.Boolean	True if issues, false if not.

ProcessMetadata(Object, String, SmartConfiguration, out FhirCapabiltyStatement)

Process a FHIR metadata resource into Server Information.

Declaration

void ProcessMetadata(object metadata, string serverUrl, SmartConfiguration smartConfig, out FhirCapabiltyStatement capabilities)

Parameters

Type	Name	Description
System.Object	metadata	The metadata resource object (e.g., r4.CapabilitiesStatement).
System.String	serverUrl	URL of the server.
SmartConfiguration	smartConfig	The smart configuration.
FhirCapabiltyStatement	capabilities	[out] Capabilities of a server.

ProcessResource(Object, IPackageImportable)

Attempts to process resource.

Declaration

void ProcessResource(object resourceToParse, IPackageImportable fhirVersionInfo)

Parameters

Type	Name	Description
System.Object	resourceToParse	The resource object.
IPackageImportable	fhirVersionInfo	Information describing the FHIR version.

ProcessResource(Object, IPackageImportable, out String, out FhirArtifactClassEnum)

Attempts to process resource.

Declaration

void ProcessResource(object resourceToParse, IPackageImportable fhirVersionInfo, out string resourceCanonical, out FhirArtifactClassEnum artifactClass)

Parameters

Type	Name	Description
System.Object	resourceToParse	The resource object.
IPackageImportable	fhirVersionInfo	Information describing the FHIR version.
System.String	resourceCanonical	Canonical URL of the processed resource, or string.Empty if not processed.
FhirArtifactClassEnum	artifactClass	Class of the resource parsed

ReplaceValue(Object, String[], Object)

Replace a value in a parsed but not-yet processed resource

Declaration

void ReplaceValue(object resource, string[] path, object value)

Parameters

Type	Name	Description
System.Object	resource
System.String[]	path
System.Object	value

TryGetFirstFromBundle(String, out Object, out String)

Attempts to get the first resource from a bundle.

Declaration

bool TryGetFirstFromBundle(string json, out object resource, out string resourceType)

Parameters

Type	Name	Description
System.String	json	The JSON.
System.Object	resource	[out].
System.String	resourceType	[out] Type of the resource.

Returns

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

TryParseResource(String, out Object, out String)

Try to parse a JSON string into a resource object.

Declaration

bool TryParseResource(string json, out object resource, out string resourceType)

Parameters

Type	Name	Description
System.String	json	The JSON.
System.Object	resource	[out].
System.String	resourceType	[out] Type of the resource.

Returns

Type	Description
System.Boolean	A typed Resource object.