ARCHETYPE Immunisation procedure (openEHR-EHR-ACTION.immunisation_procedure.v0)

ARCHETYPE IDopenEHR-EHR-ACTION.immunisation_procedure.v0
ConceptImmunisation procedure
DescriptionRecord of a vaccine administration procedure.
UseUse to record the process of vaccination administration status, call and recall.
MisuseShould not be used to record the medical administration of the vaccine.
PurposeTo record the process of immunisation administration, call and recall.
References
Copyright© Clinical Models UK
AuthorsAuthor name: Ian McNicoll
Organisation: freshEHR Clinical Informatics Ltd.
Email: ian@freshehr.com
Date originally authored: 2013-07-17
Other Details LanguageAuthor name: Ian McNicoll
Organisation: freshEHR Clinical Informatics Ltd.
Email: ian@freshehr.com
Date originally authored: 2013-07-17
OtherDetails Language Independent{licence=This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/3.0/., custodian_organisation=UK Clinical Models, original_namespace=uk.org.clinicalmodels, original_publisher=UK Clinical Models, custodian_namespace=uk.org.clinicalmodels, MD5-CAM-1.0.1=A55CD79CA8F15FF30D365AB51E70A568, build_uid=16e828c9-05f2-4664-9a3c-06ab7930d2c6, revision=0.0.1-alpha}
Keywordsvaccine, vaccination, immunisation
Lifecyclein_development
UID0e55feb1-0d46-46cb-801f-75f10523528c
Language useden
Citeable Identifier1051.32.808
Revision Number0.0.1-alpha
AllArchetype [runtimeNameConstraintForConceptName=null, archetypeConceptBinding=null, archetypeConceptDescription=Record of a vaccine administration procedure., archetypeConceptComment=null, otherContributors=, originalLanguage=en, translators=, subjectOfData=unconstrained, archetypeTranslationTree=null, topLevelToAshis={state=[], content=[], capabilities=[], relationships=[], activities=[], events=[], contacts=[], description=[ResourceSimplifiedHierarchyItem [path=/description[at0001]/items[at0002], code=at0002, itemType=ELEMENT, level=2, text=Immunisation name, description=The name or type of immunisation given, often the name of the target disease e.g. 'Hepatitis B'., 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[at0004], code=at0004, itemType=ELEMENT, level=2, text=Series number, description=The sequence number in a series of immunisations e.g. 3rd DTP., comment=null, 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[at0015], code=at0015, itemType=ELEMENT, level=2, text=Comment, description=An additional comment about the vaccination process., 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=Reason withheld, description=The reason why a vaccination was withheld., 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]], target=[], context=[], identities=[], protocol=[ResourceSimplifiedHierarchyItem [path=/protocol[at0013]/items[at0014], code=at0014, itemType=ELEMENT, level=2, text=Medication administration record, description=A link to an associated medication administration record., comment=null, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_EHR_URI, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/protocol[at0013]/items[at0016], code=at0016, itemType=SLOT, level=2, text=Extension, description=Additional information required to capture local context or to align with other reference models/formalisms., comment=e.g. Local hospital departmental infomation or additional metadata to align with HL7 or CDISC 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]], other_participations=[], items=[], details=[], provider=[], source=[], ism_transition=[ResourceSimplifiedHierarchyItem [path=/ism_transition[at0010]_528_at0010, code=at0010, itemType=ISM_TRANSITION, level=1, text=Immunisation course refused, description=The course of immunisations has been refused., 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[at0008]_529_at0008, code=at0008, itemType=ISM_TRANSITION, level=1, text=First call issued, description=The first call for immunisation has been issued., 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[at0006]_245_at0006, code=at0006, itemType=ISM_TRANSITION, level=1, text=Immunisation administered, description=The immunisation has been administered., 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[at0007]_530_at0007, code=at0007, itemType=ISM_TRANSITION, level=1, text=Immunisation administration deferred, description=Administration of the immunisation has been deferred., comment=null, uncommonOntologyItems=null, occurencesFormal=null, occurencesText=null, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=ISM_TRANSITION, bindings=null, values=Current state: suspended, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/ism_transition[at0012]_531_at0012, code=at0012, itemType=ISM_TRANSITION, level=1, text=Immunisation course discontinued, description=The immunisation course has been permanently discontinued., comment=null, uncommonOntologyItems=null, occurencesFormal=null, occurencesText=null, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=ISM_TRANSITION, bindings=null, values=Current state: aborted, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/ism_transition[at0009]_532_at0009, code=at0009, itemType=ISM_TRANSITION, level=1, text=Immunisation course completed, description=The immunisation course has been completed., 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]], data=[], credentials=[]}, 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[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], ism_transition=ResourceSimplifiedHierarchyItem [path=ROOT_/ism_transition[at0010], code=at0010, 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=protocol, currentHierarchyItemsForAdding=[ResourceSimplifiedHierarchyItem [path=/protocol[at0013]/items[at0014], code=at0014, itemType=ELEMENT, level=2, text=Medication administration record, description=A link to an associated medication administration record., comment=null, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_EHR_URI, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/protocol[at0013]/items[at0016], code=at0016, itemType=SLOT, level=2, text=Extension, description=Additional information required to capture local context or to align with other reference models/formalisms., comment=e.g. Local hospital departmental infomation or additional metadata to align with HL7 or CDISC 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]