Class FhirComplex

A class representing a FHIR complex type.

Inheritance

System.Object

FhirTypeBase

FhirModelBase

FhirComplex

Implements

ICloneable

Inherited Members

FhirModelBase.PublicationStatus

FhirModelBase.StandardStatus

FhirModelBase.FhirMaturityLevel

FhirModelBase.IsExperimental

FhirModelBase.ArtifactClass

FhirModelBase.FhirVersion

FhirModelBase.NarrativeText

FhirModelBase.NarrativeStatus

FhirModelBase.Url

FhirModelBase.Version

FhirModelBase.VersionAlgorithm

FhirModelBase.Title

FhirModelBase.Description

FhirTypeBase.Id

FhirTypeBase.Name

FhirTypeBase.NameCapitalized

FhirTypeBase.Path

FhirTypeBase.URL

FhirTypeBase.BaseTypeName

FhirTypeBase.BaseTypeCanonical

FhirTypeBase.ShortDescription

FhirTypeBase.Purpose

FhirTypeBase.Comment

FhirTypeBase.ValidationRegEx

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

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

Namespace: Microsoft.Health.Fhir.CodeGenCommon.Models

Assembly: Microsoft.Health.Fhir.CodeGenCommon.dll

Syntax

public class FhirComplex : FhirModelBase

Constructors

FhirComplex(FhirArtifactClassEnum, String, String, String, String, String, String, String, Uri, String, String, Nullable<Int32>, Boolean, String, String, String, List<String>, Boolean, String, String, String, String, Dictionary<String, FhirStructureDefMapping>, Dictionary<String, List<FhirElementDefMapping>>)

Initializes a new instance of the FhirComplex class.

Declaration

public FhirComplex(FhirArtifactClassEnum artifactType, string id, string name, string path, string explicitName, string baseTypeName, string baseTypeCanonical, string version, Uri url, string publicationStatus, string standardStatus, int? fmmLevel, bool isExperimental, string shortDescription, string purpose, string comment, List<string> contextElements, bool isAbstract, string validationRegEx, string narrative, string narrativeStatus, string fhirVersion, Dictionary<string, FhirStructureDefMapping> mappings, Dictionary<string, List<FhirElementDefMapping>> rootElementMappings)

Parameters

Type	Name	Description
FhirArtifactClassEnum	artifactType	Type of artifact this complex object represents.
System.String	id	The id of this resource/data type/extension.
System.String	name	The 'name' of this model.
System.String	path
System.String	explicitName	Explicit name for this complex structure, if provided.
System.String	baseTypeName	Base type name for this complex structure, if provided.
System.String	baseTypeCanonical	Base type canonical of this complex structure, if provided
System.String	version	Version of this definition.
Uri	url	URL of the resource.
System.String	publicationStatus	The publication status.
System.String	standardStatus	The standard status.
System.Nullable<System.Int32>	fmmLevel	The FHIR Maturity Model level.
System.Boolean	isExperimental	If this complex type is marked experimental.
System.String	shortDescription	Information describing the short.
System.String	purpose	The definition.
System.String	comment	The comment.
List<System.String>	contextElements	The context elements.
System.Boolean	isAbstract	If the complex structure is an abstract type.
System.String	validationRegEx	Validation regex pattern for this definition.
System.String	narrative	Narrative content for this object.
System.String	narrativeStatus	Status of any included narrative content.
System.String	fhirVersion	FHIR Version specified by this object.
Dictionary<System.String, FhirStructureDefMapping>	mappings	Mapping definitions for links to external specifications.
Dictionary<System.String, List<FhirElementDefMapping>>	rootElementMappings

FhirComplex(FhirArtifactClassEnum, String, String, String, String, String, String, String, Uri, String, String, Nullable<Int32>, Boolean, String, String, String, String, String, String, String, Dictionary<String, FhirStructureDefMapping>, Dictionary<String, List<FhirElementDefMapping>>)

Initializes a new instance of the FhirComplex class.

Declaration

public FhirComplex(FhirArtifactClassEnum artifactType, string id, string name, string path, string explicitName, string baseTypeName, string baseTypeCanonical, string version, Uri url, string publicationStatus, string standardStatus, int? fmmLevel, bool isExperimental, string shortDescription, string purpose, string comment, string validationRegEx, string narrative, string narrativeStatus, string fhirVersion, Dictionary<string, FhirStructureDefMapping> mappings, Dictionary<string, List<FhirElementDefMapping>> rootElementMappings)

Parameters

Type	Name	Description
FhirArtifactClassEnum	artifactType	FHIR artifact type of this Complex object.
System.String	id	The id of this resource/datatype/extension.
System.String	name	Name of this definition.
System.String	path	The dot-notation path to this resource/datatype/extension.
System.String	explicitName	Explicit name for this complex structure, if provided.
System.String	baseTypeName	Base type of this complex structure, if provided.
System.String	baseTypeCanonical	Base type canonical of this complex structure, if provided
System.String	version	Version of this definition.
Uri	url	URL of the resource.
System.String	publicationStatus	The publication status.
System.String	standardStatus	The standard status.
System.Nullable<System.Int32>	fmmLevel	The FHIR Maturity Model level.
System.Boolean	isExperimental	If this complex resource is flagged as experimental.
System.String	shortDescription	Information describing the short.
System.String	purpose	The purpose.
System.String	comment	The comment.
System.String	validationRegEx	Validation Regular Expression for this structure.
System.String	narrative	Narrative content for this object.
System.String	narrativeStatus	Status of any included narrative content.
System.String	fhirVersion	FHIR Version specified by this object.
Dictionary<System.String, FhirStructureDefMapping>	mappings	Mapping definitions for links to external specifications.
Dictionary<System.String, List<FhirElementDefMapping>>	rootElementMappings	Mapping values from the root element.

FhirComplex(FhirArtifactClassEnum, String, String, String, String, String, String, Uri, String, String, Nullable<Int32>, Boolean, String, String, String, String, String, String, String, Dictionary<String, FhirStructureDefMapping>, Dictionary<String, List<FhirElementDefMapping>>)

Initializes a new instance of the FhirComplex class for a slice.

Declaration

public FhirComplex(FhirArtifactClassEnum artifactType, string id, string elementName, string sliceName, string path, string explicitName, string version, Uri url, string publicationStatus, string standardStatus, int? fmmLevel, bool isExperimental, string shortDescription, string purpose, string comment, string validationRegEx, string narrative, string narrativeStatus, string fhirVersion, Dictionary<string, FhirStructureDefMapping> mappings, Dictionary<string, List<FhirElementDefMapping>> rootElementMappings)

Parameters

Type	Name	Description
FhirArtifactClassEnum	artifactType	Type of artifact this complex object represents.
System.String	id	The id of this resource/data type/extension.
System.String	elementName	The element name this model is defined by (e.g., the path to a backbone element).
System.String	sliceName	Name of this slice.
System.String	path	Path to this definition.
System.String	explicitName	Explicit name for this complex structure, if provided.
System.String	version	Version of this definition.
Uri	url	URL of the resource.
System.String	publicationStatus	The publication status.
System.String	standardStatus	The standard status.
System.Nullable<System.Int32>	fmmLevel	The FHIR Maturity Model level.
System.Boolean	isExperimental	If this complex type is marked experimental.
System.String	shortDescription	Information describing the short.
System.String	purpose	The definition.
System.String	comment	The comment.
System.String	validationRegEx	Validation regex pattern for this definition.
System.String	narrative	Narrative content for this object.
System.String	narrativeStatus	Status of any included narrative content.
System.String	fhirVersion	FHIR Version specified by this object.
Dictionary<System.String, FhirStructureDefMapping>	mappings	Mapping definitions for links to external specifications.
Dictionary<System.String, List<FhirElementDefMapping>>	rootElementMappings

