SubstanceAdministration Class

Represents an act whereby a substance is administered to the patient

Inheritance Hierarchy

SystemObject
  SanteDB.Core.ModelIdentifiedData
    SanteDB.Core.ModelBaseEntityData
      SanteDB.Core.ModelVersionedEntityDataAct
        SanteDB.Core.Model.ActsAct
          SanteDB.Core.Model.ActsSubstanceAdministration

Namespace: SanteDB.Core.Model.Acts
Assembly: SanteDB.Core.Model (in SanteDB.Core.Model.dll) Version: 2.2.1

Syntax

C++

Copy

public class SubstanceAdministration : Act

Public Class SubstanceAdministration
	Inherits Act

public ref class SubstanceAdministration : public Act

type SubstanceAdministration =  
    class
        inherit Act
    end

The SubstanceAdministration type exposes the following members.

Constructors

	Name	Description
	SubstanceAdministration	Substance administration ctor

Top

Properties

	Name	Description
	ActTime	The instant when the act occurred, or will occur (Inherited from Act.)
	ActTimeXml	The moment in time that this act occurred in ISO format (Inherited from Act.)
	BatchOperation	Gets or sets the operation (Inherited from IdentifiedData.)
	ClassConcept	Gets the delay-loaded value of the ClassConceptKey (Inherited from Act.)
	ClassConceptKey	The classification key of the activity (Inherited from Act.)
	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.)
	DoseQuantity	Gets or sets the amount of substance administered
	DoseUnit	Gets or sets a concept which indicates the unit of measure for the dose (eg: 5 mL, 10 mL, 1 drop, etc.)
	DoseUnitKey	Gets or sets the key for dosing unit
	Extensions	Gets a list of all extensions associated with the act (Inherited from Act.)
	GeoTag	Gets or sets the geo-tag (Inherited from Act.)
	Identifiers	Identifiers by which this act is known (Inherited from Act.)
	IsDelayLoadEnabled	True if the class is currently loading associations when accessed (Inherited from IdentifiedData.)
	IsNegated	Identifies whether the act represented in this instance actually occurred (Inherited from Act.)
	Key	Gets or sets the primary identifying UUID of this object (Inherited from IdentifiedData.)
	LoadState	Gets or sets whether the object was partial loaded (Inherited from IdentifiedData.)
	ModifiedOn	Gets the time that the object was last modified (from base data, default to CreationTime) (Inherited from BaseEntityData.)
	MoodConcept	Gets the delay-loaded value of the MoodConceptKey property (Inherited from Act.)
	MoodConceptKey	The mood (or mode) of the Act instance (Inherited from Act.)
	Notes	Gets a list of all notes associated with the act (Inherited from Act.)
	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.)
	Participations	Gets or sets the entities and participations they play in the act (Inherited from Act.)
	Policies	Gets or sets the security policy instances associated with the act (Inherited from Act.)
	PreviousVersionKey	Gets or sets the UUID of the previous version of this record (Inherited from VersionedEntityDataTHistoryModelType.)
	Protocols	Identifies protocols attached to the act (Inherited from Act.)
	ReasonConcept	Delay loads the concept from ReasonConceptKey (Inherited from Act.)
	ReasonConceptKey	Identifies a codified reason as to why this act did (or did not, or should or should not) occur. (Inherited from Act.)
	Relationships	Gets a list of all associated acts for this act (Inherited from Act.)
	Route	Gets or sets a concept which indicates the route of administration (eg: Oral, Injection, etc.)
	RouteKey	Gets or sets the key for route
	SequenceId	The sequence of the dose (i.e. OPV 0 = 0 , OPV 1 = 1, etc.)
	Site	Gets or sets a concept which indicates the site of administration
	SiteKey	Gets or sets the site
	StartTime	The date/time when the act started to occur (Inherited from Act.)
	StartTimeXml	The time when the act should or did start ocurring in ISO format (Inherited from Act.)
	StatusConcept	Delay loads the concept represented in StatusConceptKey (Inherited from Act.)
	StatusConceptKey	The concept which describes the current status of the act (Inherited from Act.)
	StopTime	The time and date when the act did or should stop occurring (Inherited from Act.)
	StopTimeXml	The time when the act should or did stop ocurring in ISO format (Inherited from Act.)
	Tag	Override the ETag (Inherited from VersionedEntityDataTHistoryModelType.)
	Tags	Gets a list of all tags associated with the act (Inherited from Act.)
	Template	Delay load property for the template (Inherited from Act.)
	TemplateKey	The template on which the act is based (Inherited from Act.)
	Type	Gets the type registration of this object (Inherited from IdentifiedData.)
	TypeConcept	Delay loads the concept represented in TypeConceptKey (Inherited from Act.)
	TypeConceptKey	Gets or sets the key of the concept which further classifies the type of act occurring (Inherited from Act.)
	VersionKey	Gets or sets the UUID of the current version of this object (Inherited from VersionedEntityDataTHistoryModelType.)
	VersionSequence	The sequence number of the version (for ordering) (Inherited from VersionedEntityDataTHistoryModelType.)

