ARCHETYPE Immunisation list (openEHR-EHR-COMPOSITION.immunisation_list.v0)

ARCHETYPE IDopenEHR-EHR-COMPOSITION.immunisation_list.v0
ConceptImmunisation list
DescriptionA persistent and managed list of vaccinations that have been administered to an individual over time.
UseUse to record a persistent and managed list of vaccinations given to an individual. Alternatively, it may contain positive and explicit statements about known exclusions or absence of information about vaccinations. It is intended that the SECTION.immunisation_list archetype is nested within this archetype as design guidance for representing an Immunisation List. The intent of this archetype is to be a generic container for any Immunisation list, which may have a specific context or limitation of scope set within a template. This list can be utilised as a source of vaccination data for an active current Immunisation list within a clinical system, for transition of care, data exchange, or as the basis for decision support. This list can be comprised of three types of archetype: - statements about the positive administration of vaccinations are recorded using the ACTION.medication archetypes; OR - a positive statement about the general exclusion of vaccination administration can be recorded using the general EVALUATION.exclusion_global archetype - for example: "Never received any vaccinations"; OR - a positive statement about the exclusion of use of a specific medication can be recorded using the EVALUATION.exclusion_specific archetype - for example: "Never received Hepatitis B vaccination": OR - a positive statement about no information being available - neither positive known administrations of vaccinations nor a positive exclusion - can be recorded using the EVALUATION.absence archetype. In order for a Immunisation list to be accurate and safe to use as the basis for decision support activities and for exchange, this Immunisation list should ideally be curated by a clinician responsible for the health record, rather than managed automatically by the clinical system through business rules alone. In local systems it is possible to generate a list of vaccinations by querying the database for all ACTION.medication archetypes that have been used to record each vaccination. However this list is useful to support exchange of a local Immunisation list with other healthcare. This archetype is intended to be represented and managed as a persistent list, however there are situations where the list may be used within episodic care and require additional attributes such as context etc to enable accurate recording. The openEHR reference model currently only allows context to be recorded within Event-based COMPOSITION archetypes. As a result, this archetype has been modelled as an Event, rather than Persistent, COMPOSITION, to allow for flexibility so that some clinical systems can safely manage Immunisation lists for episodes of care, while others will choose to implement this COMPOSITION to act in a persistent manner.
MisuseNot to be used to record lists of Medications that are not intended for persistence and ongoing revision and curation - use COMPOSITION.medication_list for this purpose.
PurposeTo record a persistent and managed list of vaccinations that have been administered to an individual over time and to enable sharing of an Immunisation list between healthcare providers.
ReferencesPattern aligned with Medication list: http://www.openehr.org/ckm/#showArchetype_1013.1.286.

Pattern aligned with Problem list: http://www.openehr.org/ckm/#showArchetype_1013.1.287.
Copyright© openEHR Foundation
AuthorsAuthor name: Heather Leslie
Organisation: Atomica Informatics
Email: heather.leslie@atomicainformatics.com
Date originally authored: 2013-03-12
Other Details LanguageAuthor name: Heather Leslie
Organisation: Atomica Informatics
Email: heather.leslie@atomicainformatics.com
Date originally authored: 2013-03-12
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=Pattern aligned with Medication list: http://www.openehr.org/ckm/#showArchetype_1013.1.286. Pattern aligned with Problem list: http://www.openehr.org/ckm/#showArchetype_1013.1.287., current_contact=Heather Leslie, Atomica Informatics, original_namespace=org.openehr, original_publisher=openEHR Foundation, custodian_namespace=org.openehr, MD5-CAM-1.0.1=CF14C5C491FE8A7F34E0169DEAF03F9E, build_uid=70a0c9a9-c52d-4c2d-b799-5dcbfb17923d, revision=0.0.1-alpha}
Keywordsvaccination, immunisation, list
Lifecyclein_development
UIDdc64c5df-3d34-4b12-8a33-7c100020229c
Language useden
Citeable Identifier1013.1.1424
Revision Number0.0.1-alpha
AllArchetype [runtimeNameConstraintForConceptName=null, archetypeConceptBinding=null, archetypeConceptDescription=A persistent and managed list of vaccinations that have been administered to an individual over time., archetypeConceptComment=null, otherContributors=Ian McNicoll, freshEHR Clinical Informatics, United Kingdom
Hildegard Franke, freshEHR Clinical Informatics Ltd, UK, originalLanguage=en, translators=, subjectOfData=unconstrained, archetypeTranslationTree=null, topLevelToAshis={identities=[], other_participations=[], credentials=[], description=[], relationships=[], ism_transition=[], activities=[], items=[], data=[ResourceSimplifiedHierarchyItem [path=/category, code=null, itemType=UNSUPPORTEDTOPLEVELATTRIBUTE, level=0, text=Category, description=, comment=null, uncommonOntologyItems=null, occurencesFormal=null, occurencesText=null, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=UNSUPPORTEDTOPLEVELATTRIBUTE, bindings=null, values=null, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/category, code=null, itemType=DV_CODED_TEXT, level=1, text=null, description=null, comment=null, uncommonOntologyItems=null, occurencesFormal=1..1, occurencesText=Mandatory, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_CODED_TEXT, bindings=null, values=
  • event
, extendedValues=null]], capabilities=[], state=[], context=[ResourceSimplifiedHierarchyItem [path=/context/other_context[at0004]/items[at0005], code=at0005, itemType=SLOT, level=2, text=Extension, description=Additional information required to capture local context or to align with other reference models/formalisms., comment=For example: Local hospital departmental infomation 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]], events=[], source=[], content=[], target=[], details=[], provider=[], protocol=[], contacts=[]}, topLevelItems={context=ResourceSimplifiedHierarchyItem [path=ROOT_/context, code=null, itemType=EVENT_CONTEXT, level=0, text=null, description=null, comment=null, uncommonOntologyItems=null, occurencesFormal=1..1, occurencesText=Mandatory, cardinalityFormal=1..1, cardinalityText=mandatory, subCardinalityFormal=null, subCardinalityText=null, dataType=EVENT_CONTEXT, bindings=null, values=null, extendedValues=null]}, addHierarchyItemsTo=context, currentHierarchyItemsForAdding=[ResourceSimplifiedHierarchyItem [path=/context/other_context[at0004]/items[at0005], code=at0005, itemType=SLOT, level=2, text=Extension, description=Additional information required to capture local context or to align with other reference models/formalisms., comment=For example: Local hospital departmental infomation 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]], minIndents={}, termBindingRetrievalErrorMessage=null]