FhirComplex(FhirComplex)

Initializes a new instance of the Microsoft.Health.Fhir.CodeGenCommon.Models.FhirComplex class.

Declaration

public FhirComplex(FhirComplex source)

Parameters

Type	Name	Description
FhirComplex	source	Source for the.

Properties

Components

Gets the components.

Declaration

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

Property Value

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

Constraints

Gets the constraints.

Declaration

public IEnumerable<FhirConstraint> Constraints { get; }

Property Value

Type	Description
IEnumerable<FhirConstraint>

ConstraintsByKey

Gets the constraints by key.

Declaration

public Dictionary<string, FhirConstraint> ConstraintsByKey { get; }

Property Value

Type	Description
Dictionary<System.String, FhirConstraint>

ContextElements

Gets the context elements.

Declaration

public List<string> ContextElements { get; }

Property Value

Type	Description
List<System.String>	The context elements.

Elements

Gets the elements.

Declaration

public Dictionary<string, FhirElement> Elements { get; }

Property Value

Type	Description
Dictionary<System.String, FhirElement>	The elements.

ExplicitName

Gets the explicit name of this structure, if provided.

Declaration

public string ExplicitName { get; }

Property Value

Type	Description
System.String

InstanceOperations

Gets the instance operations.

Declaration

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

Property Value

Type	Description
Dictionary<System.String, FhirOperation>	The instance operations.

IsAbstract

Gets a value indicating whether this object is abstract.

Declaration

public bool IsAbstract { get; }

Property Value

Type	Description
System.Boolean

IsPlaceholder

Gets or sets a value indicating whether this object is placeholder.

Declaration

public bool IsPlaceholder { get; set; }

Property Value

Type	Description
System.Boolean	True if this object is placeholder, false if not.

Mappings

Gets the mappings - external specifications that the content is mapped to.

Declaration

public Dictionary<string, FhirStructureDefMapping> Mappings { get; }

Property Value

Type	Description
Dictionary<System.String, FhirStructureDefMapping>

Parent

Gets or sets the parent.

Declaration

public FhirComplex Parent { get; set; }

Property Value

Type	Description
FhirComplex

ParentArtifactClass

Gets or sets the parent artifact class.

Declaration

public FhirArtifactClassEnum ParentArtifactClass { get; set; }

Property Value

Type	Description
FhirArtifactClassEnum

ResolvedParentDirective

Gets or sets the resolved parent directive.

Declaration

public string ResolvedParentDirective { get; set; }

Property Value

Type	Description
System.String

RootElement

Gets the root element.

Declaration

public FhirElement RootElement { get; }

Property Value

Type	Description
FhirElement

RootElementMappings

Gets the root element mappings.

Declaration

public Dictionary<string, List<FhirElementDefMapping>> RootElementMappings { get; }

Property Value

Type	Description
Dictionary<System.String, List<FhirElementDefMapping>>

SearchParameters

Gets the search parameters.

Declaration

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

Property Value

Type	Description
Dictionary<System.String, FhirSearchParam>	Search Parameters defined on this resource.

SliceName

Gets or sets the name of the slice.

Declaration

public string SliceName { get; set; }

Property Value

Type	Description
System.String	The name of the slice.

TypeOperations

Gets the type operations.

Declaration

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

Property Value

Type	Description
Dictionary<System.String, FhirOperation>	The type operations.

Methods

AddComponentFromElement(String)

Adds a component from an element.

Declaration

public bool AddComponentFromElement(string path)

Parameters

Type	Name	Description
System.String	path	Name of the element.

Returns

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

AddConstraint(FhirConstraint, Boolean)

Adds a constraint.

Declaration

public void AddConstraint(FhirConstraint constraint, bool copyIfNew = false)

Parameters

Type	Name	Description
FhirConstraint	constraint	The constraint.
System.Boolean	copyIfNew	(Optional) True to copy if new.

AddContextElement(String)

Adds a context element.