Top

Methods

	Name	Description
	AddAnnotation	Add an annotated object (Inherited from IdentifiedData.)
	AddExtension	Add the specified extension type to the collection (Inherited from Act.)
	AddPolicy	Add a policy to this act (Inherited from Act.)
	AddTag	Add a tag to this act (Inherited from Act.)
	Clone	Clone this object (Inherited from IdentifiedData.)
	Copy	Copies the entity (Inherited from Act.)
	CopyAnnotations	Copy annotations from another resource (Inherited from IdentifiedData.)
	DeepCopy	Provide a deep copy of the specified data (Inherited from IdentifiedData.)
	DelayLoadTEntity	Get associated entity (Inherited from IdentifiedData.)
	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.)
	GetLocked	Clone the specified data (Inherited from IdentifiedData.)
	GetPreviousVersion	Gets the previous version or loads it from the database if needed (Inherited from VersionedEntityDataTHistoryModelType.)
	GetTag	Get the specified tag (Inherited from Act.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	HasPolicy	Determines if the object has policy (Inherited from Act.)
	IsEmpty	Determines w (Inherited from IdentifiedData.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	RemoveAllTags	Remove tags matching predicate from the tag collection (Inherited from Act.)
	RemoveAnnotation	Remove annotation (Inherited from IdentifiedData.)
	RemoveExtension	Remove the specified extension (Inherited from Act.)
	RemoveTag	Remove tagKey from the tag collection (Inherited from Act.)
	SemanticEquals	Semantic equality function (Overrides ActSemanticEquals(Object).)
	SetPreviousVersion	Sets the previous version (Inherited from VersionedEntityDataTHistoryModelType.)
	ShouldSerializeBatchOperation	Should serialize batch operation (Inherited from IdentifiedData.)
	ShouldSerializeCreatedByKey	True if key should be serialized (Inherited from BaseEntityData.)
	ShouldSerializeExtensions	Should serialize extensions? (Inherited from Act.)
	ShouldSerializeIdentifiers	Should serialize identifiers (Inherited from Act.)
	ShouldSerializeKey	True if key should be serialized (Inherited from IdentifiedData.)
	ShouldSerializeModifiedOn	Never serialize modified on (Inherited from IdentifiedData.)
	ShouldSerializeNotes	Should serialize notes (Inherited from Act.)
	ShouldSerializeObsoletedByKey	True if key should be serialized (Inherited from BaseEntityData.)
	ShouldSerializeParticipations	Should serialize participations (Inherited from Act.)
	ShouldSerializePolicies	Should serialize policies (Inherited from Act.)
	ShouldSerializePreviousVersionKey	Should serialize previous version? (Inherited from VersionedEntityDataTHistoryModelType.)
	ShouldSerializeProtocols	Should serialize protocols (Inherited from Act.)
	ShouldSerializeReasonConceptKey	True if reason concept key should be serialized (Inherited from Act.)
	ShouldSerializeRelationships	Should serialize relationships? (Inherited from Act.)
	ShouldSerializeSiteKey	Should serialize site key
	ShouldSerializeTags	Should serialize tags (Inherited from Act.)
	ShouldSerializeTemplateKey	Should serialize template key (Inherited from Act.)
	ToDisplay	To display value (Inherited from IdentifiedData.)
	ToString	Represent the versioned data as a string (Inherited from VersionedEntityDataTHistoryModelType.)
	TryGetTag	Try to fetch the tag (Inherited from Act.)

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.)
	GetIdentifiers	Gets or loads identifiers (Defined by DelayLoadUtils.)
	GetInstanceOfTDomain	Gets an instance of TDomain from me (Defined by ModelExtensions.)
	GetParticipations	Gets or loads participations (Defined by DelayLoadUtils.)
	GetRelationships	Gets or loads relationships (Defined by DelayLoadUtils.)

Top

Remarks

The substance administration act is used whenever a clinician administers, plans to administer or should administer to a patient, a substance. The substance that is administered is open but should be represented as either a Consumable (something that was consumed in the act of administration like a manufactured material (ManufacturedMaterial) or a product (if proposing or planning)).

The type of administration (immunization, drug therapy, treatment, etc.) is classified by the substance administration's type concept (TypeConceptKey). In some cases the dose quantity or dose measure are not required (when giving just "a dose") however it is recommended that implementations accurately track how much of the substance was administered.

Reference

SanteDB.Core.Model.Acts Namespace