ARCHETYPE ID | openEHR-EHR-EVALUATION.vaping_summary.v0 |
Concept | Vaping summary |
Description | Summary or persistent information about the vaping habits of an individual. |
Use | Use to record summary information about the individual's pattern of vaping of substances and e-liquids. This archetype is to be used to record information about both current and previous vaping behaviour. Amount of nicotine has been excluded from the scope for the core archetype, but could be added into the Episode SLOT if required. The history of waxing and waning of use for each type of substance or e-liquid over time can be captured using the repeatable 'Per episode' cluster. Triggers for closing one episode and commencing a new one will largely reflect local data collection preferences, including if the individual: - quits for a significant period of time (which will likely be locally defined); or - significantly changes their amount of use or pattern of their vaping. Use to incorporate the narrative descriptions of vaping within existing or legacy clinical systems into an archetyped format, using the 'Overall description' data element. |
Misuse | Not to be used to record summary-based information about tobacco smoking, such as the pattern of smoking habits - use the EVALUATION.tobacco_smoking_summary archetype. Not to be used to record event-or period-based information about tobacco smoking, such as actual daily use or the average use over a specified period of time - use the OBSERVATION.tobacco_smoking archetype. Not to be used to record summary-based information about smokeless tobacco use - for example: snus; snuff; chewing tobacco; dip; and gutka. Use the archetype EVALUATION.smokeless_tobacco_summary archetype for this purpose. Not to be used to record summary-based information about substance use - use the EVALUATION.substance_use_summary for this purpose. Not to be used to record evidence of nicotine dependency. Use the OBSERVATION.fagerstrom for this purpose. Not to be used to record details about unintended exposure to tobacco smoke or passive smoking. Use the archetype EVALUATION.exposure for this purpose. Not to be used for recording any other administration of nicotine, such as e-cigarettes, nicotine patches or nicotine chewing gum. Use separate archetypes for this purpose. |
Purpose | To record summary information about the individual's pattern of vaping of substances and e-liquids. |
References | Tobacco smoking summary, Published archetype [Internet]. openEHR Foundation, openEHR Clinical Knowledge Manager [cited: 2020-05-20]. Available from: https://ckm.openehr.org/ckm/archetypes/1013.1.2466. |
Copyright | © openEHR Foundation, Australian Digital Health Agency, Nasjonal IKT (Norway), openEHR Foundation |
Authors | Author name: Heather Leslie Organisation: Atomica Informatics Email: heather.leslie@atomicainformatics.com Date originally authored: 2020-05-20 |
Other Details Language | Author name: Heather Leslie Organisation: Atomica Informatics Email: heather.leslie@atomicainformatics.com Date originally authored: 2020-05-20 |
OtherDetails Language Independent | {licence=This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/., custodian_organisation=openEHR Foundation, references=Tobacco smoking summary, Published archetype [Internet]. openEHR Foundation, openEHR Clinical Knowledge Manager [cited: 2020-05-20]. Available from: https://ckm.openehr.org/ckm/archetypes/1013.1.2466., current_contact=Heather Leslie, Atomica Informatics, heather.leslie@atomicainformatics.com, original_namespace=org.openehr, original_publisher=openEHR Foundation, custodian_namespace=org.openehr, MD5-CAM-1.0.1=5FACFDBC82E0B3FBB687EBAF29BD0AB6, build_uid=fc681cde-58ca-44ad-97d1-a74d8bf39a52, revision=0.0.1-alpha} |
Keywords | electronic, cigarettes, e-cigs, cigs, nicotine, ENDS, ENNDS, ANDS, vaporisers, e-hookahs, hookahs, vape, pens, vapes, delivery |
Lifecycle | in_development |
UID | d0b028bd-a208-4aa1-bc14-d22b3b932e17 |
Language used | en |
Citeable Identifier | 1013.1.4823 |
Revision Number | 0.0.1-alpha |
All | Archetype [runtimeNameConstraintForConceptName=null, archetypeConceptBinding=null, archetypeConceptDescription=Summary or persistent information about the vaping habits of an individual., archetypeConceptComment=null, otherContributors=, originalLanguage=en, translators=
, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0029]/items[at0064]/items[at0026], code=at0026, itemType=SLOT, level=4, text=Episode details, description=Additional structured details about the specified episode of vaping., comment=null, uncommonOntologyItems=null, occurencesFormal=0..*, occurencesText=Optional, repeating, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=CLUSTER, bindings=null, values=Include: openEHR-EHR-CLUSTER.cessation_ openEHR-EHR-CLUSTER.cessation_ All not explicitly excluded archetypes, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0029]/items[at0069], code=at0069, itemType=ELEMENT, level=3, text=Comment, description=Additional narrative about vaping of the specified substance or e-liquid, not captured in other fields., comment=null, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_TEXT, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0086], code=at0086, itemType=SLOT, level=2, text=Overall details, description=Additional structured details about the overall vaping behaviour., comment=null, uncommonOntologyItems=null, occurencesFormal=0..*, occurencesText=Optional, repeating, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=CLUSTER, bindings=null, values=Include: openEHR-EHR-CLUSTER.change.v0 and specialisations or openEHR-EHR-CLUSTER.change.v1 and specialisations, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0016], code=at0016, itemType=ELEMENT, level=2, text=Overall quit date, description=The date when the individual last ceased vaping of any substance or e-liquid., comment=Can be a partial date, for example, only a year. This date could be used by decision support guidance to determine if the individual is at risk of relapse, for example in the first 12 months since quitting., uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_DATE, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0019], code=at0019, itemType=ELEMENT, level=2, text=Overall comment, description=Additional narrative about all vaping that has not been captured in other fields., comment=For example: stopped vaping or reduced amount on becoming pregnant., uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_TEXT, bindings=null, values=, extendedValues=null]], identities=[], other_participations=[], activities=[], protocol=[ResourceSimplifiedHierarchyItem [path=/protocol[at0021]/items[at0073], code=at0073, itemType=SLOT, level=2, text=Extension, description=Additional information required to capture local content or to align with other reference models/formalisms., comment=For example: local information requirements or additional metadata to align with FHIR or CIMI equivalents., uncommonOntologyItems=null, occurencesFormal=0..*, occurencesText=Optional, repeating, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=CLUSTER, bindings=null, values=Include: All not explicitly excluded archetypes, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/protocol[at0021]/items[at0071], code=at0071, itemType=ELEMENT, level=2, text=Quit date definition, description=The applied definition for the 'Quit date' data elements used in this archetype., comment=null, uncommonOntologyItems=null, occurencesFormal=0..*, occurencesText=Optional, repeating, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_TEXT, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/protocol[at0021]/items[at0085], code=at0085, itemType=ELEMENT, level=2, text=Quit attempt definition, description=The applied definition for a Quit attempt used to determine value for the 'Number of quit attempts' data element used in this archetype., comment=For example: 'stopped vaping for one day or longer with the intention of quitting'., uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_TEXT, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/protocol[at0021]/items[at0075], code=at0075, itemType=ELEMENT, level=2, text=Current vpaer definition, description=The applied definition for the 'Current vaper' value in each of the 'Status' data elements used in this archetype., comment=Definition may need to be specified per type. Current vaper definitions vary in different jurisdictions. , uncommonOntologyItems=null, occurencesFormal=0..*, occurencesText=Optional, repeating, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_TEXT, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/protocol[at0021]/items[at0076], code=at0076, itemType=ELEMENT, level=2, text=Former vaper definition, description=The applied definition for the 'Former vaper' value in each of the 'Status' data elements used in this archetype., comment=Former vaper definitions vary in different jurisdictions., uncommonOntologyItems=null, occurencesFormal=0..*, occurencesText=Optional, repeating, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_TEXT, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/protocol[at0021]/items[at0079], code=at0079, itemType=ELEMENT, level=2, text=Never vaped definition, description=The applied definition for the 'Never vaped' value in each of the 'Status' data elements used in this archetype., comment=For example, the definition may not be zero, but less than a specified amount vaped during a specified time interval., uncommonOntologyItems=null, occurencesFormal=0..*, occurencesText=Optional, repeating, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_TEXT, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/protocol[at0021]/items[at0022], code=at0022, itemType=ELEMENT, level=2, text=Last updated, description=The date this vaping summary was last updated., comment=null, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_DATE_TIME, bindings=null, values=, extendedValues=null]], credentials=[], events=[], context=[], relationships=[], target=[], capabilities=[], items=[], source=[], ism_transition=[]}, topLevelItems={data=ResourceSimplifiedHierarchyItem [path=ROOT_/data[at0001], code=at0001, itemType=ITEM_TREE, level=0, text=null, description=null, comment=null, uncommonOntologyItems=null, occurencesFormal=1..1, occurencesText=Mandatory, cardinalityFormal=0..1, cardinalityText=optional, subCardinalityFormal=0..*, subCardinalityText=Minimum of 0 items , dataType=ITEM_TREE, bindings=null, values=null, extendedValues=null], protocol=ResourceSimplifiedHierarchyItem [path=ROOT_/protocol[at0021], code=at0021, itemType=ITEM_TREE, level=0, text=null, description=null, comment=null, uncommonOntologyItems=null, occurencesFormal=1..1, occurencesText=Mandatory, cardinalityFormal=0..1, cardinalityText=optional, subCardinalityFormal=0..*, subCardinalityText=Minimum of 0 items , dataType=ITEM_TREE, bindings=null, values=null, extendedValues=null]}, addHierarchyItemsTo=protocol, currentHierarchyItemsForAdding=[ResourceSimplifiedHierarchyItem [path=/protocol[at0021]/items[at0073], code=at0073, itemType=SLOT, level=2, text=Extension, description=Additional information required to capture local content or to align with other reference models/formalisms., comment=For example: local information requirements or additional metadata to align with FHIR or CIMI equivalents., uncommonOntologyItems=null, occurencesFormal=0..*, occurencesText=Optional, repeating, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=CLUSTER, bindings=null, values=Include: All not explicitly excluded archetypes, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/protocol[at0021]/items[at0071], code=at0071, itemType=ELEMENT, level=2, text=Quit date definition, description=The applied definition for the 'Quit date' data elements used in this archetype., comment=null, uncommonOntologyItems=null, occurencesFormal=0..*, occurencesText=Optional, repeating, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_TEXT, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/protocol[at0021]/items[at0085], code=at0085, itemType=ELEMENT, level=2, text=Quit attempt definition, description=The applied definition for a Quit attempt used to determine value for the 'Number of quit attempts' data element used in this archetype., comment=For example: 'stopped vaping for one day or longer with the intention of quitting'., uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_TEXT, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/protocol[at0021]/items[at0075], code=at0075, itemType=ELEMENT, level=2, text=Current vpaer definition, description=The applied definition for the 'Current vaper' value in each of the 'Status' data elements used in this archetype., comment=Definition may need to be specified per type. Current vaper definitions vary in different jurisdictions. , uncommonOntologyItems=null, occurencesFormal=0..*, occurencesText=Optional, repeating, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_TEXT, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/protocol[at0021]/items[at0076], code=at0076, itemType=ELEMENT, level=2, text=Former vaper definition, description=The applied definition for the 'Former vaper' value in each of the 'Status' data elements used in this archetype., comment=Former vaper definitions vary in different jurisdictions., uncommonOntologyItems=null, occurencesFormal=0..*, occurencesText=Optional, repeating, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_TEXT, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/protocol[at0021]/items[at0079], code=at0079, itemType=ELEMENT, level=2, text=Never vaped definition, description=The applied definition for the 'Never vaped' value in each of the 'Status' data elements used in this archetype., comment=For example, the definition may not be zero, but less than a specified amount vaped during a specified time interval., uncommonOntologyItems=null, occurencesFormal=0..*, occurencesText=Optional, repeating, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_TEXT, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/protocol[at0021]/items[at0022], code=at0022, itemType=ELEMENT, level=2, text=Last updated, description=The date this vaping summary was last updated., comment=null, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_DATE_TIME, bindings=null, values=, extendedValues=null]], minIndents={}, termBindingRetrievalErrorMessage=null] |