POCP_HD060100UV01 A_ProductUseGuidelineSPL |
(Link to Excel View) Derived from RMIM: POCP_RM060100UV01 |
||||||||
SubstanceAdministration1 |
Design Comments: Since the clinical medication module is all about appropriate and safe use of the drug, this "use" of the drug, i.e., the central SubstanceAdministration is the pivot of all structured data of the highlights. This SubstanceAdministration is a definition and defines the key data of a proper use of the medicine. |
||||||||
classCode [1..1] (M) SubstanceAdministration (CS) {CNE:V:ActClassSubstanceAdministration, root= "SBADM"} |
|||||||||
moodCode [1..1] (M) SubstanceAdministration (CS) {CNE:V:ActMoodDefinition, root= "DEF"} |
|||||||||
id [0..1] SubstanceAdministration (II) |
Design Comments: An oprional unique identifier for one (set of) product use instruction for the purpose of specific reference or recall. |
||||||||
text [0..1] SubstanceAdministration (ST) |
Design Comments: Optionally used to describe the full use and indication situation in words. |
||||||||
effectiveTime [0..1] SubstanceAdministration (QSET<TS>) |
Design Comments: Timing patterns (e.g., twice a day, every 8 hours, etc.) and timing boundaries (e.g., for 10 days) can be specified for the main SubstanceAdministration and its component SubstanceAdministration.In addition, SubstanceAdministration.effectiveTime can give general timing constraints, such as, "give 1 hour before meal". However, more specific clinical situations in which to give the medicine (e.g., "15 minutes before exercise" or "before sexual intercourse", etc.) must be specified using preconditions to a ClinicalSituationCriterion. |
||||||||
routeCode [0..1] SubstanceAdministration (CD) {CWE:D:RouteOfAdministration} |
Design Comments: The route by which the product is to be given according to this instruction. |
||||||||
doseQuantity [0..1] SubstanceAdministration (URG<PQ>) |
Design Comments: Amount of the medicine given at one single administration. The medicine in terms of which this dose is specified can be clarified using the consumable participation which leads either to the Medicine or to an ActiveIngredient. This can be specified by means of reference to the ManufacturedProduct.id or the ActiveIngredient.id, without requiring repeating the detail of these roles and entities playing the roles. |
||||||||
maxDoseQuantity [0..*] SubstanceAdministration (DSET<RTO<PQ,PQ.TIME>>) |
Design Comments: A ratio specifying a "do not exceed" dose, as a maximum dose (see doseQuantity) over a period of time. E.g. maximum amount per any time interval, e.g., 4 g in any 24-hour period. The time period must always be placed into the denominator, whereas the numerator can be a simple amount or a form |
||||||||
consumable [0..1] (Consumable2) |
Design Comments: Reveals the products used as inputs into reconstitution. UsageNotes: Dose unit must be specified when not dosing based on the specific formulation (e.g., tablet, actuation) otherwise the strength is not known. |
||||||||
maintenanceGoal [0..*] (MaintenanceGoal) | |||||||||
reason [0..1] (Reason) |
Design Comments: An ActRelationship of type "reason" representing the indication of the substance administration by linking to an observation criterion. The typeCode of the reason ActRelationship can be further refined to indicate different motivations, such as therapeutic reason (as a remedy), prophylactic reason (as a means of prevention), or as diagnostic reason (something done to diagnose the disease. |
||||||||
precondition [0..*] (Precondition) | |||||||||
derivedFrom [0..*] (DerivedFrom) |
Design Comments: Links a SubstanceAdministation to a specified kind of Observation which is used for calculated dosage. An example would be: <substanceAdministration> ... <maxDoseQuantity> <numerator xsi:type="EXPR_PQ" unit="mg"> <expression mediaType="application/hl7-factor+xml"/> <factor value="57" unit="mg/kg"> <factor>bodyMass</factor> </expression> </numerator> <denominator value="1" unit="d"/> </maxDoseQuantity> ... <consumable> <activeIngredient ... /> </consumable> <derivedFrom> <localVariableName>bodyMass</localVariableName> <monitoringObservation> <code code="29463-7" codeSystem="&LOINC;" displayName="BODY WEIGHT:MASS:PT:^PATIENT:QN"/> </monitoringObservation> </derivedFrom> </substanceAdministration> Note: the EXPR data type is forthcoming in the release 2 of the HL7 data type specification under ballot at the same time as release 4 of this specification is being balloted. Also note, the unit attribute on the maxDoseQuantity numerator indicates the unit of the expression value, i.e., it guarantees that the expression evaluates to a physical quantity in this specified unit. |
||||||||
component [0..*] (Component3) |
Design Comments: If dosage regimens should vary, this can be specified by component SubstanceAdministrations. In that case, the main SubstanceAdministration must not have a doseQuantity of itself, and instead the subordinate component SusbtanceAdministration would carry the doseQuantity for each different dose. This is used for example, to specify a loading dose, or a tapering dose. A regimen with a loading dose is specified using two components, the first representing the initial dose, with repeatNumber = 1 (meaning "once") or any other limitation in number or time. That first component would be followed by a second component that can repeat for the rest of the duration of the therapy. For tapering doses, the first component would represent the duration of the therapy and the second (or following) components specify the tapering-off scheme. |
||||||||
subjectOf [0..*] (Subject2) |
Design Comments: Links an issue to the product use substance administration. |
||||||||
componentOf [0..1] (Component1) |
Design Comments: Specifies that the pivotal SubstanceAdministration is part of a Protocol for safe and effective use. |
||||||||
Consumable2 |
Design Comments: Reveals the products used as inputs into reconstitution. UsageNotes: Dose unit must be specified when not dosing based on the specific formulation (e.g., tablet, actuation) otherwise the strength is not known. |
||||||||
typeCode [1..1] (M) Participation (CS) {CNE:V:ParticipationConsumable, root= "CSM"} |
|||||||||
productRole [1..1] (R_ProductUseExactUniversal) | |||||||||
Reason |
Design Comments: An ActRelationship of type "reason" representing the indication of the substance administration by linking to an observation criterion. The typeCode of the reason ActRelationship can be further refined to indicate different motivations, such as therapeutic reason (as a remedy), prophylactic reason (as a means of prevention), or as diagnostic reason (something done to diagnose the disease. |
||||||||
typeCode [1..1] (M) ActRelationship (CS) {CNE:V:ActRelationshipReason, root= "RSON"} |
Design Comments: The typeCode of the reason ActRelationship can be further refined to indicate different motivations, such as therapeutic reason (as a remedy), prophylactic reason (as a means of prevention), or as diagnostic reason (something done to diagnose the disease. UsageNotes: ERROR - Business name from Visio is too long and was truncated. Full businessName follows. (specializations TREAT - therapeutic indication, PRYLX - prophylactic indication, DIAG - diagnostic indication |
||||||||
negationInd [0..1] ActRelationship (BL){default= "false"} |
|||||||||
indication [1..1] (Indication) | |||||||||
Indication | |||||||||
component [0..*] (Component4) | |||||||||
choice of IndicationObservationCriterion |
Design Comments: An observation criterion that is specified as the "reason" (ActRelationship) of the SubstanceAdministration. The observation criterion consists of a code to indicate that the observation is a diagnoses, symptoms, conditions, etc. and a value-code to represent the specific indication, e.g. hypertension, etc. |
||||||||
or ProcedureCriterion |
Design Comments: An indication criterion in terms of a procedure, e.g., to specify a use that would accompany a procedure or be given subsequent or in preparation of a certain procedure. |
||||||||
Component4 | |||||||||
typeCode [1..1] (M) ActRelationship (CS) {CNE:V:ActRelationshipHasComponent, root= "COMP"} |
|||||||||
observationCriterion [1..1] (ObservationCriterion) | |||||||||
IndicationObservationCriterion |
Design Comments: An observation criterion that is specified as the "reason" (ActRelationship) of the SubstanceAdministration. The observation criterion consists of a code to indicate that the observation is a diagnoses, symptoms, conditions, etc. and a value-code to represent the specific indication, e.g. hypertension, etc. |
||||||||
classCode [1..1] (M) Observation (CS) {CNE:V:ActClassObservation, root= "OBS"} |
|||||||||
moodCode [1..1] (M) Observation (CS) {CNE:V:ActMoodEventCriterion, root= "EVN.CRT"} |
|||||||||
code [1..1] (M) Observation (CD) {CWE:V:ObservationDiagnosisTypes} |
Design Comments: A code indicating that the observation is a diagnoses, symptoms, conditions, etc. |
||||||||
isCriterionInd [0..1] Observation (BL){fixed value= "true"} |
Design Comments: Fixed value (true) indicating that this is a criterion and not an event that actually took place. |
||||||||
value [1..1] (M) Observation (CD) {CWE:D:ObservationValue} |
Design Comments: A value-code representing the specific indication, e.g. hypertension, etc. |
||||||||
Inherits associations from Indication | |||||||||
ProcedureCriterion |
Design Comments: An indication criterion in terms of a procedure, e.g., to specify a use that would accompany a procedure or be given subsequent or in preparation of a certain procedure. |
||||||||
classCode [1..1] (M) Procedure (CS) {CNE:V:ActClassProcedure, root= "PROC"} |
|||||||||
moodCode [1..1] (M) Procedure (CS) {CNE:V:ActMoodEventCriterion, root= "EVN.CRT"} |
|||||||||
code [0..1] Procedure (CD) {CWE:D:ActProcedureCode} |
Design Comments: A code specifying the kind of procedure. |
||||||||
isCriterionInd [0..1] Procedure (BL){fixed value= "true"} |
Design Comments: Fixed value (true) indicating that this is a criterion and not an event that actually took place. |
||||||||
Inherits associations from Indication | |||||||||
DerivedFrom |
Design Comments: Links a SubstanceAdministation to a specified kind of Observation which is used for calculated dosage. An example would be: <substanceAdministration> ... <maxDoseQuantity> <numerator xsi:type="EXPR_PQ" unit="mg"> <expression mediaType="application/hl7-factor+xml"/> <factor value="57" unit="mg/kg"> <factor>bodyMass</factor> </expression> </numerator> <denominator value="1" unit="d"/> </maxDoseQuantity> ... <consumable> <activeIngredient ... /> </consumable> <derivedFrom> <localVariableName>bodyMass</localVariableName> <monitoringObservation> <code code="29463-7" codeSystem="&LOINC;" displayName="BODY WEIGHT:MASS:PT:^PATIENT:QN"/> </monitoringObservation> </derivedFrom> </substanceAdministration> Note: the EXPR data type is forthcoming in the release 2 of the HL7 data type specification under ballot at the same time as release 4 of this specification is being balloted. Also note, the unit attribute on the maxDoseQuantity numerator indicates the unit of the expression value, i.e., it guarantees that the expression evaluates to a physical quantity in this specified unit. |
||||||||
typeCode [1..1] (M) ActRelationship (CS) {CNE:V:ActRelationshipIsDerivedFrom, root= "DRIV"} |
|||||||||
localVariableName [0..1] ActRelationship (ST.SIMPLE) |
Design Comments: The local variable is the name by which the referenced observation is referred to in the formula expression. |
||||||||
subsetCode [0..1] ActRelationship (CS) {CNE:V:ActRelationshipSubset} |
Design Comments: Specifies which observation instance from a set of matching ones is selected (e.g., first, last, maximum, minum, or summaries, such as average.) |
||||||||
observationDefinition [1..1] (ObservationDefinition) |
Design Comments: Specifies a kind of Observation which is used for calculated dosage. |
||||||||
ObservationDefinition |
Design Comments: Specifies a kind of Observation which is used for calculated dosage. |
||||||||
classCode [1..1] (M) Observation (CS) {CNE:V:ActClassObservation, root= "OBS"} |
|||||||||
moodCode [1..1] (M) Observation (CS) {CNE:V:ActMoodDefinition, root= "DEF"} |
|||||||||
code [1..1] (M) Observation (CD) {CWE:D:ObservationType} |
Design Comments: A code for the property based on which the dosage is calculated. |
||||||||
Component3 |
Design Comments: If dosage regimens should vary, this can be specified by component SubstanceAdministrations. In that case, the main SubstanceAdministration must not have a doseQuantity of itself, and instead the subordinate component SusbtanceAdministration would carry the doseQuantity for each different dose. This is used for example, to specify a loading dose, or a tapering dose. A regimen with a loading dose is specified using two components, the first representing the initial dose, with repeatNumber = 1 (meaning "once") or any other limitation in number or time. That first component would be followed by a second component that can repeat for the rest of the duration of the therapy. For tapering doses, the first component would represent the duration of the therapy and the second (or following) components specify the tapering-off scheme. |
||||||||
typeCode [1..1] (M) ActRelationship (CS) {CNE:V:ActRelationshipHasComponent, root= "COMP"} |
|||||||||
contextConductionInd [1..1] (M) ActRelationship (BL){default= "true"} |
|||||||||
sequenceNumber [0..1] ActRelationship (INT.NONNEG) |
Design Comments: For a sequence of dosage variants, specify 1 for the first, 2 for the following, and so on. This may be inferred or held consistent with the ordering of the variants in the message or document, but the meaning of sequencing is independent of the ordering of data items in messages or documents. |
||||||||
substanceAdministration [1..1] (SubstanceAdministration2) |
Design Comments: A subordinate component SusbtanceAdministration which carries the doseQuantity for a step in a complex dosage plan. This is used for example, to specify a loading dose, or a tapering dose. |
||||||||
SubstanceAdministration2 |
Design Comments: A subordinate component SusbtanceAdministration which carries the doseQuantity for a step in a complex dosage plan. This is used for example, to specify a loading dose, or a tapering dose. |
||||||||
classCode [1..1] (M) SubstanceAdministration (CS) {CNE:V:ActClassSubstanceAdministration, root= "SBADM"} |
|||||||||
moodCode [1..1] (M) SubstanceAdministration (CS) {CNE:V:ActMoodDefinition, root= "DEF"} |
|||||||||
effectiveTime [0..1] SubstanceAdministration (QSET<TS>) |
Design Comments: Specification of all time aspects of the administration schedule, including frequency and overall duration. |
||||||||
repeatNumber [0..1] SubstanceAdministration (IVL<INT.NONNEG>) |
Design Comments: A dosage regimen with a loading dose is specified using two components, the first representing the initial dose, with repeatNumber = 1 (meaning "once") or any other limitation in number or time. That first component would be followed by a second component that can repeat for the rest of the duration of the therapy. |
||||||||
doseQuantity [1..1] (M) SubstanceAdministration (URG<PQ>) |
Design Comments: The doseQuantity, see the same attribute in the pivotal SubstanceAdministration for detail. |
||||||||
rateQuantity [0..1] SubstanceAdministration (URG<PQ>) |
Design Comments: See the RIM description of rateQuantity. |
||||||||
Subject2 |
Design Comments: Links an issue to the product use substance administration. |
||||||||
typeCode [1..1] (M) ActRelationship (CS) {CNE:V:ActRelationshipHasSubject, root= "SUBJ"} |
Design Comments: Fixed to SUBJ (subject) |
||||||||
issueOrCharacteristic [1..1] (IssueOrCharacteristic) | |||||||||
IssueOrCharacteristic | |||||||||
choice of A_ProductCharacteristicUniversal | |||||||||
or Issue |
Design Comments: Adverse events, interactions, contraindications and other issues of special caution are represented in one uniform structure. The Pharmacy SIG has established a special kind of Act, called Issue for this purpose. An Issue has one or more other Acts as subjects and indicate that there is a certain problem requiring special caution with its subject Acts. In the case of SPL, the subject is the SubstanceAdministration described in the label. One or more additional subjects can be used to specify additional ClinicalSituationCriteria such as ObservationCriteria or SubstanceAdministrationCriteria. The latter is used to represent interactions which is an Issue involving the administration of two substances. |
||||||||
Issue |
Design Comments: Adverse events, interactions, contraindications and other issues of special caution are represented in one uniform structure. The Pharmacy SIG has established a special kind of Act, called Issue for this purpose. An Issue has one or more other Acts as subjects and indicate that there is a certain problem requiring special caution with its subject Acts. In the case of SPL, the subject is the SubstanceAdministration described in the label. One or more additional subjects can be used to specify additional ClinicalSituationCriteria such as ObservationCriteria or SubstanceAdministrationCriteria. The latter is used to represent interactions which is an Issue involving the administration of two substances. |
||||||||
classCode [1..1] (M) Observation (CS) {CNE:V:ActClassDetectedIssue, root= "ALRT"} |
|||||||||
moodCode [1..1] (M) Observation (CS) {CNE:V:ActMoodDefinition, root= "DEF"} |
|||||||||
code [0..1] Observation (CD) {CWE:D:Issue} |
Design Comments: A code for the kind of issue. |
||||||||
text [0..1] Observation (ST) |
Design Comments: A text description of the issue. This could be displayed as part of a reminder. |
||||||||
risk [0..*] (Risk) |
Design Comments: An ActRelationship linking an Issue to a risk, i.e. a coded ConsequenceObservation criterion with information about severity and frequency of the undesired outcome. |
||||||||
subject [0..*] (Subject1) |
Design Comments: An ActRelationship linking an Issue to a co-factor, i.e. another ClinicalSituationCriterion, a choice of either ObservationCriterion, SubstanceAdministrationCriterion or general ActCriterion. This is used to describe certain clinical situations as situations that would be of concern when using the drugs (see Issue.) |
||||||||
Risk |
Design Comments: An ActRelationship linking an Issue to a risk, i.e. a coded ConsequenceObservation criterion with information about severity and frequency of the undesired outcome. |
||||||||
typeCode [1..1] (M) ActRelationship (CS) {CNE:V:ActRelationshipHasRisk, root= "RISK"} |
|||||||||
consequenceObservation [1..1] (ConsequenceObservation) |
Design Comments: An observation criterion specifying the adverse outcome as the usual code-value pair of an observation. |
||||||||
ConsequenceObservation |
Design Comments: An observation criterion specifying the adverse outcome as the usual code-value pair of an observation. |
||||||||
classCode [1..1] (M) Observation (CS) {CNE:V:ActClassObservation, root= "OBS"} |
|||||||||
moodCode [1..1] (M) Observation (CS) {CNE:V:ActMoodEventCriterion, root= "EVN.CRT"} |
|||||||||
code [1..1] (M) Observation (CD) {CWE:D:ObservationType} |
Design Comments: Consequence observation code, typically fixed to "medical problem" (medical condition). |
||||||||
text [0..1] Observation (ST) |
|||||||||
isCriterionInd [0..1] Observation (BL){fixed value= "true"} |
Design Comments: Fixed value (true) indicating that this is a criterion and not an event that actually took place. |
||||||||
value [0..1] Observation (ANY) {CWE:D:ObservationValue} |
Design Comments: Consequence observation value, typically a finding code. |
||||||||
causeOf [0..*] (CauseOf) |
Design Comments: The description of the risk can nest to refine to a level of specificity that makes the adverse event actually recognizable. For example, a risk may be specified as a "hypersensitivity syndrome" but then specific manifestations may be given including "rash," or "Guillain-Barre Syndrome", or even quantitative measures as "leukopenia with WBC below 1000/mm3." |
||||||||
subjectOf [0..2] (Subject3) |
Design Comments: Specification of frequency or severity of the adverse outcome. |
||||||||
CauseOf |
Design Comments: The description of the risk can nest to refine to a level of specificity that makes the adverse event actually recognizable. For example, a risk may be specified as a "hypersensitivity syndrome" but then specific manifestations may be given including "rash," or "Guillain-Barre Syndrome", or even quantitative measures as "leukopenia with WBC below 1000/mm3." |
||||||||
typeCode [1..1] (M) ActRelationship (CS) {CNE:V:ActRelationshipIsEtiologyFor, root= "CAUS"} |
|||||||||
consequenceObservation [1..1] (ConsequenceObservation) | |||||||||
Subject3 |
Design Comments: Specification of frequency or severity of the adverse outcome. |
||||||||
typeCode [1..1] (M) ActRelationship (CS) {CNE:V:ActRelationshipHasSubject, root= "SUBJ"} |
|||||||||
severityAndFrequency [1..1] (SeverityAndFrequency) | |||||||||
SeverityAndFrequency | |||||||||
choice of Severity |
Design Comments: A specification of severity of an adverse event as an observation criterion. |
||||||||
or Frequency |
Design Comments: A specification of frequency of occurrence of an adverse event as an observation criterion. |
||||||||
Severity |
Design Comments: A specification of severity of an adverse event as an observation criterion. |
||||||||
classCode [1..1] (M) Observation (CS) {CNE:V:ActClassObservation, root= "OBS"} |
|||||||||
moodCode [1..1] (M) Observation (CS) {CNE:V:ActMoodEventOccurrence, root= "EVN"} |
|||||||||
code [1..1] (M) Observation (CD) {CWE:D:ActCode} |
Design Comments: A code indicating "severity" or, better, a specific operational definition of severity. |
||||||||
value [1..1] (M) Observation (CD) {CWE:V:SeverityObservation} |
Design Comments: The severity value according to the code. |
||||||||
Frequency |
Design Comments: A specification of frequency of occurrence of an adverse event as an observation criterion. |
||||||||
classCode [1..1] (M) Observation (CS) {CNE:V:ActClassObservation, root= "OBS"} |
|||||||||
moodCode [1..1] (M) Observation (CS) {CNE:V:ActMoodEventOccurrence, root= "EVN"} |
|||||||||
code [1..1] (M) Observation (CD) {CWE:D:ActCode} |
Design Comments: A code specifying "frequency" or, better, a specific operational conceptinalization of frequency. |
||||||||
value [1..1] (M) Observation (CD) {CWE:D:SymptomFrequency} |
Design Comments: A frequency value according to the frequency code. |
||||||||
Subject1 |
Design Comments: An ActRelationship linking an Issue to a co-factor, i.e. another ClinicalSituationCriterion, a choice of either ObservationCriterion, SubstanceAdministrationCriterion or general ActCriterion. This is used to describe certain clinical situations as situations that would be of concern when using the drugs (see Issue.) |
||||||||
typeCode [1..1] (M) ActRelationship (CS) {CNE:V:ActRelationshipHasSubject, root= "SUBJ"} |
Design Comments: Fixed to SUBJ (subject) |
||||||||
clinicalSituationCriterion [1..1] (ClinicalSituationCriterion) | |||||||||
Component1 |
Design Comments: Specifies that the pivotal SubstanceAdministration is part of a Protocol for safe and effective use. |
||||||||
typeCode [1..1] (M) ActRelationship (CS) {CNE:V:ActRelationshipHasComponent, root= "COMP"} |
Design Comments: Fixed to COMP (component). |
||||||||
sequenceNumber [0..1] ActRelationship (INT.NONNEG){default= "2"} |
Design Comments: This attribute is fixed to 2. See the sequenceNumber attribute of component[monitoringObservation] for its use. |
||||||||
priorityNumber [0..1] ActRelationship (REAL) |
|||||||||
pauseQuantity [0..1] ActRelationship (PQ.TIME) |
|||||||||
splitCode [0..1] ActRelationship (CS) {CNE:V:ActRelationshipSplit} |
|||||||||
joinCode [0..1] ActRelationship (CS) {CNE:V:ActRelationshipJoin} |
|||||||||
seperatableInd [0..1] ActRelationship (BL) |
|||||||||
protocol [1..1] (Protocol) |
Design Comments: Specifies a safe use protocol wherein a substance administration is recommended to be accompanied by monitoring observations, i.e. tests such as drug level tests, pharamacokinetic parameter tests (renal function), or adverse effect tests (hypotension, liver enzymes) required. This Protocol contains MonitoringObservation steps and maintenance goals as MonitoringObservationCriteria. |
||||||||
Protocol |
Design Comments: Specifies a safe use protocol wherein a substance administration is recommended to be accompanied by monitoring observations, i.e. tests such as drug level tests, pharamacokinetic parameter tests (renal function), or adverse effect tests (hypotension, liver enzymes) required. This Protocol contains MonitoringObservation steps and maintenance goals as MonitoringObservationCriteria. |
||||||||
classCode [1..1] (M) Act (CS) {CNE:V:ActClassRoot, root= "ACT"} |
|||||||||
moodCode [1..1] (M) Act (CS) {CNE:V:ActMoodDefinition, root= "DEF"} |
|||||||||
maintenanceGoal [0..*] (MaintenanceGoal) |
Design Comments: Specifies a criterion (e.g., range) within which certain test results should remain, such as blood levels of the drug or its metabolites should remain to ensure efficacy and avoid toxicity. MonitoringObservation.code specifies the observations that would be performed (e.g. digoxin level, gentamicin level, etc.) and the MonitoringObservation.value specifies a result-value interval with single bounds (e.g. maximal limits) or two bounds (range) that should be maintained throughout the treatment. The indication can be further specified to express an objective as to what the treatment should accomplish. For instance, if the goal of the treatment is absence of acute asthma attacks, the maintenance goal can describe this. This is used to allow the treatment effect to be coded and still keep the indication a simple code that is comparable with actual patient problem list data. For instance, the indication would be "asthma" and the maintenance goal would be "no bronchiospasm" to indicate "prevention of bronchiospasm in patients with asthma". |
||||||||
precondition [0..*] (Precondition) |
Design Comments: An ActRelationship that links ClinicalSitutaionCriteria with the pivotal SubstanceAdministration. A ClinicalSituationCriterion is a choice of either ObservationCriterion, SubstanceAdministrationCriterion or general ActCriterion. These preconditions further limit the indication to a specific population or other clinical situation. Multiple preconditions can be specified. When multiple criteria are specified, they are logically conjoined (AND), i.e., they must all hold true. |
||||||||
component [1..*] (Component2) |
Design Comments: Specifies Monitoring actions as part of a safe use protocol. |
||||||||
MaintenanceGoal |
Design Comments: Specifies a criterion (e.g., range) within which certain test results should remain, such as blood levels of the drug or its metabolites should remain to ensure efficacy and avoid toxicity. MonitoringObservation.code specifies the observations that would be performed (e.g. digoxin level, gentamicin level, etc.) and the MonitoringObservation.value specifies a result-value interval with single bounds (e.g. maximal limits) or two bounds (range) that should be maintained throughout the treatment. The indication can be further specified to express an objective as to what the treatment should accomplish. For instance, if the goal of the treatment is absence of acute asthma attacks, the maintenance goal can describe this. This is used to allow the treatment effect to be coded and still keep the indication a simple code that is comparable with actual patient problem list data. For instance, the indication would be "asthma" and the maintenance goal would be "no bronchiospasm" to indicate "prevention of bronchiospasm in patients with asthma". |
||||||||
typeCode [1..1] (M) ActRelationship (CS) {CNE:V:ActRelationshipHasContinuingObjective, root= "OBJC"} |
|||||||||
observationCriterion [1..1] (ObservationCriterion) |
Design Comments: Specifies an observation that would be made in the described situation, and would characterize the situation. Used as a precondition to the situation. The observation criterion consists of a code to indicate that the observation is a diagnoses, symptoms, conditions, etc. and a value to represent the specific condition, e.g. renal failure, impaired liver function (as value code); systolic blood pressure < 100 mmHg (as numeric value range), etc. |
||||||||
ObservationCriterion |
Design Comments: Specifies an observation that would be made in the described situation, and would characterize the situation. Used as a precondition to the situation. The observation criterion consists of a code to indicate that the observation is a diagnoses, symptoms, conditions, etc. and a value to represent the specific condition, e.g. renal failure, impaired liver function (as value code); systolic blood pressure < 100 mmHg (as numeric value range), etc. |
||||||||
classCode [1..1] (M) Observation (CS) {CNE:V:ActClassObservation, root= "OBS"} |
|||||||||
moodCode [1..1] (M) Observation (CS) {CNE:V:ActMoodEventCriterion, root= "EVN.CRT"} |
|||||||||
id [0..1] Observation (II) |
Design Comments: A unique identifier for this criterion. |
||||||||
code [1..1] (M) Observation (CD) {CWE:D:ObservationType} |
Design Comments: A code specifying that the observation is a diagnoses, symptoms, conditions, etc. |
||||||||
text [0..1] Observation (ST) |
Design Comments: A textual description of the criterion. To be used infrequently. |
||||||||
isCriterionInd [0..1] Observation (BL){fixed value= "true"} |
Design Comments: Fixed value (true) indicating that this is a criterion and not an event that actually took place. |
||||||||
value [1..1] (M) Observation (ANY) {CWE:D:ObservationValue} |
Design Comments: A value representing the specific condition, e.g. renal failure, impaired liver function (as value code), or systolic blood pressure < 100 mmHg (as numeric range, IVL<PQ>), etc. |
||||||||
valueNegationInd [0..1] Observation (BL) |
Design Comments: This is "false" by default, i.e., no negation. If "true", it means that the inverse of the observation is specified. Note: this was negationInd in previous releases. |
||||||||
Precondition |
Design Comments: An ActRelationship that links ClinicalSitutaionCriteria with the pivotal SubstanceAdministration. A ClinicalSituationCriterion is a choice of either ObservationCriterion, SubstanceAdministrationCriterion or general ActCriterion. These preconditions further limit the indication to a specific population or other clinical situation. Multiple preconditions can be specified. When multiple criteria are specified, they are logically conjoined (AND), i.e., they must all hold true. |
||||||||
typeCode [1..1] (M) ActRelationship (CS) {CNE:V:ActRelationshipHasPre-condition, root= "PRCN"} |
Design Comments: Fixed to PRCN (precondition). |
||||||||
priorityNumber [0..1] ActRelationship (REAL) |
|||||||||
pauseQuantity [0..1] ActRelationship (PQ.TIME) |
Design Comments: Specifies a certain time constraint between the clinical situation and the use of the drug. E.g., "use 15 minutes before exercise" or "X should be given at least 8 hours after Y". |
||||||||
checkpointCode [0..1] ActRelationship (CS) {CNE:V:ActRelationshipCheckpoint} |
|||||||||
clinicalSituationCriterion [1..1] (ClinicalSituationCriterion) | |||||||||
ClinicalSituationCriterion | |||||||||
choice of ObservationCriterion |
Design Comments: Specifies an observation that would be made in the described situation, and would characterize the situation. Used as a precondition to the situation. The observation criterion consists of a code to indicate that the observation is a diagnoses, symptoms, conditions, etc. and a value to represent the specific condition, e.g. renal failure, impaired liver function (as value code); systolic blood pressure < 100 mmHg (as numeric value range), etc. |
||||||||
or ActCriterion |
Design Comments: The ActCriterion is a general criterion to give a procedure code or a code of any other clinical service that would be used to limit either positively or negatively the indication of the drug. |
||||||||
or SubstanceAdministrationCriterion |
Design Comments: The SubstanceAdministrationCriterion specifies another treatment and is used by Issue to specify an interacting treatment, and with a Precondition to specify adjunctive treatment. |
||||||||
ActCriterion |
Design Comments: The ActCriterion is a general criterion to give a procedure code or a code of any other clinical service that would be used to limit either positively or negatively the indication of the drug. |
||||||||
classCode [1..1] (M) Act (CS) {CNE:V:ActClassRoot, root= "ACT"} |
|||||||||
moodCode [1..1] (M) Act (CS) {CNE:V:ActMoodEventCriterion, root= "EVN.CRT"} |
|||||||||
id [0..1] Act (II) |
Design Comments: A unique identifier by which the criterion may be recalled. |
||||||||
code [0..1] Act (CD) {CWE:D:ActCode} |
Design Comments: A code for an activity. |
||||||||
actionNegationInd [0..1] Act (BL) |
Design Comments: True if the meaning is "activity not done". Note: this was negationInd in previous releases. |
||||||||
text [0..1] Act (ST) |
|||||||||
isCriterionInd [0..1] Act (BL){fixed value= "true"} |
Design Comments: Fixed value (true) indicating that this is a criterion and not an event that actually took place. |
||||||||
SubstanceAdministrationCriterion |
Design Comments: The SubstanceAdministrationCriterion specifies another treatment and is used by Issue to specify an interacting treatment, and with a Precondition to specify adjunctive treatment. |
||||||||
classCode [1..1] (M) SubstanceAdministration (CS) {CNE:V:ActClassSubstanceAdministration, root= "SBADM"} |
|||||||||
moodCode [1..1] (M) SubstanceAdministration (CS) {CNE:V:ActMoodEventCriterion, root= "EVN.CRT"} |
|||||||||
id [0..1] SubstanceAdministration (II) |
|||||||||
isCriterionInd [0..1] SubstanceAdministration (BL){fixed value= "true"} |
Design Comments: Fixed value (true) indicating that this is a criterion and not an event that actually took place. |
||||||||
routeCode [0..1] SubstanceAdministration (CD) {CWE:D:RouteOfAdministration} |
|||||||||
consumable [1..1] (Consumable1) |
Design Comments: The participation linking the SubstanceAdministrationCritetion with the other administered substance which then consititues an interaction. |
||||||||
Consumable1 |
Design Comments: The participation linking the SubstanceAdministrationCritetion with the other administered substance which then consititues an interaction. |
||||||||
typeCode [1..1] (M) Participation (CS) {CNE:V:ParticipationConsumable, root= "CSM"} |
|||||||||
administrableMaterial [1..1] (AdministrableMaterial) |
Design Comments: A role structure whose player is the material (medicine or food). |
||||||||
AdministrableMaterial |
Design Comments: A role structure whose player is the material (medicine or food). |
||||||||
classCode [1..1] (M) Role (CS) {CNE:V:RoleClassAdministerableMaterial, root= "ADMM"} |
|||||||||
administrableMaterialKind [1..1] (E_ProductMaterialKindUniversal) | |||||||||
Component2 |
Design Comments: Specifies Monitoring actions as part of a safe use protocol. |
||||||||
typeCode [1..1] (M) ActRelationship (CS) {CNE:V:ActRelationshipHasComponent, root= "COMP"} |
|||||||||
sequenceNumber [0..1] ActRelationship (INT.NONNEG){default= "2"} |
Design Comments: This attribute is set to 1 for "screening" tests or first-line preferred or preparatory treatments, i.e., those that should be performed before start of treatment protocol, 2 for monitoring observations and co-therapies that should be done during the treatment with the main drug,and 3 for follow-up/weaning/tapering. The underlying semantics is that sequenceNumber orders the components of the protocol. If the sequence number is equal in both components, it means these are done in parallel. Otherwise the components are to be executed in the order of ascending sequenceNumber. For simplicity of use and interpretation, the sequenceNumber of the treatment component has been fixed to 30, so that the choice between screening and monitoring can be done in a single element. |
||||||||
priorityNumber [0..1] ActRelationship (REAL) |
|||||||||
pauseQuantity [0..1] ActRelationship (PQ.TIME) |
|||||||||
splitCode [0..1] ActRelationship (CS) {CNE:V:ActRelationshipSplit} |
|||||||||
joinCode [0..1] ActRelationship (CS) {CNE:V:ActRelationshipJoin} |
|||||||||
seperatableInd [0..1] ActRelationship (BL) |
|||||||||
protocolAction [1..1] (ProtocolAction) | |||||||||
ProtocolAction | |||||||||
choice of MonitoringObservation |
Design Comments: Prescribe the tests that should be performed and in what frequency. MonitoringObservation.code detailing the tests that should be performed (e.g. thrombocytes count, liver enzymes, etc.) The MonitoringObservation.effectiveTime is used to specify the recommended frequency of these tests in the same way as the frequency of SubstanceAdministration is specified. |
||||||||
or SubstanceAdministration1 |
Design Comments: Since the clinical medication module is all about appropriate and safe use of the drug, this "use" of the drug, i.e., the central SubstanceAdministration is the pivot of all structured data of the highlights. This SubstanceAdministration is a definition and defines the key data of a proper use of the medicine. |
||||||||
MonitoringObservation |
Design Comments: Prescribe the tests that should be performed and in what frequency. MonitoringObservation.code detailing the tests that should be performed (e.g. thrombocytes count, liver enzymes, etc.) The MonitoringObservation.effectiveTime is used to specify the recommended frequency of these tests in the same way as the frequency of SubstanceAdministration is specified. |
||||||||
classCode [1..1] (M) Observation (CS) {CNE:V:ActClassObservation, root= "OBS"} |
|||||||||
moodCode [1..1] (M) Observation (CS) {CNE:V:ActMoodDefinition, root= "DEF"} |
|||||||||
id [0..1] Observation (II) |
|||||||||
code [1..1] (M) Observation (CD) {CWE:D:ObservationType} |
Design Comments: A code for the patient property (laboratory observation) to be monitored. |
||||||||
effectiveTime [0..1] Observation (QSET<TS>) |
Design Comments: The timing by which the monitoring should happen (e.g., every other day.) |