Class: Protocol

Protocol(copyData)

new Protocol(copyData)

Represents the model of a clinical protocol for CDR

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.

Parameters:
Name Type Description
copyData Protocol Copy constructor (if present)
Properties:
Name Type Description
name string Gets or sets the name of the protocol
oid string Gets or sets the OID
creationTimeModel Date [Delay loaded from creationTime], Gets or sets the time at which the data was created
creationTime Date Gets or sets the creation time as an ISO date format
obsoletionTimeModel Date [Delay loaded from obsoletionTime], Gets or sets the time when the data is or will become invalid
obsoletionTime Date Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format
createdByModel SecurityProvenance [Delay loaded from createdBy], Gets or sets the user that created this base data
modifiedOn Date Gets the time that the object was last modified (from base data, default to CreationTime)
obsoletedByModel SecurityProvenance [Delay loaded from obsoletedBy], Gets or sets the user that obsoleted this base data
createdBy string Gets or sets the security provenance object which represents the creation of this object
obsoletedBy string Gets or sets the security provenance object which represents the obsoletion of this data
id string Gets or sets the primary identifying UUID of this object
operation BatchOperationType Gets or sets the operation(see: BatchOperationType for values)
$type string Gets the type registration of this object
Source:

Extends

Members

createdBy :string

Gets or sets the security provenance object which represents the creation of this object

Type:
  • string
Overrides:
Source:

createdByModel :SecurityProvenance

Type:
Overrides:
Source:

creationTime :Date

Gets or sets the creation time as an ISO date format

Type:
  • Date
Overrides:
Source:

creationTimeModel :Date

Type:
  • Date
Overrides:
Source:

id :string

Gets or sets the primary identifying UUID of this object

Type:
  • string
Overrides:
Source:

modifiedOn :Date

Gets the time that the object was last modified (from base data, default to CreationTime)

Type:
  • Date
Overrides:
Source:

name :string

Gets or sets the name of the protocol

Type:
  • string
Source:

obsoletedBy :string

Gets or sets the security provenance object which represents the obsoletion of this data

Type:
  • string
Overrides:
Source:

obsoletedByModel :SecurityProvenance

Type:
Overrides:
Source:

obsoletionTime :Date

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

Type:
  • Date
Overrides:
Source:

obsoletionTimeModel :Date

Type:
  • Date
Overrides:
Source:

oid :string

Gets or sets the OID

Type:
  • string
Source:

operation :BatchOperationType

Gets or sets the operation

Type:
Overrides:
Source: