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 | Gets or sets an indicator which identifies whether the act actually occurred, or specifically did not occur | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
template |
string | Gets the template UUID upon which this act is based | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
templateModel |
TemplateDefinition | [Delay loaded from template], Gets or sets the template definition | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
actTime |
Date | Gets or sets the moment in time that this act occurred in ISO format | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
startTime |
Date | Gets or sets the time when the act should or did start ocurring in ISO format | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
stopTime |
Date | Gets or sets the time when the act should or did stop ocurring in ISO format | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
classConcept |
string | Gets or sets the key of the concept which classifies the act.(see: ActClassKeys for values) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
moodConcept |
string | Gets or sets the key of the concept which specifies the mood of the act.(see: ActMoodKeys for values) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reasonConcept |
string | Gets or sets the key of the concept which defines the reason why the act is or didn't occur(see: ActReasonKeys for values) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
statusConcept |
string | Gets or sets the key of the concept which describes the current status of the act(see: StatusKeys for values) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
typeConcept |
string | Gets or sets the key of the conccept which further classifies the type of act occurring | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
classConceptModel |
Concept | [Delay loaded from classConcept], Gets or sets the concept which classifies the type of act | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
moodConceptModel |
Concept | [Delay loaded from moodConcept], Gets or sets the concept which specifies the mood of the act | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reasonConceptModel |
Concept | [Delay loaded from reasonConcept], Gets or sets the concept which indicates the reason of the act | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
statusConceptModel |
Concept | [Delay loaded from statusConcept], Gets or sets the current status concept of the act | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
typeConceptModel |
Concept | [Delay loaded from typeConcept], Type concept identifier | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
identifier |
object | Gets or sets the identifiers by which this act is known as in other systems
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
relationship |
object | Gets a list of all associated acts for this act
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
protocol |
ActProtocol | Identifies protocols attached to the act | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
participation |
object | Gets or sets the entities and participations they play in the act
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
geo |
GeoTag | Gets or sets the geo-tag | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
previousVersion |
string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
version |
string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sequence |
number | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
Gets or sets the moment in time that this act occurred in ISO format
Type:
- Date
- Source:
classConcept :string
Gets or sets the key of the concept which classifies the act.
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
Gets or sets the identifiers by which this act is known as in other systems
Type:
- object
- Source:
isNegated :boolean
Gets or sets an indicator which identifies whether the act actually occurred, or specifically did not occur
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 or sets the key of the concept which specifies the mood of the act.
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
Gets or sets the key of the concept which defines the reason why the act is or didn't 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 :number
Type:
- number
- Source:
site :string
Gets or sets a concept which indicates the site of administration
Type:
- string
- Source:
siteModel :Concept
Type:
- Source:
startTime :Date
Gets or sets the time when the act should or did start ocurring in ISO format
Type:
- Date
- Source:
statusConcept :string
Gets or sets the key of the concept which describes the current status of the act
Type:
- string
- Source:
statusConceptModel :Concept
Type:
- Source:
stopTime :Date
Gets or sets 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
Gets the template UUID upon which this act is based
Type:
- string
- Source:
templateModel :TemplateDefinition
Type:
- Source:
typeConcept :string
Gets or sets the key of the conccept which further classifies the type of act occurring
Type:
- string
- Source:
typeConceptModel :Concept
Type:
- Source:
version :string
Type:
- string
- Source: