Interface IPackageExportable

Interface for package exportable.

Namespace: Microsoft.Health.Fhir.SpecManager.Manager

Assembly: Microsoft.Health.Fhir.SpecManager.dll

Syntax

public interface IPackageExportable

Properties

| Improve this Doc View Source

AllInteractionParameters

Gets search parameters defined for all interactions.

Declaration

Dictionary<string, FhirSearchParam> AllInteractionParameters { get; }

Property Value

Type	Description
Dictionary<System.String, FhirSearchParam>

| Improve this Doc View Source

AllResourceParameters

Gets search parameters defined for all resources.

Declaration

Dictionary<string, FhirSearchParam> AllResourceParameters { get; }

Property Value

Type	Description
Dictionary<System.String, FhirSearchParam>

| Improve this Doc View Source

CapabilitiesByUrl

Gets known capability statements, keyed by URL.

Declaration

Dictionary<string, FhirCapabiltyStatement> CapabilitiesByUrl { get; }

Property Value

Type	Description
Dictionary<System.String, FhirCapabiltyStatement>

| Improve this Doc View Source

CodeSystems

Gets the code systems by URL dictionary.

Declaration

Dictionary<string, FhirCodeSystem> CodeSystems { get; }

Property Value

Type	Description
Dictionary<System.String, FhirCodeSystem>

| Improve this Doc View Source

CompartmentsByUrl

Gets Compartment definitions, keyed by URL.

Declaration

Dictionary<string, FhirCompartment> CompartmentsByUrl { get; }

Property Value

Type	Description
Dictionary<System.String, FhirCompartment>

| Improve this Doc View Source

ComplexTypes

Gets a dictionary with the known complex types for this version of FHIR.

Declaration

Dictionary<string, FhirComplex> ComplexTypes { get; }

Property Value

Type	Description
Dictionary<System.String, FhirComplex>

| Improve this Doc View Source

ExcludedKeys

Gets the excluded keys.

Declaration

HashSet<string> ExcludedKeys { get; }

Property Value

Type	Description
HashSet<System.String>

| Improve this Doc View Source

ExtensionsByPath

Gets the extensions per path, in a dictionary keyed by URL.

Declaration

Dictionary<string, Dictionary<string, FhirComplex>> ExtensionsByPath { get; }

Property Value

Type	Description
Dictionary<System.String, Dictionary<System.String, FhirComplex>>

| Improve this Doc View Source

ExtensionsByUrl

Gets an extensions by URL dictionary.

Declaration

Dictionary<string, FhirComplex> ExtensionsByUrl { get; }

Property Value

Type	Description
Dictionary<System.String, FhirComplex>

| Improve this Doc View Source

FhirSequence

Gets the FHIR major release, by enum.

Declaration

FhirPackageCommon.FhirSequenceEnum FhirSequence { get; }

Property Value

Type	Description
FhirPackageCommon.FhirSequenceEnum

| Improve this Doc View Source

ImplementationGuidesByUrl

Gets known implementation guides, keyed by URL.

Declaration

Dictionary<string, FhirImplementationGuide> ImplementationGuidesByUrl { get; }

Property Value

Type	Description
Dictionary<System.String, FhirImplementationGuide>

| Improve this Doc View Source

LogicalModels

Gets a dictionary with the known logical models.

Declaration

Dictionary<string, FhirComplex> LogicalModels { get; }

Property Value

Type	Description
Dictionary<System.String, FhirComplex>

| Improve this Doc View Source

MajorVersion

Gets the major version.

Declaration

int MajorVersion { get; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

NodeByPath

Gets the node info by path dictionary.

Declaration

Dictionary<string, FhirNodeInfo> NodeByPath { get; }

Property Value

Type	Description
Dictionary<System.String, FhirNodeInfo>

| Improve this Doc View Source

OperationsByUrl

Gets all known operations, by Url.

Declaration

Dictionary<string, FhirOperation> OperationsByUrl { get; }

Property Value

Type	Description
Dictionary<System.String, FhirOperation>

| Improve this Doc View Source

PackageDetails

Gets the package details.

Declaration

NpmPackageDetails PackageDetails { get; }

Property Value

Type	Description
NpmPackageDetails

| Improve this Doc View Source

PackageName

Gets the name of the package.

Declaration

string PackageName { get; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

PackageType

Gets the type of the package group.

Declaration

FhirPackageCommon.FhirPackageTypeEnum PackageType { get; }

Property Value

Type	Description
FhirPackageCommon.FhirPackageTypeEnum

| Improve this Doc View Source

PrimitiveTypes

Gets a dictionary with the known primitive types for this version of FHIR.

Declaration

Dictionary<string, FhirPrimitive> PrimitiveTypes { get; }

Property Value

Type	Description
Dictionary<System.String, FhirPrimitive>

| Improve this Doc View Source

Profiles

Gets the profiles by id dictionary.

Declaration

Dictionary<string, FhirComplex> Profiles { get; }

Property Value

Type	Description
Dictionary<System.String, FhirComplex>

| Improve this Doc View Source

ProfilesByBaseType

Gets a profiles by base type dictionary.

Declaration

Dictionary<string, Dictionary<string, FhirComplex>> ProfilesByBaseType { get; }

Property Value

Type	Description
Dictionary<System.String, Dictionary<System.String, FhirComplex>>

| Improve this Doc View Source

Resources

Gets a dictionary with the known resources for this version of FHIR.

Declaration

Dictionary<string, FhirComplex> Resources { get; }

Property Value

Type	Description
Dictionary<System.String, FhirComplex>

| Improve this Doc View Source

SearchParametersByUrl

Gets all search parameters by URL.

Declaration

Dictionary<string, FhirSearchParam> SearchParametersByUrl { get; }

Property Value

Type	Description
Dictionary<System.String, FhirSearchParam>

| Improve this Doc View Source

SearchResultParameters

Gets search parameters that control search results.

Declaration

Dictionary<string, FhirSearchParam> SearchResultParameters { get; }

Property Value

Type	Description
Dictionary<System.String, FhirSearchParam>

| Improve this Doc View Source

SystemOperations

Gets the system operations.

Declaration

Dictionary<string, FhirOperation> SystemOperations { get; }

Property Value

Type	Description
Dictionary<System.String, FhirOperation>

| Improve this Doc View Source

ValueSetsByUrl

Gets the value sets by URL dictionary.

Declaration

Dictionary<string, FhirValueSetCollection> ValueSetsByUrl { get; }

Property Value

Type	Description
Dictionary<System.String, FhirValueSetCollection>

| Improve this Doc View Source

VersionString

Gets the version string.

Declaration

string VersionString { get; }

Property Value

Type	Description
System.String

Methods

| Improve this Doc View Source

GetArtifacts(String)

Gets the artifacts in this collection.

Declaration

IEnumerable<FhirVersionInfo.ResolvedArtifactRecord> GetArtifacts(string token)

Parameters

Type	Name	Description
System.String	token	The ID or URL of the artifact.

Returns

Type	Description
IEnumerable<Microsoft.Health.Fhir.SpecManager.Manager.FhirVersionInfo.ResolvedArtifactRecord>	An enumerator that allows foreach to be used to process the artifacts in this collection.

| Improve this Doc View Source

GetInheritanceNamesHash(String)

Gets inheritance names hash.

Declaration

HashSet<string> GetInheritanceNamesHash(string key)

Parameters

Type	Name	Description
System.String	key	The key.

Returns

Type	Description
HashSet<System.String>	The inheritance names hash.

| Improve this Doc View Source

TryGetArtifact(String, out Object, out FhirArtifactClassEnum, out String, Boolean, FhirArtifactClassEnum)

Attempts to get artifact.

Declaration

bool TryGetArtifact(string token, out object artifact, out FhirArtifactClassEnum artifactClass, out string resolvedPackage, bool resolveParentLinks, FhirArtifactClassEnum knownArtifactClass)

Parameters

Type	Name	Description
System.String	token	The token.
System.Object	artifact	[out] The artifact.
FhirArtifactClassEnum	artifactClass	[out] The artifact class.
System.String	resolvedPackage	[out] The resolved package.
System.Boolean	resolveParentLinks	True to resolve parent links.
FhirArtifactClassEnum	knownArtifactClass

Returns

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

| Improve this Doc View Source

TryGetExplicitName(String, out String)

Attempts to get explicit name a string from the given string.

Declaration

bool TryGetExplicitName(string path, out string explicitName)

Parameters

Type	Name	Description
System.String	path	Full pathname of the file.
System.String	explicitName	[out] Name of the explicit.

Returns

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

| Improve this Doc View Source

TryGetNodeInfo(String, out FhirNodeInfo)

Attempts to get node information about the node described by the path.

Declaration

bool TryGetNodeInfo(string path, out FhirNodeInfo node)

Parameters

Type	Name	Description
System.String	path	Full pathname of the file.
FhirNodeInfo	node	[out] The node information.

Returns

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

| Improve this Doc View Source

TryGetValueSet(String, out FhirValueSet)

Attempts to get value set a FhirValueSet from the given string.

Declaration

bool TryGetValueSet(string urlOrKey, out FhirValueSet vs)

Parameters

Type	Name	Description
System.String	urlOrKey	The URL or key.
FhirValueSet	vs	[out] The vs.

Returns

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