Class: SubstanceAdministration

SubstanceAdministration(copyData)

new SubstanceAdministration(copyData)

Represents an act whereby a substance is administered to the patient

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.

Parameters:
Name Type Description
copyData SubstanceAdministration Copy constructor (if present)
Properties:
Name Type Description
route string Gets or sets the key for route
doseUnit string Gets or sets the key for dosing unit
routeModel Concept [Delay loaded from route], Gets or sets a concept which indicates the route of administration (eg: Oral, Injection, etc.)
doseUnitModel Concept [Delay loaded from doseUnit], Gets or sets a concept which indicates the unit of measure for the dose (eg: 5 mL, 10 mL, 1 drop, etc.)
doseQuantity number Gets or sets the amount of substance administered
doseSequence number The sequence of the dose (i.e. OPV 0 = 0 , OPV 1 = 1, etc.)
site string Gets or sets the site
siteModel Concept [Delay loaded from site], Gets or sets a concept which indicates the site of administration
isNegated boolean Identifies whether the act represented in this instance actually occurred
template string The template on which the act is based
templateModel TemplateDefinition [Delay loaded from template], Delay load property for the template
actTime Date The moment in time that this act occurred in ISO format
startTime Date The time when the act should or did start ocurring in ISO format
stopTime Date The time when the act should or did stop ocurring in ISO format
classConcept string The classification key of the activity(see: ActClassKeys for values)
moodConcept string The mood (or mode) of the Act instance(see: ActMoodKeys for values)
reasonConcept string Identifies a codified reason as to why this act did (or did not, or should or should not) occur.(see: ActReasonKeys for values)
statusConcept string The concept which describes the current status of the act(see: StatusKeys for values)
typeConcept string Gets or sets the key of the concept which further classifies the type of act occurring
classConceptModel Concept [Delay loaded from classConcept], Gets the delay-loaded value of the ClassConceptKey
moodConceptModel Concept [Delay loaded from moodConcept], Gets the delay-loaded value of the MoodConceptKey property
reasonConceptModel Concept [Delay loaded from reasonConcept], Delay loads the concept from ReasonConceptKey
statusConceptModel Concept [Delay loaded from statusConcept], Delay loads the concept represented in StatusConceptKey
typeConceptModel Concept [Delay loaded from typeConcept], Delay loads the concept represented in TypeConceptKey
identifier object Identifiers by which this act is known
Properties
Name Type Description
classifier ActIdentifier where classifier is from IdentifierBase domain
relationship object Gets a list of all associated acts for this act
Properties
Name Type Description
Appends ActRelationship Indicates that the source act appends information contained in the target act
Arrival ActRelationship Links the transortation act from another act
Departure ActRelationship Links a transporation act from another act indicating departure of the subject
Documents ActRelationship The source act documents the target act
EpisodeLink ActRelationship Links two instances of the same act over time (example: chronic conditions)
Evaluates ActRelationship Used to link a goal to an observation
Fulfills ActRelationship Indicates that the source act fulfills the target act
HasAuthorization ActRelationship Indicates that the target act authorizes the source act
HasComponent ActRelationship Indicates that the target act is a component of the source act
HasControlVariable ActRelationship Relationship from an act to one or more control variables (for example: device settings, or environment)
HasManifestation ActRelationship The assertion that a new observation may be a manifestation of another
HasPrecondition ActRelationship Indicates that the target act is a pre-condition of the source act
HasReason ActRelationship Indicates a reasoning as to why the source act is occurring
HasReferenceValues ActRelationship Indicates that the source act contains reference values from the target
HasSubject ActRelationship Indicates the subject of a particular act (example: clinical act is a subject of a control act)
HasSupport ActRelationship Indicates an existing act is suggesting evidence for a new observation.
IsCauseOf ActRelationship Indicates that the source act is the cause of the target act
IsDerivedFrom ActRelationship Indicates the source act is derived from information contained in the target act
IsExcerptOf ActRelationship Indicates that the source act is an excerpt of the target act
RefersTo ActRelationship Indicates that the source act refers to the target act
Replaces ActRelationship The source act replaces the target act
StartsAfterStartOf ActRelationship Indicates that the source act starts after the start of another act
Transforms ActRelationship Indicates that the source act transforms the target act
Duplicate ActRelationship Duplicate entity
$other ActRelationship Unclassified
policy SecurityPolicyInstance Gets or sets the security policy instances associated with the act
extension object Gets a list of all extensions associated with the act
Properties
Name Type Description
classifier Array.<byte> where classifier is from Extension extensionType
note ActNote Gets a list of all notes associated with the act
tag object Gets a list of all tags associated with the act
Properties
Name Type Description
classifier string where classifier is from Tag key
protocol ActProtocol Identifies protocols attached to the act
participation object Gets or sets the entities and participations they play in the act
Properties
Name Type Description
Admitter ActParticipation The player entity was the person who was responsible for admitting the patient into a facility or care scenario.
Attender ActParticipation The player entity represents the attending physician for the patient
Authenticator ActParticipation The player entity represents an entity which authenticates the provision of care
Authororiginator ActParticipation The player entity is responsible for the creation of data described in the act
Baby ActParticipation The player is a resultant person in that it was the baby
Beneficiary ActParticipation The player is a beneficiary of the act such a receiver of a financial instrument, or other good
CallbackContact ActParticipation The player entity represents something that should be contacted upon completion of the act
CausativeAgent ActParticipation The player entity is an agent which caused the act to occur
Consultant ActParticipation The player entity is acting as a consult to the carrying out of the act
Consumable ActParticipation The player entity was or is to be consumed during the process of carrying out the act.
CoverageTarget ActParticipation The player entity represents the target coverage entity of the act
Custodian ActParticipation The player entity is the data custodian of the act (is responsible for storing and securing the act)
DataEnterer ActParticipation The player entity represents the person or device which phisically entered the data at the terminal
Destination ActParticipation The player etity represents the ultimate destination of the goods/materials/services described in the act
Device ActParticipation The player entity represents the device on which the act or data from the act was acquired or recorded
DirectTarget ActParticipation The player entity represents the directed target of care provided in the act
Discharger ActParticipation The player entity represents the person who is responsible for the discharging of the patient from an encounter
Distributor ActParticipation The player entity is the source distribution point for the financial or material instruments contained in the message
Donor ActParticipation The player entity represents the donor of tissue or materials used in the act
EntryLocation ActParticipation The location where the act was entered.
Escort ActParticipation The player entity was responsible for escorting the patient during the course of the act
Exposure ActParticipation The player entity something to which the patient was exposed
ExposureAgent ActParticipation The player entity represents the agent (material) to which the patient was exposed
ExposureSource ActParticipation The player entity describes the source of the material to which the patient was exposed
ExposureTarget ActParticipation The player entity describes the target to which the agent was exposed
GuarantorParty ActParticipation The player represents a party which is used as a financial guarantor for payment in the carrying out of the act
Holder ActParticipation The player is responsible for holding the act
IndirectTarget ActParticipation The entity not directly present in the act but which will be the focust of th act.
Informant ActParticipation The player was a person or device which informed data presented in the act. (Example: A mother telling a nurse that their child had a reaction)
InformationRecipient ActParticipation The player entity represents something that should be cc'ed on the act
LegalAuthenticator ActParticipation The player entity is responsible for legally authenticating the content of the act
Location ActParticipation The location where the service was performed.
NonreuseableDevice ActParticipation The player represents a consumable that can no longer be used
Origin ActParticipation The player represents the origin of the act
Participation ActParticipation The player entity participates in the act in no particular classification
Performer ActParticipation The player entity is responsible for performing the clinical steps documented in the act
PrimaryInformationRecipient ActParticipation The player entity represents a high priority contact which should be informed or cc'ed on the act
PrimaryPerformer ActParticipation The player entity was the primary performer of the act. This is used in procedures where more than one performer is present
Product ActParticipation The player represents a product that is not necessarily consumed but informs the act
Receiver ActParticipation The player represents the entity which is the intended receiver of the act
RecordTarget ActParticipation The player represents the entity to which the act is recorded against
ReferredBy ActParticipation The player represents the entity which referred the act or caused the act to be undertaken
ReferredTo ActParticipation The player entity represents the entity which was referred to
Referrer ActParticipation The player entity represents the person who was originally the referrer.
Remote ActParticipation The player entity represents a remote portion of the act
ResponsibleParty ActParticipation The player entity is ultimately responsible for the carrying out of the act
ReusableDevice ActParticipation The player entity represents a device which can be reused in future acts
SecondaryPerformer ActParticipation The secondary performing person (support clinician).
Specimen ActParticipation The player entity represents a specimen collected for the purpose of testing and diagnosis
Subject ActParticipation The player entity is the subject of an act, but not necessarily the record target (meaning the act is about a particular entity but not to be attached to their record)
Tracker ActParticipation The player entity is responsible for tracking the progress of the act
Transcriber ActParticipation The person who transcribed data from the original act.
UgentNotificationContact ActParticipation The player entity represents a contact entity in case of an emergency occurs during the act.
Verifier ActParticipation The player entity was responsible for verifying the accuracy of the data in the act
Via ActParticipation The player entity represents an entity where the act occurred "via" this entity (i.e. in transport)
Witness ActParticipation The player entity represents a legal witness to the act occurring.
$other ActParticipation Unclassified
geo GeoTag Gets or sets the geo-tag
previousVersion string
version string
sequence Int64
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:

