Interface IPackageImportable
Interface for package importable.
Namespace: Microsoft.Health.Fhir.SpecManager.Manager
Assembly: Microsoft.Health.Fhir.SpecManager.dll
Syntax
public interface IPackageImportable
Properties
| Improve this Doc View SourceAllInteractionParameters
Gets search parameters defined for all interactions.
Declaration
Dictionary<string, FhirSearchParam> AllInteractionParameters { get; }
Property Value
Type | Description |
---|---|
Dictionary<System.String, FhirSearchParam> |
AllResourceParameters
Gets search parameters defined for all resources.
Declaration
Dictionary<string, FhirSearchParam> AllResourceParameters { get; }
Property Value
Type | Description |
---|---|
Dictionary<System.String, FhirSearchParam> |
BallotPrefix
Gets or sets the ballot prefix (e.g., 2021Jan).
Declaration
string BallotPrefix { get; set; }
Property Value
Type | Description |
---|---|
System.String |
BuildId
Gets or sets the identifier of the build.
Declaration
string BuildId { get; set; }
Property Value
Type | Description |
---|---|
System.String |
CapabilitiesByUrl
Gets known capability statements, keyed by URL.
Declaration
Dictionary<string, FhirCapabiltyStatement> CapabilitiesByUrl { get; }
Property Value
Type | Description |
---|---|
Dictionary<System.String, FhirCapabiltyStatement> |
CodeSystems
Gets the code systems by URL dictionary.
Declaration
Dictionary<string, FhirCodeSystem> CodeSystems { get; }
Property Value
Type | Description |
---|---|
Dictionary<System.String, FhirCodeSystem> |
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> |
DevBranch
Gets or sets the development branch.
Declaration
string DevBranch { get; set; }
Property Value
Type | Description |
---|---|
System.String |
ExamplesPackageName
Gets or sets the name of the examples package.
Declaration
string ExamplesPackageName { get; set; }
Property Value
Type | Description |
---|---|
System.String |
ExpansionsPackageName
Gets or sets the name of the expansions package.
Declaration
string ExpansionsPackageName { get; set; }
Property Value
Type | Description |
---|---|
System.String |
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>> |
ExtensionsByUrl
Gets an extensions by URL dictionary.
Declaration
Dictionary<string, FhirComplex> ExtensionsByUrl { get; }
Property Value
Type | Description |
---|---|
Dictionary<System.String, FhirComplex> |
FhirSequence
Gets or sets the FHIR major release, by enum.
Declaration
FhirPackageCommon.FhirSequenceEnum FhirSequence { get; set; }
Property Value
Type | Description |
---|---|
FhirPackageCommon.FhirSequenceEnum |
ImplementationGuidesByUrl
Gets known implementation guides, keyed by URL.
Declaration
Dictionary<string, FhirImplementationGuide> ImplementationGuidesByUrl { get; }
Property Value
Type | Description |
---|---|
Dictionary<System.String, FhirImplementationGuide> |
IsDevBuild
Gets or sets a value indicating whether this object is development build.
Declaration
bool IsDevBuild { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsLocalBuild
Gets or sets a value indicating whether this object is local build.
Declaration
bool IsLocalBuild { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsOnDisk
Gets or sets a value indicating whether this object is on disk.
Declaration
bool IsOnDisk { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
LastDownloaded
Gets or sets the Date/Time of the last downloaded.
Declaration
DateTime? LastDownloaded { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<DateTime> |
LocalDirectory
Gets or sets the pathname of the local directory.
Declaration
string LocalDirectory { get; set; }
Property Value
Type | Description |
---|---|
System.String |
LogicalModels
Gets a dictionary with the known logical models.
Declaration
Dictionary<string, FhirComplex> LogicalModels { get; }
Property Value
Type | Description |
---|---|
Dictionary<System.String, FhirComplex> |
MajorVersion
Gets or sets the major version.
Declaration
int MajorVersion { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
NodeByPath
Gets the node info by path dictionary.
Declaration
Dictionary<string, FhirNodeInfo> NodeByPath { get; }
Property Value
Type | Description |
---|---|
Dictionary<System.String, FhirNodeInfo> |
PackageDetails
Gets or sets the package details.
Declaration
NpmPackageDetails PackageDetails { get; set; }
Property Value
Type | Description |
---|---|
NpmPackageDetails |
PackageName
Gets or sets the name of the package.
Declaration
string PackageName { get; set; }
Property Value
Type | Description |
---|---|
System.String |
PackageType
Gets or sets the type of the package group.
Declaration
FhirPackageCommon.FhirPackageTypeEnum PackageType { get; set; }
Property Value
Type | Description |
---|---|
FhirPackageCommon.FhirPackageTypeEnum |
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> |
Profiles
Gets the profiles by id dictionary.
Declaration
Dictionary<string, FhirComplex> Profiles { get; }
Property Value
Type | Description |
---|---|
Dictionary<System.String, FhirComplex> |
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>> |
ReleaseName
Gets or sets the name of the package release.
Declaration
string ReleaseName { get; set; }
Property Value
Type | Description |
---|---|
System.String |
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> |
SearchParametersByUrl
Gets known search parameters, keyed by URL.
Declaration
Dictionary<string, FhirSearchParam> SearchParametersByUrl { get; }
Property Value
Type | Description |
---|---|
Dictionary<System.String, FhirSearchParam> |
SearchResultParameters
Gets search parameters that control search results.
Declaration
Dictionary<string, FhirSearchParam> SearchResultParameters { get; }
Property Value
Type | Description |
---|---|
Dictionary<System.String, FhirSearchParam> |
SystemOperations
Gets the system operations.
Declaration
Dictionary<string, FhirOperation> SystemOperations { get; }
Property Value
Type | Description |
---|---|
Dictionary<System.String, FhirOperation> |
ValueSetsByUrl
Gets the value sets by URL dictionary.
Declaration
Dictionary<string, FhirValueSetCollection> ValueSetsByUrl { get; }
Property Value
Type | Description |
---|---|
Dictionary<System.String, FhirValueSetCollection> |
VersionString
Gets or sets the version string.
Declaration
string VersionString { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Methods
| Improve this Doc View SourceAddCapabilityStatement(FhirCapabiltyStatement)
Adds a capability statement.
Declaration
void AddCapabilityStatement(FhirCapabiltyStatement cap)
Parameters
Type | Name | Description |
---|---|---|
FhirCapabiltyStatement | cap | The capability. |
AddCodeSystem(FhirCodeSystem)
Adds a code system.
Declaration
void AddCodeSystem(FhirCodeSystem codeSystem)
Parameters
Type | Name | Description |
---|---|---|
FhirCodeSystem | codeSystem | The code system. |
AddCompartment(FhirCompartment)
Adds a compartment.
Declaration
void AddCompartment(FhirCompartment compartment)
Parameters
Type | Name | Description |
---|---|---|
FhirCompartment | compartment | The compartment. |
AddComplexType(FhirComplex)
Adds a complex type.
Declaration
void AddComplexType(FhirComplex complex)
Parameters
Type | Name | Description |
---|---|---|
FhirComplex | complex | The complex. |
AddExtension(FhirComplex)
Adds an extension.
Declaration
void AddExtension(FhirComplex extension)
Parameters
Type | Name | Description |
---|---|---|
FhirComplex | extension | The extension. |
AddImplementationGuide(FhirImplementationGuide)
Adds an implementation guide.
Declaration
void AddImplementationGuide(FhirImplementationGuide ig)
Parameters
Type | Name | Description |
---|---|---|
FhirImplementationGuide | ig | The ig. |
AddLogicalModel(FhirComplex)
Adds a logical model.
Declaration
void AddLogicalModel(FhirComplex logicalModel)
Parameters
Type | Name | Description |
---|---|---|
FhirComplex | logicalModel | The logical model. |
AddOperation(FhirOperation)
Adds an operation.
Declaration
void AddOperation(FhirOperation operation)
Parameters
Type | Name | Description |
---|---|---|
FhirOperation | operation | The operation. |
AddPrimitive(FhirPrimitive)
Adds a primitive.
Declaration
void AddPrimitive(FhirPrimitive primitive)
Parameters
Type | Name | Description |
---|---|---|
FhirPrimitive | primitive | The primitive. |
AddProfile(FhirComplex)
Adds a profile.
Declaration
void AddProfile(FhirComplex complex)
Parameters
Type | Name | Description |
---|---|---|
FhirComplex | complex | The complex. |
AddResource(FhirComplex)
Adds a resource.
Declaration
void AddResource(FhirComplex resource)
Parameters
Type | Name | Description |
---|---|---|
FhirComplex | resource | The resource object. |
AddSearchParameter(FhirSearchParam)
Adds a search parameter.
Declaration
void AddSearchParameter(FhirSearchParam searchParam)
Parameters
Type | Name | Description |
---|---|---|
FhirSearchParam | searchParam | The search parameter. |
AddValueSet(FhirValueSet)
Adds a value set.
Declaration
void AddValueSet(FhirValueSet valueSet)
Parameters
Type | Name | Description |
---|---|---|
FhirValueSet | valueSet | Set the value belongs to. |
AddVersionedParam(FhirSearchParam.ParameterGrouping, String, String)
Adds a versioned parameter.
Declaration
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. |
ConverterHasIssues(out Int32, out Int32)
Determines if we can converter has issues.
Declaration
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. |
DisplayConverterIssues()
Displays the converter issues.
Declaration
void DisplayConverterIssues()
HasComplex(String)
Query if 'key' is a known complex data type.
Declaration
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. |
HasValueSet(String)
Query if 'urlOrKey' has value set.
Declaration
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. |
ProcessResource(Object)
Attempts to process resource.
Declaration
void ProcessResource(object resource)
Parameters
Type | Name | Description |
---|---|---|
System.Object | resource | [out] The resource object. |
ShouldIgnoreResource(String)
Determine if we should ignore resource.
Declaration
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. |
ShouldProcessResource(String)
Determine if we should process resource.
Declaration
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. |
ShouldSkipFile(String)
Determine if we should skip file.
Declaration
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. |
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. |
TryGetNodeInfo(String, out FhirNodeInfo)
Attempts to get node information a FhirNodeInfo from the given string.
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. |
Returns
Type | Description |
---|---|
System.Boolean | True if it succeeds, false if it fails. |
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. |
TryParseResource(String, out Object, out String)
Parses resource an object from the given string.
Declaration
bool TryParseResource(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 | A typed Resource object. |