ARCHETYPE Appointment (openEHR-EHR-ADMIN_ENTRY.appointment.v0)

Name: Appointment
License: http://creativecommons.org/licenses/by-sa/3.0/

ARCHETYPE ID	openEHR-EHR-ADMIN_ENTRY.appointment.v0
Concept	Appointment
Description	A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. Closely related to FHIR Apointment resource.
Use	From HL7 FHIR documentation: 'Appointment resources are used to provide information about a planned meeting that may be in the future or past. The resource only describes a single meeting, a series of repeating visits would require multiple appointment resources be created for each instance. Examples include a scheduled surgery, a follow-up for a clinical visit, a scheduled conference call between clinicians to discuss a case, the reservation of a piece of diagnostic equipment for a particular use, etc. The visit scheduled by an appointment may be in person or remote (by phone, video conference, etc.) All that matters is that the time and usage of one or more individuals, locations and/or pieces of equipment is being fully or partially reserved for a designated period of time.'
Purpose	To record booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time.
References	HL7 FHIR Appointment resource, http://hl7.org/fhir/appointment.html
Copyright	© Clinical Models UK
Authors	Author name: Ian McNicoll Organisation: freshEHR Clinical Informatics Ltd. Email: ian@freshehr.com Date originally authored: 2016-04-19
Other Details Language	Author name: Ian McNicoll Organisation: freshEHR Clinical Informatics Ltd. Email: ian@freshehr.com Date originally authored: 2016-04-19
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, references=HL7 FHIR Appointment resource, http://hl7.org/fhir/appointment.html, original_namespace=uk.org.clinicalmodels, original_publisher=UK Clinical Models, custodian_namespace=uk.org.clinicalmodels, MD5-CAM-1.0.1=61B2E9511F5E0A1405F12E8393042208, build_uid=bb2866ae-eff9-4427-b92c-8ac761373ef1, revision=0.0.1-alpha}
Keywords	booking
Lifecycle	in_development
UID	9d6dc4cf-b7fd-4de1-91f4-18ad36dc0d72
Language used	en
Citeable Identifier	1051.32.819
Revision Number	0.0.1-alpha
All	Archetype [runtimeNameConstraintForConceptName=null, archetypeConceptBinding=null, archetypeConceptDescription=A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. Closely related to FHIR Apointment resource., 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=[ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0027], code=at0027, itemType=ELEMENT, level=2, text=Identifier, description=External identifier for this appointment., comment=null, uncommonOntologyItems=null, occurencesFormal=0.., occurencesText=Optional, repeating, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_IDENTIFIER, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0002], code=at0002, itemType=ELEMENT, level=2, text=Status, description=The status of the appointment., comment=null, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_CODED_TEXT, bindings=null, values= at0003::Proposed [None of the participant(s) have finalized their acceptance of the appointment request, and the start/end time may not be set yet.] at0004::Pending [Some or all of the participant(s) have not finalized their acceptance of the appointment request.] at0005::Booked [All participant(s) have been considered and the appointment is confirmed to go ahead at the date/times specified.] at0006::Arrived [The patient has arrived.] at0007::Fulfilled [This appointment has completed and may have resulted in an encounter.] at0008::Cancelled [The appointment has been cancelled.] at0009::No show [Some or all of the participant(s) have not/did not appear for the appointment (usually the patient).] , extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0010], code=at0010, itemType=ELEMENT, level=2, text=Type, description=The type of appointment (usually the speciality or service)., comment=In FHIR this is defined as "This is the code representing the clinical specialty of the clinician or provider who interacted with, treated, or provided a service to/for the patient. The value set used for clinical specialty has been limited by HITSP to the value set reproduced from HITSP C80 Table 2-149 Clinical Specialty Value Set Definition." but may not be valid in non-US jurisdictions, and is therefore left unconstrained in this archetype., 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[at0011], code=at0011, itemType=ELEMENT, level=2, text=Reason, description=The reason this appointment is scheduled., 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[at0012], code=at0012, itemType=ELEMENT, level=2, text=Priority, description=The priority level of this appointment., comment=Used to make informed decisions if needing to re-prioritize, 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=/data[at0001]/items[at0013], code=at0013, itemType=ELEMENT, level=2, text=Description, description=A high-level description of the reason for the appoinment, comment=As might be displayed on a subject line in a meeting request, or appointment list., 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[at0014], code=at0014, itemType=ELEMENT, level=2, text=Start time, description=When appointment is to take place., 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[at0015], code=at0015, itemType=ELEMENT, level=2, text=End time, description=When appointment is to conclude., 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[at0016], code=at0016, itemType=ELEMENT, level=2, text=Duration, description=The actual or expected duration of the appointment., comment=null, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_DURATION, bindings=null, values=Allowed values:* minutes >=0 minutes , extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0028], code=at0028, itemType=SLOT, level=2, text=Original instruction, description=Reference to the original instruction., comment=null, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=CLUSTER, bindings=null, values=Include: All not explicitly excluded archetypes, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0017], code=at0017, itemType=ELEMENT, level=2, text=Comment, description=Additional comments., 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[at0018], code=at0018, itemType=CLUSTER, level=2, text=Participant, description=Details of intended participants, including patient, practitioners, devices or other resources., comment=null, uncommonOntologyItems=null, occurencesFormal=0.., occurencesText=Optional, repeating, cardinalityFormal=1.., cardinalityText= (Cardinality: 1.., unordered), subCardinalityFormal=null, subCardinalityText=null, dataType=CLUSTER, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0018]/items[at0021], code=at0021, itemType=ELEMENT, level=3, text=Party, description=The person, team, device or other party requested to participate in the appointment., comment=null, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=CHOICE, bindings=null, values=Choice of:* Text Identifier , extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0018]/items[at0022], code=at0022, itemType=SLOT, level=3, text=Party details, description=Details of a participant, 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=/data[at0001]/items[at0018]/items[at0020], code=at0020, itemType=ELEMENT, level=3, text=Role, description=The role of the party in the appointment., 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[at0018]/items[at0019], code=at0019, itemType=ELEMENT, level=3, text=Required, description=Whether the participant is required for the appointment., comment=(Appointment is about them, not for them - such as 2 doctors discussing results about a patient's test)., uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_CODED_TEXT, bindings=null, values= at0023::Required [The participant is required to attend the appointment.] at0024::Optional [The participant may optionally attend the appointment.] at0025::Information only [The participant is excluded from the appointment, and may not be informed of the appointment taking place. ] , extendedValues=null]], target=[], identities=[], items=[], relationships=[], credentials=[], context=[], contacts=[]}, topLevelItems={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=0.., subCardinalityText=Minimum of 0 items (Cardinality: 0.., unordered), dataType=ITEM_TREE, bindings=null, values=null, extendedValues=null]}, addHierarchyItemsTo=data, currentHierarchyItemsForAdding=[ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0027], code=at0027, itemType=ELEMENT, level=2, text=Identifier, description=External identifier for this appointment., comment=null, uncommonOntologyItems=null, occurencesFormal=0.., occurencesText=Optional, repeating, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_IDENTIFIER, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0002], code=at0002, itemType=ELEMENT, level=2, text=Status, description=The status of the appointment., comment=null, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_CODED_TEXT, bindings=null, values= at0003::Proposed [None of the participant(s) have finalized their acceptance of the appointment request, and the start/end time may not be set yet.] at0004::Pending [Some or all of the participant(s) have not finalized their acceptance of the appointment request.] at0005::Booked [All participant(s) have been considered and the appointment is confirmed to go ahead at the date/times specified.] at0006::Arrived [The patient has arrived.] at0007::Fulfilled [This appointment has completed and may have resulted in an encounter.] at0008::Cancelled [The appointment has been cancelled.] at0009::No show [Some or all of the participant(s) have not/did not appear for the appointment (usually the patient).] , extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0010], code=at0010, itemType=ELEMENT, level=2, text=Type, description=The type of appointment (usually the speciality or service)., comment=In FHIR this is defined as "This is the code representing the clinical specialty of the clinician or provider who interacted with, treated, or provided a service to/for the patient. The value set used for clinical specialty has been limited by HITSP to the value set reproduced from HITSP C80 Table 2-149 Clinical Specialty Value Set Definition." but may not be valid in non-US jurisdictions, and is therefore left unconstrained in this archetype., 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[at0011], code=at0011, itemType=ELEMENT, level=2, text=Reason, description=The reason this appointment is scheduled., 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[at0012], code=at0012, itemType=ELEMENT, level=2, text=Priority, description=The priority level of this appointment., comment=Used to make informed decisions if needing to re-prioritize, 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=/data[at0001]/items[at0013], code=at0013, itemType=ELEMENT, level=2, text=Description, description=A high-level description of the reason for the appoinment, comment=As might be displayed on a subject line in a meeting request, or appointment list., 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[at0014], code=at0014, itemType=ELEMENT, level=2, text=Start time, description=When appointment is to take place., 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[at0015], code=at0015, itemType=ELEMENT, level=2, text=End time, description=When appointment is to conclude., 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[at0016], code=at0016, itemType=ELEMENT, level=2, text=Duration, description=The actual or expected duration of the appointment., comment=null, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_DURATION, bindings=null, values=Allowed values:* minutes >=0 minutes , extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0028], code=at0028, itemType=SLOT, level=2, text=Original instruction, description=Reference to the original instruction., comment=null, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=CLUSTER, bindings=null, values=Include: All not explicitly excluded archetypes, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0017], code=at0017, itemType=ELEMENT, level=2, text=Comment, description=Additional comments., 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[at0018], code=at0018, itemType=CLUSTER, level=2, text=Participant, description=Details of intended participants, including patient, practitioners, devices or other resources., comment=null, uncommonOntologyItems=null, occurencesFormal=0.., occurencesText=Optional, repeating, cardinalityFormal=1.., cardinalityText= (Cardinality: 1.., unordered), subCardinalityFormal=null, subCardinalityText=null, dataType=CLUSTER, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0018]/items[at0021], code=at0021, itemType=ELEMENT, level=3, text=Party, description=The person, team, device or other party requested to participate in the appointment., comment=null, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=CHOICE, bindings=null, values=Choice of:* Text Identifier , extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0018]/items[at0022], code=at0022, itemType=SLOT, level=3, text=Party details, description=Details of a participant, 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=/data[at0001]/items[at0018]/items[at0020], code=at0020, itemType=ELEMENT, level=3, text=Role, description=The role of the party in the appointment., 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[at0018]/items[at0019], code=at0019, itemType=ELEMENT, level=3, text=Required, description=Whether the participant is required for the appointment., comment=(Appointment is about them, not for them - such as 2 doctors discussing results about a patient's test)., uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_CODED_TEXT, bindings=null, values= at0023::Required [The participant is required to attend the appointment.] at0024::Optional [The participant may optionally attend the appointment.] at0025::Information only [The participant is excluded from the appointment, and may not be informed of the appointment taking place. ] , extendedValues=null]], minIndents={}, termBindingRetrievalErrorMessage=null]