Declaration

public void AddContextElement(string element)

Parameters

Type	Name	Description
System.String	element	The element.

AddOperation(FhirOperation)

Adds an operation.

Declaration

public void AddOperation(FhirOperation operation)

Parameters

Type	Name	Description
FhirOperation	operation	The operation.

AddRootElement(FhirElement)

Adds a root element.

Declaration

public void AddRootElement(FhirElement element)

Parameters

Type	Name	Description
FhirElement	element	The element.

AddSearchParameter(FhirSearchParam)

Adds a search parameter.

Declaration

public void AddSearchParameter(FhirSearchParam searchParam)

Parameters

Type	Name	Description
FhirSearchParam	searchParam	The search parameter.

Clone()

Creates a new object that is a copy of the current instance.

Declaration

public object Clone()

Returns

Type	Description
System.Object	A new object that is a copy of this instance.

DeepCopy(Dictionary<String, String>, Boolean, Boolean, Dictionary<String, ValueSetReferenceInfo>, Dictionary<String, FhirNodeInfo>, Dictionary<String, FhirCapSearchParam>, Dictionary<String, FhirCapSearchParam>, Dictionary<String, FhirCapOperation>, Dictionary<String, FhirCapOperation>, Boolean)

Deep copy - cannot use Clone because of needed parameters.

Declaration

public FhirComplex DeepCopy(Dictionary<string, string> primitiveTypeMap, bool copySlicing, bool canHideParentFields, Dictionary<string, ValueSetReferenceInfo> valueSetReferences, Dictionary<string, FhirNodeInfo> typeMapByPath, Dictionary<string, FhirCapSearchParam> supportedSearchParams = null, Dictionary<string, FhirCapSearchParam> serverSearchParams = null, Dictionary<string, FhirCapOperation> supportedOperations = null, Dictionary<string, FhirCapOperation> serverOperations = null, bool includeExperimental = false)

Parameters

Type	Name	Description
Dictionary<System.String, System.String>	primitiveTypeMap	The primitive type map.
System.Boolean	copySlicing	True to copy slicing.
System.Boolean	canHideParentFields	True if can hide parent fields, false if not.
Dictionary<System.String, ValueSetReferenceInfo>	valueSetReferences	Value Set URLs and lists of FHIR paths that reference them.
Dictionary<System.String, FhirNodeInfo>	typeMapByPath	Type mappings by path.
Dictionary<System.String, FhirCapSearchParam>	supportedSearchParams	(Optional) Options for controlling the supported search.
Dictionary<System.String, FhirCapSearchParam>	serverSearchParams	(Optional) Options for controlling the server search.
Dictionary<System.String, FhirCapOperation>	supportedOperations	(Optional) The supported operations.
Dictionary<System.String, FhirCapOperation>	serverOperations	(Optional) The server operations.
System.Boolean	includeExperimental	(Optional) True to include, false to exclude the experimental.

Returns

Type	Description
FhirComplex	A FhirComplex.

GetParentAndFieldName(String, String[], String[], out FhirComplex, out String, out String)

Gets the parent and field name.

Declaration

public bool GetParentAndFieldName(string url, string[] idComponents, string[] pathComponents, out FhirComplex parent, out string field, out string sliceName)

Parameters

Type	Name	Description
System.String	url	URL of the resource.
System.String[]	idComponents	The id components.
System.String[]	pathComponents	The path components.
FhirComplex	parent	[out] The parent.
System.String	field	[out] The field.
System.String	sliceName	[out] Name of the slice.

Returns

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

TryGetExplicitName(String, out String, Int32)

Attempts to get an explicit name for a component path.

Declaration

public bool TryGetExplicitName(string path, out string explicitName, int startIndex = 0)

Parameters

Type	Name	Description
System.String	path	Name of the element.
System.String	explicitName	[out] Explicit name for this complex structure, if provided.
System.Int32	startIndex	(Optional) The start index.

Returns

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

Implements

ICloneable