ARCHETYPE Vaccination management (openEHR-EHR-ACTION.vaccination_management.v0)

ARCHETYPE IDopenEHR-EHR-ACTION.vaccination_management.v0
ConceptVaccination management
DescriptionAny activity related to the process of planning, scheduling, administration and notification of a single vaccine item, including deviations from the intended care path such as postponement and cancellation.
UseUse to record details about any activity related to the process of planning, scheduling, administration and notification of a single vaccine item, including deviations from the intended care path such as postponement and cancellation. This is achieved by the recording of relevant data elements about specific activities, each of which are described as the 'Pathway' careflow steps in this archetype. This archetype is intended to be used to record a record of progress of vaccination against any planned vaccination. Within the context of a Vaccination List, this archetype will be used to record only what vaccination has been administered. Timings related to vaccine management can be managed in one of two ways: - Using the reference model - the time for performance of any pathway step will use the ACTION time attribute for each step. - Archetyped data elements - the 'Scheduled date/time' data element is intended to record the time when the vaccine item was intended to be administered. Note: the corresponding ACTION time attribute for the Scheduled pathway step will record the time that the clinical activity was scheduled into a system, not the intended date/time on which the activity is intended to be carried out. In practice, overarching care plans can incorporate age-, gender- and clinical context-appropriate vaccination plans, usually generated on the basis of accepted local vaccination protocols or guidelines and recorded in the health record in a variety of ways: - using a single order that describes an entire vaccination schedule appropriate for the individual's age, gender and clinical context; - a single order for a course of multiple vaccinations (primary course +/- boosters) for a target disease; or - one or more orders that each describe a single individual vaccination. Some travel-related vaccinations may require a clinician to generate a prescription for a vaccine that is not commonly available at the vaccination centre - this will require generation of a prescription, using the INSTRUCTION.medication_order archetypes. Recording information using this ACTION archetype indicates that some sort of activity has actually occurred; this will most commonly be the administration of the vaccine item itself, be used to record cancellation of a vaccination due to withdrawal of consent. When the activities follow the usual Planned > Scheduled > Active > Completed states, recording a 'Reason' is not usually necessary - rather, it is usually used to record the reason for deviation from the typical care pathway.
MisuseNot to be used to record the order for a vaccination or a prescription for a vaccination - use INSTRUCTION.medication for this purpose. Not to be used to record whether an individual is up-to-date with their vaccination for a target disease - use EVALUATION.vaccine_summary.
PurposeTo record details about any activity related to the process of planning, scheduling, administration and notification of a single vaccine item, including deviations from the intended care path such as postponement and cancellation.
References
Copyright© openEHR Foundation
AuthorsAuthor name: Heather Leslie
Organisation: Atomica Informatics
Email: heather.leslie@atomicainformatics.com
Date originally authored: 2023-03-23
Other Details LanguageAuthor name: Heather Leslie
Organisation: Atomica Informatics
Email: heather.leslie@atomicainformatics.com
Date originally authored: 2023-03-23
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, original_namespace=org.openehr, original_publisher=openEHR Foundation, custodian_namespace=org.openehr, MD5-CAM-1.0.1=1791F5BED3530F153A0B148B75C9BD7B, build_uid=b548435d-9820-443d-8c92-f87f29683801, revision=0.0.1-alpha}
Keywordsvaccination, administration, vaccine
Lifecyclein_development
UID6623f599-ff4e-449c-9824-10d02d81a1be
Language useden
Citeable Identifier1013.1.7910
Revision Number0.0.1-alpha
AllArchetype [runtimeNameConstraintForConceptName=null, archetypeConceptBinding=null, archetypeConceptDescription=Any activity related to the process of planning, scheduling, administration and notification of a single vaccine item, including deviations from the intended care path such as postponement and cancellation., archetypeConceptComment=null, otherContributors=Keisha Barwise, Jamaica
Candice de Lisser, Jamaica
Khin Aung, Jamaica, originalLanguage=en, translators=, subjectOfData=unconstrained, archetypeTranslationTree=null, topLevelToAshis={other_participations=[], details=[], description=[ResourceSimplifiedHierarchyItem [path=/description[at0001]/items[at0002], code=at0002, itemType=ELEMENT, level=2, text=Vaccination item, description=Trade name or class of the vaccine which is the focus of the activity., comment=For example: Coding of the vaccine with a terminology is strongly recommended, where possible. The extent of coding may vary from the name or class of the vaccine item through to structured details about the actual vaccine product & dose., 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=/description[at0001]/items[at0010], code=at0010, itemType=ELEMENT, level=2, text=Dose amount, description=The amount of vaccine administered at one time., comment=For example: 1 mg, 1.5 ml, 0.125 g; or 1-2 ml, 12.5-20.5 mg., uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_QUANTITY, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/description[at0001]/items[at0007], code=at0007, itemType=ELEMENT, level=2, text=Route, description=The route of administraion of the vaccine., comment=For example: 'subcutaneous', 'intramuscular' or 'oral'. Coding of the route of administration with a terminology is preferred, where possible. , 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=/description[at0001]/items[at0008], code=at0008, itemType=ELEMENT, level=2, text=Body site, description=Name of the site of vaccine administration., comment=Comment: For example: 'left deltoid'. Coding of the body site with a terminology is preferred, where possible., 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=/description[at0001]/items[at0009], code=at0009, itemType=SLOT, level=2, text=Structured body site, description=Structured description of the site of vaccine administration., 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.anatomical_location.v1 and specialisations or
openEHR-EHR-CLUSTER.anatomical_location_relative.v2 and specialisations, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/description[at0001]/items[at0004], code=at0004, itemType=ELEMENT, level=2, text=Manufacturer, description=The manufacturer of the vaccine., comment=Comment: For example: 'Pfizer' or 'Johnson & Johnson'., 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=/description[at0001]/items[at0003], code=at0003, itemType=ELEMENT, level=2, text=Batch ID, description=The identifier assigned to the batch by the manufacturer during production., 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=/description[at0001]/items[at0005], code=at0005, itemType=ELEMENT, level=2, text=Expiry, description=The expiry date of the vaccine, as provided by the manufacturer., 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], ResourceSimplifiedHierarchyItem [path=/description[at0001]/items[at0014], code=at0014, itemType=ELEMENT, level=2, text=Sequence, description=The sequence of vaccine administration in a series of administrations., comment=For example: '2'; 'second booster' or '2 of 3'., uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_COUNT, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/description[at0001]/items[at0016], code=at0016, itemType=ELEMENT, level=2, text=Date scheduled, description=The date and/or time the vaccination is scheduled for administration., 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], ResourceSimplifiedHierarchyItem [path=/description[at0001]/items[at0015], code=at0015, itemType=ELEMENT, level=2, text=Date administered, description=The date and/or time the vaccination was administered., 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], ResourceSimplifiedHierarchyItem [path=/description[at0001]/items[at0022], code=at0022, itemType=ELEMENT, level=2, text=Patient guidance, description=Any guidance, instructions or advice given to the individual or carer at the time of the pathway step., 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=/description[at0001]/items[at0018], code=at0018, itemType=SLOT, level=2, text=Additional details, description=Further structured details about vaccination management, possibly specific to a single pathway step., comment=null, 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=/description[at0001]/items[at0017], code=at0017, itemType=ELEMENT, level=2, text=Reason, description=Reason that the pathway step for the identified vaccination was carried out., comment=It is not necessary to record the reason for each pathway step that is expected. Rather this data element is intended to capture the reason for any divergence from a typical vaccination process, such as 'Postponed' due to 'Patient had a fever', or a scheduled administration as part of a course may be 'Cancelled' due to 'Previous adverse reaction'. Note: The clinical indication for triggering the vaccination process may be recorded using the INSTRUCTION.medication archetype., 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=/description[at0001]/items[at0019], code=at0019, itemType=ELEMENT, level=2, text=Comment, description=Additional narrative about the activity or pathway step not captured in other fields, including details of any variance between the intended activity and the activity actually carried out., 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]], capabilities=[], protocol=[ResourceSimplifiedHierarchyItem [path=/protocol[at0020]/items[at0021], code=at0021, itemType=ELEMENT, level=2, text=Extension, description=Additional information required to extend the model with local content or to align with other reference models or formalisms., comment=For example: local information requirements; or additional metadata to align with FHIR., 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[at0020]/items[at0023], code=at0023, itemType=ELEMENT, level=2, text=Vaccination protocol, description=Identification of the vaccine schedule triggering this vaccination activity., comment=For example: 'National Immunisation Program schedule'; or 'Catch up schedule'., 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[at0020]/items[at0035], code=at0035, itemType=SLOT, level=2, text=Place of vaccination, description=Organisation where the vaccination was administered or holds the vaccination record., 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.organisation.v1 and specialisations, extendedValues=null]], relationships=[], items=[], activities=[], credentials=[], ism_transition=[ResourceSimplifiedHierarchyItem [path=/ism_transition[at0024]_526_at0024, code=at0024, itemType=ISM_TRANSITION, level=1, text=Vaccine recommended, description=, comment=null, uncommonOntologyItems=null, occurencesFormal=null, occurencesText=null, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=ISM_TRANSITION, bindings=null, values=Current state: planned, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/ism_transition[at0025]_526_at0025, code=at0025, itemType=ISM_TRANSITION, level=1, text=Prescription issued, description=A prescription for the vaccine item has been supplied to the individual for dispensing from a pharmacy., comment=null, uncommonOntologyItems=null, occurencesFormal=null, occurencesText=null, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=ISM_TRANSITION, bindings=null, values=Current state: planned, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/ism_transition[at0026]_529_at0026, code=at0026, itemType=ISM_TRANSITION, level=1, text=Vaccine appointment booked, description=, comment=null, uncommonOntologyItems=null, occurencesFormal=null, occurencesText=null, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=ISM_TRANSITION, bindings=null, values=Current state: scheduled, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/ism_transition[at0027]_527_at0027, code=at0027, itemType=ISM_TRANSITION, level=1, text=Vaccine administration postponed, description=, comment=null, uncommonOntologyItems=null, occurencesFormal=null, occurencesText=null, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=ISM_TRANSITION, bindings=null, values=Current state: postponed, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/ism_transition[at0028]_528_at0029, code=at0028, itemType=ISM_TRANSITION, level=1, text=Vaccine administration postponed, description=, comment=null, uncommonOntologyItems=null, occurencesFormal=null, occurencesText=null, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=ISM_TRANSITION, bindings=null, values=Current state: cancelled, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/ism_transition[at0030]_245_at0031, code=at0030, itemType=ISM_TRANSITION, level=1, text=Vaccine administration postponed, description=, comment=null, uncommonOntologyItems=null, occurencesFormal=null, occurencesText=null, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=ISM_TRANSITION, bindings=null, values=Current state: active, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/ism_transition[at0032]_532_at0032, code=at0032, itemType=ISM_TRANSITION, level=1, text=Vaccine administration completed, description=, comment=null, uncommonOntologyItems=null, occurencesFormal=null, occurencesText=null, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=ISM_TRANSITION, bindings=null, values=Current state: completed, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/ism_transition[at0033]_532_at0033, code=at0033, itemType=ISM_TRANSITION, level=1, text=Vaccine notification completed, description=Notification of vaccination has been sent to a vaccine registry or similar authority., comment=null, uncommonOntologyItems=null, occurencesFormal=null, occurencesText=null, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=ISM_TRANSITION, bindings=null, values=Current state: completed, extendedValues=null]], content=[], source=[], identities=[], provider=[], events=[], state=[], contacts=[], data=[], context=[], target=[]}, topLevelItems={description=ResourceSimplifiedHierarchyItem [path=ROOT_/description[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[at0020], code=at0020, 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], ism_transition=ResourceSimplifiedHierarchyItem [path=ROOT_/ism_transition[at0024], code=at0024, itemType=ISM_TRANSITION, level=0, text=null, description=null, comment=null, uncommonOntologyItems=null, occurencesFormal=null, occurencesText=null, cardinalityFormal=0..1, cardinalityText=optional, subCardinalityFormal=null, subCardinalityText=null, dataType=ISM_TRANSITION, bindings=null, values=null, extendedValues=null]}, addHierarchyItemsTo=ism_transition, currentHierarchyItemsForAdding=[ResourceSimplifiedHierarchyItem [path=/ism_transition[at0024]_526_at0024, code=at0024, itemType=ISM_TRANSITION, level=1, text=Vaccine recommended, description=, comment=null, uncommonOntologyItems=null, occurencesFormal=null, occurencesText=null, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=ISM_TRANSITION, bindings=null, values=Current state: planned, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/ism_transition[at0025]_526_at0025, code=at0025, itemType=ISM_TRANSITION, level=1, text=Prescription issued, description=A prescription for the vaccine item has been supplied to the individual for dispensing from a pharmacy., comment=null, uncommonOntologyItems=null, occurencesFormal=null, occurencesText=null, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=ISM_TRANSITION, bindings=null, values=Current state: planned, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/ism_transition[at0026]_529_at0026, code=at0026, itemType=ISM_TRANSITION, level=1, text=Vaccine appointment booked, description=, comment=null, uncommonOntologyItems=null, occurencesFormal=null, occurencesText=null, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=ISM_TRANSITION, bindings=null, values=Current state: scheduled, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/ism_transition[at0027]_527_at0027, code=at0027, itemType=ISM_TRANSITION, level=1, text=Vaccine administration postponed, description=, comment=null, uncommonOntologyItems=null, occurencesFormal=null, occurencesText=null, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=ISM_TRANSITION, bindings=null, values=Current state: postponed, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/ism_transition[at0028]_528_at0029, code=at0028, itemType=ISM_TRANSITION, level=1, text=Vaccine administration postponed, description=, comment=null, uncommonOntologyItems=null, occurencesFormal=null, occurencesText=null, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=ISM_TRANSITION, bindings=null, values=Current state: cancelled, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/ism_transition[at0030]_245_at0031, code=at0030, itemType=ISM_TRANSITION, level=1, text=Vaccine administration postponed, description=, comment=null, uncommonOntologyItems=null, occurencesFormal=null, occurencesText=null, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=ISM_TRANSITION, bindings=null, values=Current state: active, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/ism_transition[at0032]_532_at0032, code=at0032, itemType=ISM_TRANSITION, level=1, text=Vaccine administration completed, description=, comment=null, uncommonOntologyItems=null, occurencesFormal=null, occurencesText=null, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=ISM_TRANSITION, bindings=null, values=Current state: completed, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/ism_transition[at0033]_532_at0033, code=at0033, itemType=ISM_TRANSITION, level=1, text=Vaccine notification completed, description=Notification of vaccination has been sent to a vaccine registry or similar authority., comment=null, uncommonOntologyItems=null, occurencesFormal=null, occurencesText=null, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=ISM_TRANSITION, bindings=null, values=Current state: completed, extendedValues=null]], minIndents={}, termBindingRetrievalErrorMessage=null]