ARCHETYPE nes_vaccination_protocol (openEHR-EHR-CLUSTER.nes_vaccination_protocol.v0)

ARCHETYPE IDopenEHR-EHR-CLUSTER.nes_vaccination_protocol.v0
Conceptnes_vaccination_protocol
DescriptionNDS_Immunisation_Protocol. a small cluster to support recording additional details about immunization events.
UseThis cluster is intended to be used in the 'Protocol' cluster slot of the Medication Management archetype as employed in the NES Vaccination Record template to support the specific internal use cases.
MisuseIt may not be appropriate to use this cluster in other jurisdictions
PurposeThis cluster is to support specific additional details about vaccination events needed by NHS Education Scotland to allow the recording of the protocol aspects of vaccination events and the mapping of data from NES NCDS vaccination database to the NES openEHR CDR
References
Copyright© Apperta Foundation
AuthorsAuthor name: Dr Paul Miller
Organisation: NES Digital Service
Email: paul.miller@nhs.scot
Date originally authored: 2021-11-08
Other Details LanguageAuthor name: Dr Paul Miller
Organisation: NES Digital Service
Email: paul.miller@nhs.scot
Date originally authored: 2021-11-08
OtherDetails Language Independent{licence=This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/., custodian_organisation=Apperta UK, original_namespace=uk.org.clinicalmodels, original_publisher=Apperta UK, custodian_namespace=uk.org.clinicalmodels, MD5-CAM-1.0.1=8FE80186644C6CA75BBCB97B848AA4BB, build_uid=43b53789-85e7-4abf-b127-07b25e022ae8, revision=0.0.1-alpha}
Keywordsvaccine, vaccination, immunise, immunisation, immunization, immunize, booster, dose, stage, course, series
Lifecyclein_development
UID775f9dd8-3e93-4c88-bc6e-30a3c30c5a92
Language useden
Citeable Identifier1051.32.1161
Revision Number0.0.1-alpha
AllArchetype [runtimeNameConstraintForConceptName=null, archetypeConceptBinding=null, archetypeConceptDescription=NDS_Immunisation_Protocol. a small cluster to support recording additional details about immunization events., archetypeConceptComment=null, otherContributors=, originalLanguage=en, translators=, subjectOfData=unconstrained, archetypeTranslationTree=null, topLevelToAshis={content=[], description=[], details=[], source=[], capabilities=[], other_participations=[], protocol=[], provider=[], activities=[], state=[], events=[], ism_transition=[], data=[], target=[], identities=[], items=[ResourceSimplifiedHierarchyItem [path=/items[at0003], code=at0003, itemType=ELEMENT, level=1, text=Series name, description=Local name or description for the immunisation or immunisation course e.g 'Influenza' 'Hepatitis A/B' 'Hepatitis A and Typhoid', 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=/items[at0006], code=at0006, itemType=ELEMENT, level=1, text=Series doses, description=The total number of doses in the series to complete the course., 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=/items[at0007], code=at0007, itemType=ELEMENT, level=1, text=Series doses description, description=A textual description pf the total number of doses in the series to complete the course., 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=/items[at0001], code=at0001, itemType=ELEMENT, level=1, text=Target disease, description=Coded or textual data for the diseases against which the vaccination is intended to confer immunity., 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=/items[at0004], code=at0004, itemType=ELEMENT, level=1, text=Subject agreement to vaccination, description=A textual description of the subject's agreement to be vaccinated. Intended to apply to the event, not the complete course. , 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=/items[at0011], code=at0011, itemType=ELEMENT, level=1, text=Country of vaccination, description=To record the country of vaccination, ideally using a terminology value set., comment=null, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_CODED_TEXT, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/items[at0009], code=at0009, itemType=ELEMENT, level=1, text=Vaccination centre, description=A text element for the name or other description of the vaccination centre where this vaccination record originated., 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=/items[at0010], code=at0010, itemType=SLOT, level=1, text=Vaccination centre details, description=A cluster slot to allow more details of the vaccination centre., comment=null, uncommonOntologyItems=null, occurencesFormal=0..*, occurencesText=Optional, repeating, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=CLUSTER, bindings=null, values=Include:
.* or
openEHR-EHR-CLUSTER.organisation.v0, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/items[at0005], code=at0005, itemType=ELEMENT, level=1, text=Appointment ID, description=The ID of the 'appointment' from a scheduling system which was associated with this vaccination event., comment=null, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_IDENTIFIER, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/items[at0008], code=at0008, itemType=ELEMENT, level=1, text=Trial ID, description=An ID referring to the ID of a research or clinical trial if this vaccination event was associated with any such trial., comment=null, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_IDENTIFIER, bindings=null, values=, extendedValues=null]], relationships=[], credentials=[], context=[], contacts=[]}, topLevelItems={items=ResourceSimplifiedHierarchyItem [path=ROOT_/, code=at0000, itemType=CLUSTER, level=0, text=null, description=null, comment=null, uncommonOntologyItems=null, occurencesFormal=1..1, occurencesText=Mandatory, cardinalityFormal=1..*, cardinalityText=, subCardinalityFormal=null, subCardinalityText=null, dataType=CLUSTER, bindings=null, values=null, extendedValues=null]}, addHierarchyItemsTo=items, currentHierarchyItemsForAdding=[ResourceSimplifiedHierarchyItem [path=/items[at0003], code=at0003, itemType=ELEMENT, level=1, text=Series name, description=Local name or description for the immunisation or immunisation course e.g 'Influenza' 'Hepatitis A/B' 'Hepatitis A and Typhoid', 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=/items[at0006], code=at0006, itemType=ELEMENT, level=1, text=Series doses, description=The total number of doses in the series to complete the course., 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=/items[at0007], code=at0007, itemType=ELEMENT, level=1, text=Series doses description, description=A textual description pf the total number of doses in the series to complete the course., 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=/items[at0001], code=at0001, itemType=ELEMENT, level=1, text=Target disease, description=Coded or textual data for the diseases against which the vaccination is intended to confer immunity., 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=/items[at0004], code=at0004, itemType=ELEMENT, level=1, text=Subject agreement to vaccination, description=A textual description of the subject's agreement to be vaccinated. Intended to apply to the event, not the complete course. , 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=/items[at0011], code=at0011, itemType=ELEMENT, level=1, text=Country of vaccination, description=To record the country of vaccination, ideally using a terminology value set., comment=null, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_CODED_TEXT, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/items[at0009], code=at0009, itemType=ELEMENT, level=1, text=Vaccination centre, description=A text element for the name or other description of the vaccination centre where this vaccination record originated., 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=/items[at0010], code=at0010, itemType=SLOT, level=1, text=Vaccination centre details, description=A cluster slot to allow more details of the vaccination centre., comment=null, uncommonOntologyItems=null, occurencesFormal=0..*, occurencesText=Optional, repeating, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=CLUSTER, bindings=null, values=Include:
.* or
openEHR-EHR-CLUSTER.organisation.v0, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/items[at0005], code=at0005, itemType=ELEMENT, level=1, text=Appointment ID, description=The ID of the 'appointment' from a scheduling system which was associated with this vaccination event., comment=null, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_IDENTIFIER, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/items[at0008], code=at0008, itemType=ELEMENT, level=1, text=Trial ID, description=An ID referring to the ID of a research or clinical trial if this vaccination event was associated with any such trial., comment=null, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_IDENTIFIER, bindings=null, values=, extendedValues=null]], minIndents={}, termBindingRetrievalErrorMessage=null]