ARCHETYPE Service (openEHR-EHR-ACTION.service.v0)

ARCHETYPE IDopenEHR-EHR-ACTION.service.v0
ConceptService
DescriptionA general clinical activity carried out for the patient to receive a specified service, advice or care from an expert healthcare provider.
UseUse to record information about the execution of a request for a health-related service. This is done by recording relevant data against any or all of activities specified in the 'Planned', 'Scheduled', 'Active', 'Suspended', 'Cancelled', 'Postponed', 'Aborted' pathway steps. The scope of this archetype deliberately encompasses activities for a broad range of clinical services. Examples include, but are not limited to: - self-referral by a patient for a check-up visit to a dentist for preventive care or a series of visits to a physiotherapist for management of a musculoskeletal strain; and - a referral from a requesting healthcare provider, such as a primary care clinician, to a receiving healthcare provider, such as a specialist, for the patient to receive a specific service, advice or care. Additional structured and detailed information about the service can be captured using purpose-specific archetypes inserted into the 'Service detail' slot, where required. Timings related to a procedure 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; and - using the archetyped data - the 'Scheduled date/time' data element is intended to record the precise time when the service is planned. Note: the corresponding ACTION time attribute for the Scheduled pathway step will record the time that the service was scheduled into a system, not the intended date/time on which the service is intended to be carried out. In practice, some services (for example, in ambulatory care) will occur once and not be ordered in advance. The details about the service will be added against the pathway step, 'Service completed'. In some cases a recurring service will be ordered, and in this situation data against the 'Service delivered' step will be recorded on each occasion, leaving the instruction in the active state. When the last delivery of the service is recorded, the 'Service completed' action is recorded showing that this order is now in the completed state. In other situations, such as secondary care, there may be a formal order for a procedure using a corresponding INSTRUCTION.request archetype. This ACTION archetype can then be used to record the workflow of when and how the order has been carried out. This archetype may only be used in two ways: - as a full record of the service that was delivered; or - as a framework to record primarily the state of the requested service, with separate OBSERVATION archetypes used to record the actual test results for the delivered service - for example OBSERVATION.hearing_screening_result. Recording information using this ACTION archetype indicates that some sort of activity has actually occurred; this will usually be the service delivery itself but may be a failed attempt or another activity such as postponement of the service delivery. If there is a formal order for the procedure, the state of this order is represented by the Pathway step against which the data is recorded. For example, using this archetype the progressing state of a referral request may be recorded through separate entries in the EHR progress notes at each 'Pathway' step: - record the scheduled Start date/time for the referral (Service scheduled); and - record that the referral has been completed, potentially including information about the service delivered (Service completed). Please note that in the openEHR Reference Model there is a 'Time' attribute, which is intended to record the date and time at which each pathway step of the Action was performed. This is the attribute to use to record the start of the procedure (using the 'Service delivered' pathway step) or the time that the service was aborted (using the 'Service abandoned' pathway step).
MisuseNot to be used to record data about activities carried out for activities that require a purpose built ACTION archetype because they have very specific data recording or pathway step requirements. For example: ACTION.procedure or ACTION.health_education.
PurposeTo record information about the execution of a request for a health-related service.
ReferencesDerived from: Service, Draft archetype [Internet]. Australian Digital Health Agency (NEHTA), ADHA Clinical Knowledge Manager. Authored: 2015 Dec 21. Available at: http://dcm.nehta.org.au/ckm#showArchetype_1013.1.1395_2 (discontinued)
Copyright© openEHR Foundation, Northern Territory Department of Health (Australia)
AuthorsAuthor name: Heather Leslie
Organisation: Atomica Informatics, Australia
Email: heather.leslie@atomicainformatics.com
Date originally authored: 2015-12-21
Other Details LanguageAuthor name: Heather Leslie
Organisation: Atomica Informatics, Australia
Email: heather.leslie@atomicainformatics.com
Date originally authored: 2015-12-21
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=Derived from: Service, Draft archetype [Internet]. Australian Digital Health Agency (NEHTA), ADHA Clinical Knowledge Manager. Authored: 2015 Dec 21. Available at: http://dcm.nehta.org.au/ckm#showArchetype_1013.1.1395_2 (discontinued), current_contact=Heather Leslie, Atomica Informatics, Australia, original_namespace=org.openehr, original_publisher=openEHR Foundation, custodian_namespace=org.openehr, MD5-CAM-1.0.1=7E061EECABAC057F17CABCB1FDBAA7C1, build_uid=36468cbb-24f3-49f5-9248-a4cd1b623e44, revision=0.0.1-alpha}
Keywordsreferral, visit, encounter
Lifecyclein_development
UID43c94233-a17e-4eb4-b205-f1165858897e
Language useden
Citeable Identifier1246.145.840
Revision Number0.0.1-alpha
AllArchetype [runtimeNameConstraintForConceptName=null, archetypeConceptBinding=null, archetypeConceptDescription=A general clinical activity carried out for the patient to receive a specified service, advice or care from an expert healthcare provider., archetypeConceptComment=null, otherContributors=, originalLanguage=en, translators=German: Eva-Maria Rieß, Universitätsmedizin Göttingen, eva-maria.riess@med.uni-goettingen.de
Portuguese (Brazil): Ana Paula Pannuti, Débora Farage, Adriana Kitajima, Fernanda Maia e Clóvis Puttini., Core Consulting, ana.andrade@coreconsulting.com.br
, subjectOfData=unconstrained, archetypeTranslationTree=null, topLevelToAshis={relationships=[], identities=[], provider=[], content=[], events=[], data=[], credentials=[], capabilities=[], target=[], items=[], protocol=[ResourceSimplifiedHierarchyItem [path=/protocol[at0015]/items[at0016], code=at0016, itemType=ELEMENT, level=2, text=Requestor identifier, description=The local ID assigned to the order by the healthcare provider or organisation requesting the service. This is also referred to as Placer Order Identifier., 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=/protocol[at0015]/items[at0017], code=at0017, itemType=SLOT, level=2, text=Requestor, description=Details about the healthcare provider or organisation requesting the service., 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=/protocol[at0015]/items[at0018], code=at0018, itemType=ELEMENT, level=2, text=Receiver identifier, description=The ID assigned to the order by the healthcare provider or organisation receiving the request for referral. This is also referred to as Filler Order Identifier., 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=/protocol[at0015]/items[at0019], code=at0019, itemType=SLOT, level=2, text=Receiver, description=Details about the healthcare provider or organisation receiving the request for referral., 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]], ism_transition=[ResourceSimplifiedHierarchyItem [path=/ism_transition[at0002]_526_at0002, code=at0002, itemType=ISM_TRANSITION, level=1, text=Service planned, description=Service request to healthcare provider is planned., 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]_526_at0026, code=at0026, itemType=ISM_TRANSITION, level=1, text=Service request sent, description=Request for service sent., 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[at0008]_527_at0008, code=at0008, itemType=ISM_TRANSITION, level=1, text=Service postponed, description=The planned service has been postponed., 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[at0009]_528_at0009, code=at0009, itemType=ISM_TRANSITION, level=1, text=Service cancelled, description=The planned service has been cancelled prior to commencement., 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[at0003]_529_at0003, code=at0003, itemType=ISM_TRANSITION, level=1, text=Service scheduled, description=Appointment for a healthcare provider service has been made., 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[at0004]_245_at0004, code=at0004, itemType=ISM_TRANSITION, level=1, text=Service delivered, description=The healthcare provider has delivered the service., 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[at0010]_530_at0010, code=at0010, itemType=ISM_TRANSITION, level=1, text=Service suspended, description=The service has been suspended without completion., 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[at0006]_531_at0006, code=at0006, itemType=ISM_TRANSITION, level=1, text=Service abandoned, description=The referral has been ceased before the service 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: aborted, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/ism_transition[at0023]_531_at0023, code=at0023, itemType=ISM_TRANSITION, level=1, text=Service expired, description=The referral has expired before the referral episode 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: aborted, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/ism_transition[at0005]_532_at0005, code=at0005, itemType=ISM_TRANSITION, level=1, text=Service activity complete, description=All service activities have 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]], contacts=[], activities=[], context=[], other_participations=[], state=[], details=[], description=[ResourceSimplifiedHierarchyItem [path=/description[at0001]/items[at0011], code=at0011, itemType=ELEMENT, level=2, text=Service name, description=Identification of the clinical service to be/being carried out., comment=Coding of the specific service name 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[at0014], code=at0014, itemType=ELEMENT, level=2, text=Service type, description=Type of service to be carried out or being 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], ResourceSimplifiedHierarchyItem [path=/description[at0001]/items[at0013], code=at0013, itemType=ELEMENT, level=2, text=Description, description=Narrative description about the service, as appropriate for 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[at0027], code=at0027, itemType=SLOT, level=2, text=Service detail, description=Structured information about the service., comment=Use to capture detailed, structured information about specified aspects of the service., 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[at0025], code=at0025, itemType=ELEMENT, level=2, text=Scheduled date/time, description=The date and/or time on which the service is intended to be performed., comment=Only for use in association with the 'Service scheduled' pathway step., 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[at0021], code=at0021, itemType=ELEMENT, level=2, text=Sequence, description=The sequence of the specified clinical service., comment=Only for use in association with the 'Service delivered' pathway step. For example: record that this is the 3rd physiotherapy appointment in a planned sequence., uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_COUNT, bindings=null, values=min: >=0

, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/description[at0001]/items[at0029], code=at0029, itemType=SLOT, level=2, text=Multimedia, description=Mulitimedia representation of a performed service., 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.multimedia.v1 and specialisations, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/description[at0001]/items[at0012], code=at0012, itemType=ELEMENT, level=2, text=Reason, description=Reason that the activity or care pathway step for the identified service was carried out., comment=For example: the reason for the cancellation or suspension of the service., 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[at0028], code=at0028, itemType=ELEMENT, level=2, text=Comment, description=Additional narrative about the activity or care pathway step 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]], source=[]}, 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=1..1, cardinalityText=mandatory, subCardinalityFormal=0..*, subCardinalityText=Minimum of 0 items, dataType=ITEM_TREE, bindings=null, values=null, extendedValues=null], protocol=ResourceSimplifiedHierarchyItem [path=ROOT_/protocol[at0015], code=at0015, itemType=ITEM_TREE, level=0, text=null, description=null, comment=null, uncommonOntologyItems=null, occurencesFormal=1..1, occurencesText=Mandatory, cardinalityFormal=1..1, cardinalityText=mandatory, subCardinalityFormal=0..*, subCardinalityText=Minimum of 0 items, dataType=ITEM_TREE, bindings=null, values=null, extendedValues=null], ism_transition=ResourceSimplifiedHierarchyItem [path=ROOT_/ism_transition[at0002], code=at0002, itemType=ISM_TRANSITION, level=0, text=null, description=null, comment=null, uncommonOntologyItems=null, occurencesFormal=null, occurencesText=null, cardinalityFormal=1..1, cardinalityText=mandatory, subCardinalityFormal=null, subCardinalityText=null, dataType=ISM_TRANSITION, bindings=null, values=null, extendedValues=null]}, addHierarchyItemsTo=protocol, currentHierarchyItemsForAdding=[ResourceSimplifiedHierarchyItem [path=/protocol[at0015]/items[at0016], code=at0016, itemType=ELEMENT, level=2, text=Requestor identifier, description=The local ID assigned to the order by the healthcare provider or organisation requesting the service. This is also referred to as Placer Order Identifier., 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=/protocol[at0015]/items[at0017], code=at0017, itemType=SLOT, level=2, text=Requestor, description=Details about the healthcare provider or organisation requesting the service., 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=/protocol[at0015]/items[at0018], code=at0018, itemType=ELEMENT, level=2, text=Receiver identifier, description=The ID assigned to the order by the healthcare provider or organisation receiving the request for referral. This is also referred to as Filler Order Identifier., 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=/protocol[at0015]/items[at0019], code=at0019, itemType=SLOT, level=2, text=Receiver, description=Details about the healthcare provider or organisation receiving the request for referral., 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]], minIndents={}, termBindingRetrievalErrorMessage=null]