Class FhirPackageCommon

Information about the FHIR core package.

Inheritance

System.Object

FhirPackageCommon

Namespace: Microsoft.Health.Fhir.SpecManager.Manager

Assembly: Microsoft.Health.Fhir.SpecManager.dll

Syntax

public static class FhirPackageCommon : object

Fields

| Improve this Doc View Source

UrlFhirType

Extension URL for FHIR type information (added R4).

Declaration

public const string UrlFhirType = null

Field Value

Type	Description
System.String

| Improve this Doc View Source

UrlJsonType

Extension URL for JSON type information.

Declaration

public const string UrlJsonType = null

Field Value

Type	Description
System.String

| Improve this Doc View Source

UrlXmlType

Extension URL for XML type information.

Declaration

public const string UrlXmlType = null

Field Value

Type	Description
System.String

Properties

| Improve this Doc View Source

CoreVersions

Gets the FHIR releases.

Declaration

public static List<FhirPackageCommon.PublishedReleaseInformation> CoreVersions { get; }

Property Value

Type	Description
List<Microsoft.Health.Fhir.SpecManager.Manager.FhirPackageCommon.PublishedReleaseInformation>

Methods

| Improve this Doc View Source

BallotPrefixForVersion(String)

Ballot prefix for version.

Declaration

public static string BallotPrefixForVersion(string version)

Parameters

Type	Name	Description
System.String	version	The version string.

Returns

Type	Description
System.String	A string.

| Improve this Doc View Source

IsKnownVersion(String)

Query if 'version' is known version.

Declaration

public static bool IsKnownVersion(string version)

Parameters

Type	Name	Description
System.String	version	The version string.

Returns

Type	Description
System.Boolean	True if the version string represents a known version of FHIR, false if not.

| Improve this Doc View Source

LatestVersionForRelease(FhirPackageCommon.FhirSequenceEnum)

Latest version for release.

Declaration

public static string LatestVersionForRelease(FhirPackageCommon.FhirSequenceEnum major)

Parameters

Type	Name	Description
FhirPackageCommon.FhirSequenceEnum	major	The major.

Returns

Type	Description
System.String	The current highest release number for a sequence.

| Improve this Doc View Source

MajorIntForVersion(FhirPackageCommon.FhirSequenceEnum)

Major for release.

Declaration

public static int MajorIntForVersion(FhirPackageCommon.FhirSequenceEnum release)

Parameters

Type	Name	Description
FhirPackageCommon.FhirSequenceEnum	release	The release.

Returns

Type	Description
System.Int32	The sequence release number for a FHIR release (e.g., 2 for DSTU2).

| Improve this Doc View Source

MajorReleaseForVersion(String)

Major release for version.

Declaration

public static FhirPackageCommon.FhirSequenceEnum MajorReleaseForVersion(string version)

Parameters

Type	Name	Description
System.String	version	The version string.

Returns

Type	Description
FhirPackageCommon.FhirSequenceEnum	The FhirMajorRelease that should be used for the specified version.

| Improve this Doc View Source

PackageBaseForRelease(FhirPackageCommon.FhirSequenceEnum)

Package base for release.

Declaration

public static string PackageBaseForRelease(FhirPackageCommon.FhirSequenceEnum major)

Parameters

Type	Name	Description
FhirPackageCommon.FhirSequenceEnum	major	The major.

Returns

Type	Description
System.String	A string.

| Improve this Doc View Source

PackageIsFhirCore(String)

Package is FHIR core.

Declaration

public static bool PackageIsFhirCore(string packageName)

Parameters

Type	Name	Description
System.String	packageName	Name of the package.

Returns

Type	Description
System.Boolean	True if the package represents a FHIR Core package, false if it is not.

| Improve this Doc View Source

RForSequence(FhirPackageCommon.FhirSequenceEnum)

For sequence.

Declaration

public static string RForSequence(FhirPackageCommon.FhirSequenceEnum sequence)

Parameters

Type	Name	Description
FhirPackageCommon.FhirSequenceEnum	sequence	[out] The sequence.

Returns

Type	Description
System.String	A string.

| Improve this Doc View Source

ShouldIgnoreResource(FhirPackageCommon.FhirSequenceEnum, String)

Determine if we should ignore resource.

Declaration

public static bool ShouldIgnoreResource(FhirPackageCommon.FhirSequenceEnum release, string resourceName)

Parameters

Type	Name	Description
FhirPackageCommon.FhirSequenceEnum	release	The release.
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(FhirPackageCommon.FhirSequenceEnum, String)

Determine if we should process resource.

Declaration

public static bool ShouldProcessResource(FhirPackageCommon.FhirSequenceEnum release, string resourceName)

Parameters

Type	Name	Description
FhirPackageCommon.FhirSequenceEnum	release	The release.
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 static 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(FhirPackageCommon.FhirSequenceEnum, String)

Determine if we should skip file.

Declaration

public static bool ShouldSkipFile(FhirPackageCommon.FhirSequenceEnum release, string filename)

Parameters

Type	Name	Description
FhirPackageCommon.FhirSequenceEnum	release	The release.
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

TryGetMajorReleaseForVersion(String, out FhirPackageCommon.FhirSequenceEnum)

Attempts to get major release for version a FhirSequenceEnum from the given string.

Declaration

public static bool TryGetMajorReleaseForVersion(string version, out FhirPackageCommon.FhirSequenceEnum sequence)

Parameters

Type	Name	Description
System.String	version	The version string.
FhirPackageCommon.FhirSequenceEnum	sequence	[out] The sequence.

Returns

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

| Improve this Doc View Source

TryGetRelativeBaseForVersion(String, out String)

Attempts to get relative URL for version a string from the given string.

Declaration

public static bool TryGetRelativeBaseForVersion(string version, out string relative)

Parameters

Type	Name	Description
System.String	version	The version string.
System.String	relative	[out] The relative.

Returns

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

| Improve this Doc View Source

TryGetReleaseByPackage(String, out FhirPackageCommon.FhirSequenceEnum)

Attempts to get release by package a FhirSequence from the given string.

Declaration

public static bool TryGetReleaseByPackage(string packageName, out FhirPackageCommon.FhirSequenceEnum sequence)

Parameters

Type	Name	Description
System.String	packageName	Name of the package.
FhirPackageCommon.FhirSequenceEnum	sequence	[out] The sequence.

Returns

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