Class FhirVersionInfo

Information about a FHIR package.

Inheritance

System.Object

FhirVersionInfo

Implements

IPackageImportable

IPackageExportable

Namespace: Microsoft.Health.Fhir.SpecManager.Manager

Assembly: Microsoft.Health.Fhir.SpecManager.dll

Syntax

public class FhirVersionInfo : object, IPackageImportable, IPackageExportable

Constructors

| Improve this Doc View Source

FhirVersionInfo()

Initializes a new instance of the FhirVersionInfo class.

Declaration

public FhirVersionInfo()

| Improve this Doc View Source

FhirVersionInfo(FhirPackageCommon.FhirSequenceEnum)

Declaration

public FhirVersionInfo(FhirPackageCommon.FhirSequenceEnum fhirSequence)

Parameters

Type	Name	Description
FhirPackageCommon.FhirSequenceEnum	fhirSequence

| Improve this Doc View Source

FhirVersionInfo(FhirVersionInfo, PackageCopyOptions, Boolean)

Initializes a new instance of the FhirVersionInfo class. Require major version (release #) to validate it is supported.

Declaration

public FhirVersionInfo(FhirVersionInfo source, PackageCopyOptions options, bool resolveExternal)

Parameters

Type	Name	Description
FhirVersionInfo	source	Source for the.
PackageCopyOptions	options	Options for controlling the operation.
System.Boolean	resolveExternal

| Improve this Doc View Source

FhirVersionInfo(String)

Initializes a new instance of the FhirVersionInfo class.

Declaration

public FhirVersionInfo(string packageDirectory)

Parameters

Type	Name	Description
System.String	packageDirectory	Pathname of the package directory.

Properties

| Improve this Doc View Source

AllInteractionParameters

Gets search parameters defined for all interactions.

Declaration

public 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

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

Property Value

Type	Description
Dictionary<System.String, FhirSearchParam>

| Improve this Doc View Source

ArtifactClassByUrl

Gets URL of the artifact class by.

Declaration

public Dictionary<string, FhirArtifactClassEnum> ArtifactClassByUrl { get; }

Property Value

Type	Description
Dictionary<System.String, FhirArtifactClassEnum>

| Improve this Doc View Source

ArtifactRecordsByClass

Gets the artifacts by class.

Declaration

public Dictionary<FhirArtifactClassEnum, List<FhirArtifactRecord>> ArtifactRecordsByClass { get; }

Property Value

Type	Description
Dictionary<FhirArtifactClassEnum, List<FhirArtifactRecord>>

| Improve this Doc View Source

BallotPrefix

Gets or sets the ballot prefix (e.g., 2021Jan).

Declaration

public string BallotPrefix { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

BuildId

Gets or sets the identifier of the build.

Declaration

public string BuildId { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

CanonicalUrl

Gets or sets canonical URL of this package.

Declaration

public Uri CanonicalUrl { get; set; }

Property Value

Type	Description
Uri

| Improve this Doc View Source

CapabilitiesByUrl

Gets known capability statements, keyed by URL.

Declaration

public 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

public Dictionary<string, FhirCodeSystem> CodeSystems { get; }

Property Value

Type	Description
Dictionary<System.String, FhirCodeSystem>

| Improve this Doc View Source

CompartmentsByUrl

Gets the compartments by URL.

Declaration

public 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

public Dictionary<string, FhirComplex> ComplexTypes { get; }

Property Value

Type	Description
Dictionary<System.String, FhirComplex>

| Improve this Doc View Source

DevBranch

Gets or sets the development branch.

Declaration

public string DevBranch { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

ExamplesPackageName

Gets or sets the name of the examples package.

Declaration

public string ExamplesPackageName { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

ExcludedKeys

Gets the excluded keys.

Declaration

public HashSet<string> ExcludedKeys { get; }

Property Value

Type	Description
HashSet<System.String>

| Improve this Doc View Source

ExpansionsPackageName

Gets or sets the name of the expansions package.

Declaration

public string ExpansionsPackageName { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

ExtensionsByPath

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

Declaration

public 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

public Dictionary<string, FhirComplex> ExtensionsByUrl { get; }

Property Value

Type	Description
Dictionary<System.String, FhirComplex>

| Improve this Doc View Source

FhirSequence

Gets or sets the major version.

Declaration

public FhirPackageCommon.FhirSequenceEnum FhirSequence { get; set; }

Property Value

Type	Description
FhirPackageCommon.FhirSequenceEnum

| Improve this Doc View Source

ImplementationGuidesByUrl

Gets known implementation guides, keyed by URL.

Declaration

public Dictionary<string, FhirImplementationGuide> ImplementationGuidesByUrl { get; }

Property Value

Type	Description
Dictionary<System.String, FhirImplementationGuide>

| Improve this Doc View Source

IsDevBuild

Gets or sets a value indicating whether this object is development build.

Declaration

public bool IsDevBuild { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsLocalBuild

Gets or sets a value indicating whether this object is local build.

Declaration

public bool IsLocalBuild { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsOnDisk

Gets or sets a value indicating whether this object is on disk.

Declaration

public bool IsOnDisk { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

LastDownloaded

Gets or sets the Date/Time of the last downloaded.

Declaration

public DateTime? LastDownloaded { get; set; }

Property Value

Type	Description
System.Nullable<DateTime>

| Improve this Doc View Source

LocalDirectory

Gets or sets the pathname of the local directory.

Declaration

public string LocalDirectory { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

LogicalModels

Gets a dictionary with the known logical models by name.

Declaration

public Dictionary<string, FhirComplex> LogicalModels { get; }

Property Value

Type	Description
Dictionary<System.String, FhirComplex>

| Improve this Doc View Source

MajorVersion

Gets or sets the name of the release.

Declaration

public int MajorVersion { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

NodeByPath

Gets the node info by path dictionary.

Declaration

public Dictionary<string, FhirNodeInfo> NodeByPath { get; }

Property Value

Type	Description
Dictionary<System.String, FhirNodeInfo>

| Improve this Doc View Source

OperationsByUrl

Gets known operations, keyed by URL.

Declaration

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

Property Value

Type	Description
Dictionary<System.String, FhirOperation>

| Improve this Doc View Source

PackageDetails

Gets or sets the package details.

Declaration

public NpmPackageDetails PackageDetails { get; set; }

Property Value

Type	Description
NpmPackageDetails

| Improve this Doc View Source

PackageName

Gets or sets the name of the package.

Declaration

public string PackageName { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

PackageType

Gets or sets the type of the package group.

Declaration

public FhirPackageCommon.FhirPackageTypeEnum PackageType { get; set; }

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

public 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

public 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

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

Property Value

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

| Improve this Doc View Source

ReleaseName

Gets or sets the name of the package release.

Declaration

public string ReleaseName { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

Resources

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

Declaration

public Dictionary<string, FhirComplex> Resources { get; }

Property Value

Type	Description
Dictionary<System.String, FhirComplex>

| Improve this Doc View Source

SearchParametersByUrl

Gets known search parameters, keyed by URL.

Declaration

public 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

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

Property Value

Type	Description
Dictionary<System.String, FhirSearchParam>

| Improve this Doc View Source

SystemOperations

Gets the system operations.

Declaration

public 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

public Dictionary<string, FhirValueSetCollection> ValueSetsByUrl { get; }

Property Value

Type	Description
Dictionary<System.String, FhirValueSetCollection>

| Improve this Doc View Source

VersionString

Gets or sets the version string.

Declaration

public string VersionString { get; set; }

Property Value

Type	Description
System.String

Methods

| Improve this Doc View Source

AddCanonicalAlias(String, String)

Declaration

public bool AddCanonicalAlias(string canonicalUrl, string canonicalAlias)

Parameters

Type	Name	Description
System.String	canonicalUrl
System.String	canonicalAlias

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

AddCapabilityStatement(FhirCapabiltyStatement)

Adds a capability statement.

Declaration

public void AddCapabilityStatement(FhirCapabiltyStatement cap)

Parameters

Type	Name	Description
FhirCapabiltyStatement	cap	The capability.

| Improve this Doc View Source

AddCodeSystem(FhirCodeSystem)

Adds a code system.

Declaration

public void AddCodeSystem(FhirCodeSystem codeSystem)

Parameters

Type	Name	Description
FhirCodeSystem	codeSystem	The code system.

| Improve this Doc View Source

AddCompartment(FhirCompartment)

Declaration

public void AddCompartment(FhirCompartment compartment)

Parameters

Type	Name	Description
FhirCompartment	compartment

| Improve this Doc View Source

AddComplexType(FhirComplex)

Adds a complex type.

Declaration

public void AddComplexType(FhirComplex complex)

Parameters

Type	Name	Description
FhirComplex	complex	The complex.

| Improve this Doc View Source

AddExtension(FhirComplex)

Adds an extension.

Declaration

public void AddExtension(FhirComplex extension)

Parameters

Type	Name	Description
FhirComplex	extension	The extension.

| Improve this Doc View Source

AddImplementationGuide(FhirImplementationGuide)

Adds an implementation guide.

Declaration

public void AddImplementationGuide(FhirImplementationGuide ig)

Parameters

Type	Name	Description
FhirImplementationGuide	ig	The ig.

| Improve this Doc View Source

AddLogicalModel(FhirComplex)

Adds a logical model.

Declaration

public void AddLogicalModel(FhirComplex logicalModel)

Parameters

Type	Name	Description
FhirComplex	logicalModel	The logical model.

| Improve this Doc View Source

AddOperation(FhirOperation)

Adds an operation.

Declaration

public void AddOperation(FhirOperation operation)

Parameters

Type	Name	Description
FhirOperation	operation	The operation.

| Improve this Doc View Source

AddPrimitive(FhirPrimitive)

Adds a primitive.

Declaration

public void AddPrimitive(FhirPrimitive primitive)

Parameters

Type	Name	Description
FhirPrimitive	primitive	The primitive.

| Improve this Doc View Source

AddProfile(FhirComplex)

Adds a profile.

Declaration

public void AddProfile(FhirComplex complex)

Parameters

Type	Name	Description
FhirComplex	complex	The complex.

| Improve this Doc View Source

AddResource(FhirComplex)

Adds a resource.

Declaration

public void AddResource(FhirComplex resource)

Parameters

Type	Name	Description
FhirComplex	resource	The resource object.

| Improve this Doc View Source

AddSearchParameter(FhirSearchParam)

Adds a search parameter.

Declaration

public void AddSearchParameter(FhirSearchParam searchParam)

Parameters

Type	Name	Description
FhirSearchParam	searchParam	The search parameter.

| Improve this Doc View Source

AddValueSet(FhirValueSet)

Adds a value set.

Declaration

public void AddValueSet(FhirValueSet valueSet)

Parameters

Type	Name	Description
FhirValueSet	valueSet	Set the value belongs to.

| Improve this Doc View Source

AddVersionedParam(FhirSearchParam.ParameterGrouping, String, String)

Adds a versioned parameter.

Declaration

public void AddVersionedParam(FhirSearchParam.ParameterGrouping searchMagicType, string name, string parameterType)

Parameters

Type	Name	Description
FhirSearchParam.ParameterGrouping	searchMagicType	Type of the search magic.
System.String	name	The name.
System.String	parameterType	Type of the parameter.

| Improve this Doc View Source

ConverterHasIssues(out Int32, out Int32)

Determines if we can converter has issues.

Declaration

public bool ConverterHasIssues(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 it succeeds, false if it fails.

| Improve this Doc View Source

DisplayConverterIssues()

Displays the converter issues.

Declaration

public void DisplayConverterIssues()

| Improve this Doc View Source

GetArtifactClass(String)

Gets artifact class.

Declaration

public FhirArtifactClassEnum GetArtifactClass(string token)

Parameters

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

Returns

Type	Description
FhirArtifactClassEnum	The artifact class.

| Improve this Doc View Source

GetArtifacts(String)

Gets the artifacts in this collection.

Declaration

public 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

public 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

HasComplex(String)

Query if 'key' is a known complex data type.

Declaration

public bool HasComplex(string key)

Parameters

Type	Name	Description
System.String	key	The key.

Returns

Type	Description
System.Boolean	True if 'key' exists, false if not.

| Improve this Doc View Source

HasValueSet(String)

Query if 'urlOrKey' has value set.

Declaration

public bool HasValueSet(string urlOrKey)

Parameters

Type	Name	Description
System.String	urlOrKey	The URL or key.

Returns

Type	Description
System.Boolean	True if value set, false if not.

| Improve this Doc View Source

ProcessResource(Object)

Attempts to process resource.

Declaration

public void ProcessResource(object resource)

Parameters

Type	Name	Description
System.Object	resource	[out] The resource object.

| Improve this Doc View Source

ProcessResource(Object, out String, out FhirArtifactClassEnum)

Attempts to process resource.

Declaration

public void ProcessResource(object resource, out string resourceCanonical, out FhirArtifactClassEnum artifactClass)

Parameters

Type	Name	Description
System.Object	resource	[out] The resource object.
System.String	resourceCanonical	Canonical of the processed resource, or string.Empty if not processed.
FhirArtifactClassEnum	artifactClass	Class of the resource parsed

| Improve this Doc View Source

ReplaceParsedValue(Object, String[], Object)

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

Declaration

public void ReplaceParsedValue(object resource, string[] path, object value)

Parameters

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

| Improve this Doc View Source

ShouldIgnoreResource(String)

Determine if we should ignore resource.

Declaration

public bool ShouldIgnoreResource(string resourceName)

Parameters

Type	Name	Description
System.String	resourceName	Name of the resource.

Returns

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

| Improve this Doc View Source

ShouldProcessResource(String)

Determine if we should process resource.

Declaration

public bool ShouldProcessResource(string resourceName)

Parameters

Type	Name	Description
System.String	resourceName	Name of the resource.

Returns

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

| Improve this Doc View Source

ShouldSkipFile(String)

Determine if we should skip file.

Declaration

public bool ShouldSkipFile(string filename)

Parameters

Type	Name	Description
System.String	filename	Filename of the file.

Returns

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

| Improve this Doc View Source

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

Attempts to get artifact.

Declaration

public bool TryGetArtifact(string token, out object artifact, out FhirArtifactClassEnum artifactClass, out string resolvedPackage, bool resolveParentLinks = true, FhirArtifactClassEnum knownArtifactClass = null)

Parameters

Type	Name	Description
System.String	token	The ID or URL of the artifact.
System.Object	artifact	[out] The artifact.
FhirArtifactClassEnum	artifactClass	[out] The artifact class enum.
System.String	resolvedPackage	[out] The resolved package.
System.Boolean	resolveParentLinks	(Optional) True to resolve parent links.
FhirArtifactClassEnum	knownArtifactClass	(Optional) Class hint to resolve artifacts

Returns

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

| Improve this Doc View Source

TryGetArtifactValues<T>(FhirArtifactClassEnum, out IEnumerable<T>)

Attempts to get artifact complexes an IEnumerable<FhirComplex> from the given FhirArtifactClassEnum.

Declaration

public bool TryGetArtifactValues<T>(FhirArtifactClassEnum artifactClass, out IEnumerable<T> values)

Parameters

Type	Name	Description
FhirArtifactClassEnum	artifactClass	[out] The artifact class enum.
IEnumerable<T>	values	[out] The artifact values.

Returns

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

Type Parameters

Name	Description
T	Generic type parameter.

| Improve this Doc View Source

TryGetExplicitName(String, out String)

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

Declaration

public 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

TryGetFirstFromBundle(String, out Object, out String)

Attempts to get first from bundle.

Declaration

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

Parameters

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

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

public 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

public 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.

| Improve this Doc View Source

TryParseResource(String, out Object, out String)

Parses resource an object from the given string.

Declaration

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

Parameters

Type	Name	Description
System.String	json	The JSON.
System.Object	resource
System.String	resourceType

Returns

Type	Description
System.Boolean	A typed Resource object.

Implements

IPackageImportable

IPackageExportable