Protocol Class

Represents the model of a clinical protocol for CDR

Inheritance Hierarchy

SystemObject
  SanteDB.Core.ModelIdentifiedData
    SanteDB.Core.ModelBaseEntityData
      SanteDB.Core.Model.ActsProtocol

Namespace: SanteDB.Core.Model.Acts
Assembly: SanteDB.Core.Model (in SanteDB.Core.Model.dll) Version: 3.0.2081-alpha+0a330d5f5a5d3cb3e6e945ef530e94ac5671b49c

Syntax

C++

Copy

public class Protocol : BaseEntityData

Public Class Protocol
	Inherits BaseEntityData

public ref class Protocol : public BaseEntityData

type Protocol = 
    class
        inherit BaseEntityData
    end

The Protocol type exposes the following members.

Constructors

	Name	Description
	Protocol	Initializes a new instance of the Protocol class

Top

Properties

	Name	Description
	_Self	A query parameter which references itself - this is for query filters which pass the original data in (Inherited from IdentifiedData)
	BatchOperation	Gets or sets the operation (Inherited from IdentifiedData)
	CreatedBy	Gets or sets the user that created this base data (Inherited from BaseEntityData)
	CreatedByKey	Gets or sets the security provenance object which represents the creation of this object (Inherited from BaseEntityData)
	CreationTime	Gets or sets the time at which the data was created (Inherited from BaseEntityData)
	CreationTimeXml	Gets or sets the creation time as an ISO date format (Inherited from BaseEntityData)
	Key	Gets or sets the primary identifying UUID of this object (Inherited from IdentifiedData)
	ModifiedOn	Gets the time that the object was last modified (from base data, default to CreationTime) (Inherited from BaseEntityData)
	Name	Gets or sets the name of the protocol
	ObsoletedBy	Gets or sets the user that obsoleted this base data (Inherited from BaseEntityData)
	ObsoletedByKey	Gets or sets the security provenance object which represents the obsoletion of this data (Inherited from BaseEntityData)
	ObsoletionTime	Gets or sets the time when the data is or will become invalid (Inherited from BaseEntityData)
	ObsoletionTimeXml	Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format (Inherited from BaseEntityData)
	Oid	Gets or sets the OID
	Tag	Gets a tag which changes whenever the object is updated (Inherited from IdentifiedData)
	Type	Gets the type registration of this object (Inherited from IdentifiedData)

Top

Methods

	Name	Description
	AddAnnotationT	Add an annotated object (Inherited from IdentifiedData)
	Clone	Clone this object (Inherited from IdentifiedData)
	CopyAnnotations	Copy annotations from another resource (Inherited from IdentifiedData)
	DeepCopy	Provide a deep copy of the specified data (Overrides IdentifiedDataDeepCopy)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	GetAnnotationsT	Get annotations of specified T (Inherited from IdentifiedData)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	IsEmpty	Determines w (Inherited from IdentifiedData)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	RemoveAnnotation	Remove annotation (Inherited from IdentifiedData)
	RemoveAnnotationsT	Remove annotation (Inherited from IdentifiedData)
	SemanticEquals	Semantic equality (Overrides IdentifiedDataSemanticEquals(Object))
	ShouldSerializeBatchOperation	Should serialize batch operation (Inherited from IdentifiedData)
	ShouldSerializeCreatedByKey	True if key should be serialized (Inherited from BaseEntityData)
	ShouldSerializeCreationTimeXml	True if the creation time should be serialized (Inherited from BaseEntityData)
	ShouldSerializeKey	True if key should be serialized (Inherited from IdentifiedData)
	ShouldSerializeModifiedOn	Never serialize modified on (Inherited from IdentifiedData)
	ShouldSerializeObsoletedByKey	True if key should be serialized (Inherited from BaseEntityData)
	ShouldSerializeObsoletionTimeXml	True if the creation time should be serialized (Inherited from BaseEntityData)
	ToDisplay	To display value (Inherited from IdentifiedData)
	ToString	Represent the data as a string (Inherited from BaseEntityData)
	ToXmlString	Represent the current data as a string (Inherited from IdentifiedData)

Top

Fields

	Name	Description
	m_annotations	A list of custom tags which were added to this object (Inherited from IdentifiedData)

Top

Extension Methods

	Name	Description
	ConvertTReturn	The purpose of this method is to convert object me to TReturn. Why? Because if you have an instance of Act that actually needs to be a SubstanceAdministration we can't just cast so we have to copy. (Defined by ExtensionMethods)
	DelayLoadDisabled	True if delay loading operations should be prevented (Defined by ExtensionMethods)
	DisablePersistenceValidation	Defer check constraints on the object in the persistence layer (Defined by DataContextExtensions)
	GetDependentObjects	Get dependent objects for model (Defined by ExtensionMethods)
	GetOrSetValueAtPath	Get the property value (Defined by ModelSetterMethods)
	LastModified	Gets the last modification date of the object (Defined by ExtensionMethods)
	NullifyProperties	Ensure that all properties in propertiesToNullify are null (Defined by ExtensionMethods)
	PreventDelayLoad	Prevent delay load (Defined by ExtensionMethods)
	ResolveGoldenRecord	Resolve the managed target wrapper for ResolveManagedRecord(T) (Defined by ExtensionMethods)
	ResolveManagedRecord	Resolve the managed target wrapper for ResolveManagedRecord(T) (Defined by ExtensionMethods)
	ResolveOwnedRecord	Non generic method of ResolveOwnedRecordT(T, IPrincipal) (Defined by ExtensionMethods)
	ShouldDisablePersistenceValidation	Determine if the object has been flagged for constraint deferral (Defined by DataContextExtensions)
	WithControl	With control parameter is used as a wrapper for _ parameters (Defined by QueryFilterExtensions)

Top

Remarks

The protocol type is used to store and retrieve information about a clinical protocol which was indicated on data submitted to the CDR. This particular type makes no supposition that SanteDB can "execute" the protocol, rather this class is used to store metadata about the clinical protocol in the SanteDB database

The use of the CDSS execution engine to generate CarePlan references rely on executable definitions for clinical protocols to be registered with SanteDB (for example: from an applet, from a database definition, etc.). These are stored separately and apart from this class.

Reference

SanteDB.Core.Model.Acts Namespace