Members

actTime :Date

The moment in time that this act occurred in ISO format

Type:
  • Date
Source:

classConcept :string

Gets the delay-loaded value of the ClassConceptKey

Type:
  • string
Source:

classConceptModel :Concept

Type:
Source:

createdBy :string

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

Type:
  • string
Source:

createdByModel :SecurityProvenance

Type:
Source:

creationTime :Date

Gets or sets the creation time as an ISO date format

Type:
  • Date
Source:

creationTimeModel :Date

Type:
  • Date
Source:

doseQuantity :number

Gets or sets the amount of substance administered

Type:
  • number
Source:

doseSequence :number

The sequence of the dose (i.e. OPV 0 = 0 , OPV 1 = 1, etc.)

Type:
  • number
Source:

doseUnit :string

Gets or sets a concept which indicates the unit of measure for the dose (eg: 5 mL, 10 mL, 1 drop, etc.)

Type:
  • string
Source:

doseUnitModel :Concept

Type:
Source:

extension :object

Gets a list of all extensions associated with the act

Type:
  • object
Source:

geo :GeoTag

Gets or sets the geo-tag

Type:
Source:

id :string

Gets or sets the primary identifying UUID of this object

Type:
  • string
Source:

identifier :object

Identifiers by which this act is known

Type:
  • object
