Show / Hide Table of Contents

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

| Improve this Doc View Source

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

| Improve this Doc View Source

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.

| Improve this Doc View Source

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
| Improve this Doc View Source

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.

| Improve this Doc View Source

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.

| Improve this Doc View Source

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.

| Improve this Doc View Source

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.

| Improve this Doc View Source

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.

| Improve this Doc View Source

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.

| Improve this Doc View Source

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.

| Improve this Doc View Source

URL

Gets URL of the document.

Declaration
public Uri URL { get; }
Property Value
Type Description
Uri

The URL.

| Improve this Doc View Source

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

| Improve this Doc View Source

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.

| Improve this Doc View Source

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.

  • Improve this Doc
  • View Source
In This Article
  • Constructors
    • FhirTypeBase(String, String, String, String, String, Uri, String, String, String, String)
  • Properties
    • BaseTypeCanonical
    • BaseTypeName
    • Comment
    • Id
    • Name
    • NameCapitalized
    • Path
    • Purpose
    • ShortDescription
    • URL
    • ValidationRegEx
  • Methods
    • NameForExport(FhirTypeBase.NamingConvention, Boolean, String, HashSet<String>)
    • TypeForExport(FhirTypeBase.NamingConvention, Dictionary<String, String>, Boolean, String, HashSet<String>)
Back to top Generated by DocFX