Click or drag to resize

Protocol Class

Represents the model of a clinical protocol
Inheritance Hierarchy

Namespace:  SanteDB.Core.Model.Acts
Assembly:  SanteDB.Core.Model (in SanteDB.Core.Model.dll) Version: 2.2.1
Syntax
public class Protocol : BaseEntityData

The Protocol type exposes the following members.

Constructors
  NameDescription
Public methodProtocol
Initializes a new instance of the Protocol class
Top
Properties
  NameDescription
Public propertyBatchOperation
Gets or sets the operation
(Inherited from IdentifiedData.)
Public propertyCreatedBy
Gets or sets the user that created this base data
(Inherited from BaseEntityData.)
Public propertyCreatedByKey
Gets or sets the security provenance object which represents the creation of this object
(Inherited from BaseEntityData.)
Public propertyCreationTime
Gets or sets the time at which the data was created
(Inherited from BaseEntityData.)
Public propertyCreationTimeXml
Gets or sets the creation time as an ISO date format
(Inherited from BaseEntityData.)
Public propertyDefinition
Contains instructions which the handler class can understand
Public propertyHandlerClass
Gets or sets the handler for this protocol (which can load the definition
Public propertyHandlerClassName
Gets or sets the handler class AQN
Public propertyIsDelayLoadEnabled
True if the class is currently loading associations when accessed
(Inherited from IdentifiedData.)
Public propertyKey
Gets or sets the primary identifying UUID of this object
(Inherited from IdentifiedData.)
Public propertyLoadState
Gets or sets whether the object was partial loaded
(Inherited from IdentifiedData.)
Public propertyModifiedOn
Gets the time that the object was last modified (from base data, default to CreationTime)
(Inherited from BaseEntityData.)
Public propertyName
Gets or sets the name of the protocol
Public propertyNarrative
Gets or sets the narrative description of the protocol
Public propertyNarrativeKey
Gets the narrative information for the protocol
Public propertyObsoletedBy
Gets or sets the user that obsoleted this base data
(Inherited from BaseEntityData.)
Public propertyObsoletedByKey
Gets or sets the security provenance object which represents the obsoletion of this data
(Inherited from BaseEntityData.)
Public propertyObsoletionTime
Gets or sets the time when the data is or will become invalid
(Inherited from BaseEntityData.)
Public propertyObsoletionTimeXml
Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format
(Inherited from BaseEntityData.)
Public propertyOid
Gets or sets the OID
Public propertyTag
Gets a tag which changes whenever the object is updated
(Inherited from IdentifiedData.)
Public propertyType
Gets the type registration of this object
(Inherited from IdentifiedData.)
Top
Methods
  NameDescription
Public methodAddAnnotation
Add an annotated object
(Inherited from IdentifiedData.)
Public methodClone
Clone this object
(Inherited from IdentifiedData.)
Public methodCopyAnnotations
Copy annotations from another resource
(Inherited from IdentifiedData.)
Public methodDeepCopy
Provide a deep copy of the specified data
(Inherited from IdentifiedData.)
Protected methodDelayLoadTEntity
Get associated entity
(Inherited from IdentifiedData.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetAnnotationsT
Get annotations of specified T
(Inherited from IdentifiedData.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetLocked
Clone the specified data
(Inherited from IdentifiedData.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsEmpty
Determines w
(Inherited from IdentifiedData.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRemoveAnnotation
Remove annotation
(Inherited from IdentifiedData.)
Public methodSemanticEquals
Semantic equality
(Overrides IdentifiedDataSemanticEquals(Object).)
Public methodShouldSerializeBatchOperation
Should serialize batch operation
(Inherited from IdentifiedData.)
Public methodShouldSerializeCreatedByKey
True if key should be serialized
(Inherited from BaseEntityData.)
Public methodShouldSerializeKey
True if key should be serialized
(Inherited from IdentifiedData.)
Public methodShouldSerializeModifiedOn
Never serialize modified on
(Inherited from IdentifiedData.)
Public methodShouldSerializeObsoletedByKey
True if key should be serialized
(Inherited from BaseEntityData.)
Public methodToDisplay
To display value
(Inherited from IdentifiedData.)
Public methodToString
Represent the data as a string
(Inherited from BaseEntityData.)
Top
Fields
  NameDescription
Protected fieldm_annotations
A list of custom tags which were added to this object
(Inherited from IdentifiedData.)
Top
Extension Methods
  NameDescription
Public Extension MethodConvertTReturn
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.)
Public Extension MethodGetInstanceOfTDomain
Gets an instance of TDomain from me
(Defined by ModelExtensions.)
Top
Remarks

The protocol type is used to store and retrieve the particular definition of a clinical protocol. In SanteDB, a clinical protocol represents a series of steps that *should* be taken by a clinician when caring for a patient.

A series of proposed steps generated by these protocol definitions are used to represent a care plan (CarePlan).

See Also