Class FhirTypeBase

A base class for FHIR types to inherit from (common properties).

Inheritance

System.Object

FhirTypeBase

FhirModelBase

FhirPropertyBase

Namespace: Microsoft.Health.Fhir.CodeGenCommon.Models

Assembly: Microsoft.Health.Fhir.CodeGenCommon.dll

Syntax

public abstract class FhirTypeBase : object

Constructors

FhirTypeBase(String, String, String, String, String, Uri, String, String, String, String)

Initializes a new instance of the FhirTypeBase class.

Declaration

public FhirTypeBase(string id, string name, string path, string baseTypeName, string baseTypeCanonical, Uri url, string shortDescription, string purpose, string comment, string validationRegEx)

Parameters

Type	Name	Description
System.String	id	The id of this element/resource/datatype/extension.
System.String	name	The name.
System.String	path	The dot-notation path to this element/resource/datatype/extension.
System.String	baseTypeName	The name of the base type.
System.String	baseTypeCanonical	The canonical url of the base type.
Uri	url	The URL.
System.String	shortDescription	The description.
System.String	purpose	The purpose of this definition.
System.String	comment	The comment.
System.String	validationRegEx	The validation RegEx.

Properties

BaseTypeCanonical

Gets or sets the Canonical of the type this type inherits from (null if none).

Declaration

public string BaseTypeCanonical { get; set; }

Property Value

Type	Description
System.String	The name of the base type.

BaseTypeName

Gets or sets the Name of the type this type inherits from (null if none).

Declaration

public string BaseTypeName { get; set; }

Property Value

Type	Description
System.String

Comment

Gets explanatory notes and implementation guidance about the data element, including notes about how to use the data properly, exceptions to proper use, etc. (Note: The text you are reading is specified in ElementDefinition.comment).

Declaration

public string Comment { get; }

Property Value

Type	Description
System.String	The comment.

Id

Gets the Id for this element/resource/datatype.

Declaration

public string Id { get; }

Property Value

Type	Description
System.String	The Id for this element/resource/datatype.

Name

Gets a natural language name identifying the structure definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

Declaration

public string Name { get; }

Property Value

Type	Description
System.String	The name.

NameCapitalized

Gets name field with the first letter capitalized, useful in various languages and PascalCase joining.

Declaration

public string NameCapitalized { get; }

Property Value

Type	Description
System.String	The name capitalized.

Path

Gets the dot-notation path to this element/resource/datatype.

Declaration

public string Path { get; }

Property Value

Type	Description
System.String	The dot-notation path to this element/resource/datatype.

Purpose

Gets a complete explanation of the meaning of the data element for human readability. For the case of elements derived from existing elements (e.g. constraints), the definition SHALL be consistent with the base definition, but convey the meaning of the element in the particular context of use of the resource. (Note: The text you are reading is specified in ElementDefinition.definition).

Declaration

public string Purpose { get; }

Property Value

Type	Description
System.String	The definition.

ShortDescription

Gets a concise description of what this element means (e.g. for use in autogenerated summaries).

Declaration

public string ShortDescription { get; }

Property Value

Type	Description
System.String	The description.

URL

Gets URL of the document.

Declaration

public Uri URL { get; }

Property Value

Type	Description
Uri	The URL.

ValidationRegEx

Gets a RegEx string used to validate values in this property.

Declaration

public string ValidationRegEx { get; }

Property Value

Type	Description
System.String	The validation RegEx.

Methods

NameForExport(FhirTypeBase.NamingConvention, Boolean, String, HashSet<String>)

Converts this object to a requested naming convention.

Declaration

public string NameForExport(FhirTypeBase.NamingConvention convention, bool concatenatePath = false, string concatenationDelimiter = "", HashSet<string> reservedWords = null)

Parameters

Type	Name	Description
FhirTypeBase.NamingConvention	convention	The convention.
System.Boolean	concatenatePath	(Optional) True to concatenate path.
System.String	concatenationDelimiter	(Optional) The concatenation delimiter.
HashSet<System.String>	reservedWords	(Optional) The reserved words.

Returns

Type	Description
System.String	A string.

TypeForExport(FhirTypeBase.NamingConvention, Dictionary<String, String>, Boolean, String, HashSet<String>)

Type for export.

Declaration

public string TypeForExport(FhirTypeBase.NamingConvention convention, Dictionary<string, string> primitiveTypeMap, bool concatenatePath = false, string concatenationDelimiter = "", HashSet<string> reservedWords = null)

Parameters

Type	Name	Description
FhirTypeBase.NamingConvention	convention	The convention.
Dictionary<System.String, System.String>	primitiveTypeMap	The base type map.
System.Boolean	concatenatePath	(Optional) True to concatenate path.
System.String	concatenationDelimiter	(Optional) The concatenation delimiter.
HashSet<System.String>	reservedWords	(Optional) The reserved words.

Returns

Type	Description
System.String	A string.