ARCHETYPE Vaccination summary (openEHR-EHR-EVALUATION.vaccination_summary.v0)

ARCHETYPE IDopenEHR-EHR-EVALUATION.vaccination_summary.v0
ConceptVaccination summary
DescriptionSummary of vaccination administration for a single infectious disease or agent, or a group of infectious diseases or agents that are vaccinated simultaneously using a combination vaccine.
UseUse to record a summary of vaccine administration events targeting a single infectious disease or agent, or a group of infectious diseases or agents that are vaccinated simultaneously using a combination vaccine. The intent of this archetype is to support a clinical determination about whether the individual is up-to-date with vaccinations for the targeted disease/s or agent/s. It is not intended to make a determination about the immunisation status, which is about whether the individual has developed an adequate immune response following vaccination or whether protective immunity has waned. This archetype does not presume any particular schedule or protocol for immunisation.
MisuseNot to be used to record the vaccination status of an individual at a point in time - use OBSERVATION.vaccination_status for this purpose. Not to be used for documenting the detailed administration of a vaccine, including body site, route, manufacturer and batch number etc - use ACTION.vaccination or ACTION.medication for this purpose. Not to be used for recording screening question/answer pairs regarding vaccination activity - use OBSERVATION.vaccination_screening for this purpose.
PurposeTo record a summary of vaccine administration events targeting a single infectious disease or agent, or a group of infectious diseases or agents that are vaccinated simultaneously using a combination vaccine.
References
Copyright© openEHR Foundation
AuthorsAuthor name: Heather Leslie
Organisation: Atomica Informatics
Email: heather.leslie@atomicainformatics.com
Date originally authored: 2012-11-23
Other Details LanguageAuthor name: Heather Leslie
Organisation: Atomica Informatics
Email: heather.leslie@atomicainformatics.com
Date originally authored: 2012-11-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, current_contact=Heather Leslie, Ocean Informatics, heather.leslie@oceaninformatics.com, original_namespace=org.openehr, original_publisher=openEHR Foundation, custodian_namespace=org.openehr, MD5-CAM-1.0.1=15A478730DA59C58996486A80D7D7D78, build_uid=ecde46ce-cbc4-463b-82e9-8c6f763d86d2, revision=0.0.1-alpha}
Keywordsimmunisation, immunisation, immunization, summary, primary, course, booster
Lifecyclein_development
UID83189d56-5489-4643-aa6d-d46696338ea5
Language useden
Citeable Identifier1246.145.1447
Revision Number0.0.1-alpha
AllArchetype [runtimeNameConstraintForConceptName=null, archetypeConceptBinding=null, archetypeConceptDescription=Summary of vaccination administration for a single infectious disease or agent, or a group of infectious diseases or agents that are vaccinated simultaneously using a combination vaccine., archetypeConceptComment=null, otherContributors=Silje Ljosland Bakke, Nasjonal IKT HF, Norway (openEHR Editor)
Sistine Barretto-Daniels, Ocean Informatics, Australia
Merrilyn Curtis, AnalyzeIT, Australia
Heather Leslie, Atomica Informatics, Australia (openEHR Editor)
Ian McNicoll, freshEHR Clinical Informatics, United Kingdom (openEHR Editor), originalLanguage=en, translators=German: Natalia Strauch, Alina Rehberg, Medizinische Hochschule Hannover, Strauch.Natalia@mh-hannover.de; rehberg.alina@mh-hannover.de
Spanish (Argentina): Alan March, Hospital Universitario Austral, Pilar, Buenos Aires, Argentina., alandmarch@gmail.com, MD
Portuguese (Brazil): Adriana Kitajima, Débora Farage, Fernanda Maia, Laíse Figueiredo, Marivan Abrahão, Core Consulting, contato@coreconsulting.com.br, Hospital Alemão Oswaldo Cruz (HAOC)
, subjectOfData=unconstrained, archetypeTranslationTree=null, topLevelToAshis={source=[], capabilities=[], contacts=[], items=[], credentials=[], content=[], provider=[], data=[ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0052], code=at0052, itemType=ELEMENT, level=2, text=Vaccine name, description=Name of the vaccine administered., comment=The vaccine name may contain a generic or trade name for a vaccine, the name of a combination vaccine, or a category of vaccine. For example: Measles vaccine; Measles Mumps Rubella (MMR) or 'Measles-containing vaccine'. Coding with an external 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=/data[at0001]/items[at0002], code=at0002, itemType=ELEMENT, level=2, text=Targeted disease or agent, description=Name of the infectious disease or agent targeted by the vaccine., comment=If the 'Vaccine name' is a combination vaccine this data element may contain more than one target disease. Coding with an external terminology is preferred, where possible., 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=/data[at0001]/items[at0035], code=at0035, itemType=ELEMENT, level=2, text=Description, description=Narrative description about vaccination activity and experiences related to the targeted disease or agent., 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[at0003], code=at0003, itemType=ELEMENT, level=2, text=Primary course status, description=Status of the primary (or catch up) course of vaccinations., comment=This status should be revised if the course has not been completed and the 'Next vaccination due' date or 'Next review due' has passed. , uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=CHOICE, bindings=null, values=Choice of:
  •  Coded Text
    • Course not commenced [A course of vaccinations is planned but not commenced.]
    • Course incomplete [A course of vaccinations has been commenced but not completed.]
    • Course complete [A course of vaccinations has been completed.]
    • Unknown [It is not possible to determine if the primary course has been completed.]
  •  Text
, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0008], code=at0008, itemType=ELEMENT, level=2, text=Date course completed, description=The date on which the (primary or catch-up) course of vaccines was completed., 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=/data[at0001]/items[at0047], code=at0047, itemType=ELEMENT, level=2, text=Total number of administrations, description=Total number of vaccine doses administered over the lifetime of the individual., comment=May be manually calculated or extracted from EHR sources. , uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=CHOICE, bindings=null, values=Choice of:
  •  Count
    min: >=0

  •  Coded Text
    • Unknown
, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0009], code=at0009, itemType=ELEMENT, level=2, text=Date of last vaccination, description=The date when the most recent vaccine was administered., comment=Can be a partial date, for example, only a year., 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=/data[at0001]/items[at0033], code=at0033, itemType=ELEMENT, level=2, text=Next vaccination due, description=The date when the next vaccine is due to be 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=/data[at0001]/items[at0051], code=at0051, itemType=SLOT, level=2, text=Additional details, description=Additional details about vaccinations related to the targeted disease or agent., comment=null, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=CLUSTER, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0049], code=at0049, itemType=ELEMENT, level=2, text=Comment, description=Additional narrative about vaccination administrationfor the identified disease or agent, 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[at0022], code=at0022, itemType=CLUSTER, level=2, text=Per vaccine administration, description=Details about a specific vaccine administration., comment=null, uncommonOntologyItems=null, occurencesFormal=0..*, occurencesText=Optional, repeating, cardinalityFormal=1..*, cardinalityText=, subCardinalityFormal=null, subCardinalityText=null, dataType=CLUSTER, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0022]/items[at0023], code=at0023, itemType=ELEMENT, level=3, text=Specific vaccine name, description=Name of the specific vaccine administered., comment=For example: a trade name that may be more specific than the index 'Vaccine name'. , 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=/data[at0001]/items[at0022]/items[at0034], code=at0034, itemType=SLOT, level=3, text=Vaccine details, description=Details about the vaccine, including generic components and batch number if required., 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.medication.v1 and specialisations, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0022]/items[at0038], code=at0038, itemType=ELEMENT, level=3, text=Administration category, description=Category of the vaccine administered., comment=For example: primary vaccination; or booster., uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=CHOICE, bindings=null, values=Choice of:
  •  Coded Text
    • Primary course
    • Booster
  •  Text
, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0022]/items[at0024], code=at0024, itemType=ELEMENT, level=3, text=Date of administration, description=Date of administration of the specified vaccine., comment=Can be a partial date, for example, only a year., 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=/data[at0001]/items[at0022]/items[at0031], code=at0031, itemType=ELEMENT, level=3, text=Sequence in series, description=The sequence of the vaccine administered within a primary course or series., comment=For example: 1/2 for first vaccination in a series of 2., uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=CHOICE, bindings=null, values=Choice of:
  •  Count
    min: >=1

  •  Text
, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0022]/items[at0042], code=at0042, itemType=ELEMENT, level=3, text=Description, description=Narrative description about the vaccine administration., 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[at0022]/items[at0027], code=at0027, itemType=SLOT, level=3, text=Administration location, description=, 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], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0022]/items[at0045], code=at0045, itemType=ELEMENT, level=3, text=Administration outcome, description=The observed response to the administration of vaccine., comment=Coding with an external terminology is preferred, where possible. For example: a reaction such as rash or shortness of breath., 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[at0022]/items[at0046], code=at0046, itemType=ELEMENT, level=3, text=Information source, description=Identification of the source of the vaccine administration information., comment=For example: child health book, clinic record, or parent., 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[at0022]/items[at0044], code=at0044, itemType=SLOT, level=3, text=Additional details, description=Additional details about the specific 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.dosage.v2 and specialisations, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0022]/items[at0016], code=at0016, itemType=ELEMENT, level=3, text=Administration comment, description=Additional narrative about the vaccine administration for the identified vaccinet, 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]], relationships=[], context=[], other_participations=[], description=[], protocol=[ResourceSimplifiedHierarchyItem [path=/protocol[at0013]/items[at0015], code=at0015, itemType=ELEMENT, level=2, text=Last updated, description=The date on which the immunisation 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], ResourceSimplifiedHierarchyItem [path=/protocol[at0013]/items[at0053], code=at0053, itemType=ELEMENT, level=2, text=Information source, description=Identification of the source of all vaccination information., comment=For example: child health book, clinic record, or parent., 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[at0013]/items[at0050], code=at0050, itemType=SLOT, level=2, text=Extension, description=Additional information required to extend the model with local content or to align with other reference models/formalisms., comment=For example: local information requirements; or additional metadata to align with FHIR., 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]], events=[], activities=[], state=[], ism_transition=[], identities=[], details=[], target=[]}, topLevelItems={protocol=ResourceSimplifiedHierarchyItem [path=ROOT_/protocol[at0013], code=at0013, 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], 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=1..*, subCardinalityText=, dataType=ITEM_TREE, bindings=null, values=null, extendedValues=null]}, addHierarchyItemsTo=protocol, currentHierarchyItemsForAdding=[ResourceSimplifiedHierarchyItem [path=/protocol[at0013]/items[at0015], code=at0015, itemType=ELEMENT, level=2, text=Last updated, description=The date on which the immunisation 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], ResourceSimplifiedHierarchyItem [path=/protocol[at0013]/items[at0053], code=at0053, itemType=ELEMENT, level=2, text=Information source, description=Identification of the source of all vaccination information., comment=For example: child health book, clinic record, or parent., 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[at0013]/items[at0050], code=at0050, itemType=SLOT, level=2, text=Extension, description=Additional information required to extend the model with local content or to align with other reference models/formalisms., comment=For example: local information requirements; or additional metadata to align with FHIR., 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]], minIndents={}, termBindingRetrievalErrorMessage=null]