Source:

isNegated :boolean

Identifies whether the act represented in this instance actually occurred

Type:
  • boolean
Source:

modifiedOn :Date

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

Type:
  • Date
Source:

moodConcept :string

Gets the delay-loaded value of the MoodConceptKey property

Type:
  • string
Source:

moodConceptModel :Concept

Type:
Source:

note :ActNote

Gets a list of all notes associated with the act

Type:
Source:

obsoletedBy :string

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

Type:
  • string
Source:

obsoletedByModel :SecurityProvenance

Type:
Source:

obsoletionTime :Date

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

Type:
  • Date
Source:

obsoletionTimeModel :Date

Type:
  • Date
Source:

operation :BatchOperationType

Gets or sets the operation

Type:
Source:

participation :object

Gets or sets the entities and participations they play in the act

Type:
  • object
Source:

policy :SecurityPolicyInstance

Gets or sets the security policy instances associated with the act

Type:
Source:

previousVersion :string

Type:
  • string
Source:

protocol :ActProtocol

Identifies protocols attached to the act

Type:
Source:

reasonConcept :string

Identifies a codified reason as to why this act did (or did not, or should or should not) occur.

Type:
  • string
Source:

reasonConceptModel :Concept

Type:
Source:

relationship :object

Gets a list of all associated acts for this act

Type:
  • object
Source:

route :string

Gets or sets a concept which indicates the route of administration (eg: Oral, Injection, etc.)

Type:
  • string
Source:

routeModel :Concept

Type:
Source:

sequence :Int64

Type:
  • Int64
Source:

site :string

Gets or sets a concept which indicates the site of administration

Type:
  • string
Source:

siteModel :Concept

Type:
Source:

startTime :Date

The time when the act should or did start ocurring in ISO format

Type:
  • Date
Source:

statusConcept :string

Delay loads the concept represented in StatusConceptKey

Type:
  • string
Source:

statusConceptModel :Concept

Type:
Source:

stopTime :Date

The time when the act should or did stop ocurring in ISO format

Type:
  • Date
Source:

tag :object

Gets a list of all tags associated with the act

Type:
  • object
Source:

template :string

The template on which the act is based

Type:
  • string
Source:

templateModel :TemplateDefinition

Type:
Source:

typeConcept :string

Gets or sets the key of the concept which further classifies the type of act occurring

Type:
  • string
Source:

typeConceptModel :Concept

Type:
Source:

version :string

Type:
  • string
Source: