<status value="draft" /> <date value="2021-04-19T17:55:53.6744615+00:00" /> <publisher value="OMD" /> <contact> <telecom> <system value="url" /> <value value="http://hl7.org/fhir" /> </telecom> </contact> <contact> <telecom> <system value="url" /> <value value="http://www.hl7.org/Special/committees/pafm/index.cfm" /> </telecom> </contact> <description value="A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)." /> <fhirVersion value="4.0.1" /> <mapping> <identity value="CDSS5.1" /> <uri value="www.ontariomd.com" /> <name value="CDS-S 5.1" /> </mapping> <kind value="resource" /> <abstract value="false" /> <type value="Appointment" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/DomainResource" /> <derivation value="specialization" /> <differential> <element id="Appointment"> <path value="Appointment" /> <short value="A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)" /> <definition value="A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)." /> <constraint> <key value="app-4" /> <severity value="error" /> <human value="Cancelation reason is only used for appointments that have been cancelled, or no-show" /> <expression value="Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')" /> <xpath value="not(exists(f:cancellationReason)) or f:status/@value=('no-show', 'cancelled')" /> <source value="http://hl7.org/fhir/StructureDefinition/Appointment" /> </constraint> <constraint> <key value="app-3" /> <severity value="error" /> <human value="Only proposed or cancelled appointments can be missing start/end dates" /> <expression value="(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))" /> <xpath value="((exists(f:start) and exists(f:end)) or (f:status/@value='proposed') or (f:status/@value='cancelled') or (f:status/@value='waitlist'))" /> <source value="http://hl7.org/fhir/StructureDefinition/Appointment" /> </constraint> <constraint> <key value="app-2" /> <severity value="error" /> <human value="Either start and end are specified, or neither" /> <expression value="start.exists() = end.exists()" /> <xpath value="((exists(f:start) and exists(f:end)) or (not(exists(f:start)) and not(exists(f:end))))" /> <source value="http://hl7.org/fhir/StructureDefinition/Appointment" /> </constraint> <mapping> <identity value="workflow" /> <map value="Request" /> </mapping> <mapping> <identity value="rim" /> <map value="Act[@moodCode <= 'INT']" /> </mapping> <mapping> <identity value="ical" /> <map value="VEVENT" /> </mapping> </element> <element id="Appointment.identifier"> <path value="Appointment.identifier" /> <short value="External Ids for this item" /> <definition value="This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)." /> <type> <code value="Identifier" /> </type> <isSummary value="true" /> <mapping> <identity value="workflow" /> <map value="Request.identifier" /> </mapping> <mapping> <identity value="w5" /> <map value="FiveWs.identifier" /> </mapping> <mapping> <identity value="v2" /> <map value="SCH-1, SCH-2, ARQ-1, ARQ-2" /> </mapping> <mapping> <identity value="rim" /> <map value=".id" /> </mapping> <mapping> <identity value="ical" /> <map value="UID" /> </mapping> </element> <element id="Appointment.status"> <path value="Appointment.status" /> <short value="proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist" /> <definition value="BASE RESOURCE DEFINITION: The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status. CDS-S PROFILE DEFINITION: Status of the appointment (e.g., Confirmed, Cancelled, No-Show)." /> <comment value="If the Appointment's status is "cancelled" then all participants are expected to have their calendars released for the appointment period, and as such any Slots that were marked as BUSY can be re-set to FREE. This element is labeled as a modifier because the status contains the code entered-in-error that mark the Appointment as not currently valid." /> <min value="1" /> <max value="1" /> <type> <code value="code" /> </type> <mustSupport value="true" /> <isModifier value="true" /> <isModifierReason value="This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid" /> <isSummary value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="AppointmentStatus" /> </extension> <strength value="required" /> <description value="The free/busy status of an appointment." /> <valueSet value="http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.0" /> </binding> <mapping> <identity value="workflow" /> <map value="Request.status" /> </mapping> <mapping> <identity value="w5" /> <map value="FiveWs.status" /> </mapping> <mapping> <identity value="v2" /> <map value="SCH-25" /> </mapping> <mapping> <identity value="rim" /> <map value=".statusCode" /> </mapping> <mapping> <identity value="ical" /> <map value="STATUS" /> </mapping> <mapping> <identity value="CDSS5.1" /> <map value="DE15.003" /> <comment value="Appointment Status" /> </mapping> </element> <element id="Appointment.cancelationReason"> <path value="Appointment.cancelationReason" /> <short value="The coded reason for the appointment being cancelled" /> <definition value="The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply." /> <max value="1" /> <type> <code value="CodeableConcept" /> </type> <isSummary value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="cancelation-reason" /> </extension> <strength value="example" /> <valueSet value="http://hl7.org/fhir/ValueSet/appointment-cancellation-reason" /> </binding> </element> <element id="Appointment.serviceCategory"> <path value="Appointment.serviceCategory" /> <short value="A broad categorization of the service that is to be performed during this appointment" /> <definition value="A broad categorization of the service that is to be performed during this appointment." /> <comment value="BASE RESOURCE DEFINITION: Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. CDS-S PROFILE DEFINITION: The purpose or reason for the patient visit (e.g., Diabetes, Pre-natal, Annual Checkup)." /> <type> <code value="CodeableConcept" /> </type> <mustSupport value="true" /> <isSummary value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="service-category" /> </extension> <strength value="example" /> <valueSet value="http://hl7.org/fhir/ValueSet/service-category" /> </binding> <mapping> <identity value="rim" /> <map value="n/a, might be inferred from the ServiceDeliveryLocation" /> </mapping> <mapping> <identity value="ical" /> <map value="CATEGORIES" /> </mapping> <mapping> <identity value="CDSS5.1" /> <map value="DE15.004" /> <comment value="Appointment Purpose" /> </mapping> </element> <element id="Appointment.serviceType"> <path value="Appointment.serviceType" /> <short value="The specific service that is to be performed during this appointment" /> <definition value="The specific service that is to be performed during this appointment." /> <comment value="For a provider to provider appointment the code "FOLLOWUP" may be appropriate, as this is expected to be discussing some patient that was seen in the past." /> <type> <code value="CodeableConcept" /> </type> <isSummary value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="service-type" /> </extension> <strength value="example" /> <valueSet value="http://hl7.org/fhir/ValueSet/service-type" /> </binding> <mapping> <identity value="workflow" /> <map value="Request.code" /> </mapping> <mapping> <identity value="rim" /> <map value="n/a, might be inferred from the ServiceDeliveryLocation" /> </mapping> </element> <element id="Appointment.specialty"> <path value="Appointment.specialty" /> <short value="The specialty of a practitioner that would be required to perform the service requested in this appointment" /> <definition value="The specialty of a practitioner that would be required to perform the service requested in this appointment." /> <type> <code value="CodeableConcept" /> </type> <isSummary value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="specialty" /> </extension> <strength value="preferred" /> <valueSet value="http://hl7.org/fhir/ValueSet/c80-practice-codes" /> </binding> <mapping> <identity value="w5" /> <map value="FiveWs.class" /> </mapping> <mapping> <identity value="rim" /> <map value=".performer.AssignedPerson.code" /> </mapping> </element> <element id="Appointment.appointmentType"> <path value="Appointment.appointmentType" /> <short value="The style of appointment or patient that has been booked in the slot (not service type)" /> <definition value="The style of appointment or patient that has been booked in the slot (not service type)." /> <max value="1" /> <type> <code value="CodeableConcept" /> </type> <isSummary value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="appointment-type" /> </extension> <strength value="preferred" /> <valueSet value="http://terminology.hl7.org/ValueSet/v2-0276" /> </binding> <mapping> <identity value="v2" /> <map value="ARQ-7" /> </mapping> <mapping> <identity value="rim" /> <map value=".code" /> </mapping> <mapping> <identity value="ical" /> <map value="CLASSIFICATION" /> </mapping> </element> <element id="Appointment.reasonCode"> <path value="Appointment.reasonCode" /> <short value="Coded reason this appointment is scheduled" /> <definition value="The coded reason that this appointment is being scheduled. This is more clinical than administrative." /> <type> <code value="CodeableConcept" /> </type> <isSummary value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ApptReason" /> </extension> <strength value="preferred" /> <description value="The Reason for the appointment to take place." /> <valueSet value="http://hl7.org/fhir/ValueSet/encounter-reason" /> </binding> <mapping> <identity value="workflow" /> <map value="Request.reasonCode" /> </mapping> <mapping> <identity value="v2" /> <map value="AIS-3, SCH-7" /> </mapping> <mapping> <identity value="rim" /> <map value=".reasonCode" /> </mapping> </element> <element id="Appointment.reasonReference"> <path value="Appointment.reasonReference" /> <short value="Reason the appointment is to take place (resource)" /> <definition value="Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure." /> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Condition" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Procedure" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Observation" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation" /> </type> <mapping> <identity value="workflow" /> <map value="Request.reasonReference" /> </mapping> <mapping> <identity value="rim" /> <map value=".inboundRelationship[@typeCode = 'RSON'].observation" /> </mapping> </element> <element id="Appointment.priority"> <path value="Appointment.priority" /> <short value="Used to make informed decisions if needing to re-prioritize" /> <definition value="The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority)." /> <comment value="Seeking implementer feedback on this property and how interoperable it is. Using an extension to record a CodeableConcept for named values may be tested at a future connectathon." /> <max value="1" /> <type> <code value="unsignedInt" /> </type> <mapping> <identity value="workflow" /> <map value="Request.priority" /> </mapping> <mapping> <identity value="w5" /> <map value="FiveWs.class" /> </mapping> <mapping> <identity value="v2" /> <map value="ARQ-12, SCH-11.6 / TQ1-9" /> </mapping> <mapping> <identity value="rim" /> <map value=".priorityCode" /> </mapping> <mapping> <identity value="ical" /> <map value="PRIORITY" /> </mapping> </element> <element id="Appointment.description"> <path value="Appointment.description" /> <short value="Shown on a subject line in a meeting request, or appointment list" /> <definition value="The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field." /> <max value="1" /> <type> <code value="string" /> </type> <mapping> <identity value="v2" /> <map value="NTE-3" /> </mapping> <mapping> <identity value="rim" /> <map value=".text" /> </mapping> <mapping> <identity value="ical" /> <map value="SUMMARY" /> </mapping> </element> <element id="Appointment.supportingInformation"> <path value="Appointment.supportingInformation" /> <short value="Additional information to support the appointment" /> <definition value="Additional information to support the appointment provided when making the appointment." /> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Resource" /> </type> <mapping> <identity value="workflow" /> <map value="Request.supportingInfo" /> </mapping> <mapping> <identity value="w5" /> <map value="FiveWs.context" /> </mapping> <mapping> <identity value="rim" /> <map value=".inboundRelationship[@typeCode = 'SPRT'].observation" /> </mapping> <mapping> <identity value="ical" /> <map value="ATTACH" /> </mapping> </element> <element id="Appointment.start"> <path value="Appointment.start" /> <short value="When appointment is to take place" /> <definition value="BASE RESOURCE DEFINITION: Date/Time that the appointment is to take place. CDS-S PROFILE DEFINITION: Date/Time of the scheduled appointment." /> <max value="1" /> <type> <code value="instant" /> </type> <mustSupport value="true" /> <isSummary value="true" /> <mapping> <identity value="workflow" /> <map value="Request.occurrence[x]" /> </mapping> <mapping> <identity value="w5" /> <map value="FiveWs.init" /> </mapping> <mapping> <identity value="v2" /> <map value="ARQ-11.1, SCH-11.4 / TQ1-7" /> </mapping> <mapping> <identity value="rim" /> <map value=".effectiveTime.low" /> </mapping> <mapping> <identity value="ical" /> <map value="DTSTART" /> </mapping> <mapping> <identity value="CDSS5.1" /> <map value="DE15.001" /> <comment value="Appointment Date/Time" /> </mapping> </element> <element id="Appointment.end"> <path value="Appointment.end" /> <short value="When appointment is to conclude" /> <definition value="BASE RESOURCE DEFINITION: Date/Time that the appointment is to conclude. CDS-S PROFILE DEFINITION: Date/Time of the scheduled appointment." /> <max value="1" /> <type> <code value="instant" /> </type> <mustSupport value="true" /> <isSummary value="true" /> <mapping> <identity value="workflow" /> <map value="Request.occurrence[x]" /> </mapping> <mapping> <identity value="w5" /> <map value="FiveWs.done[x]" /> </mapping> <mapping> <identity value="v2" /> <map value="SCH-11.5 / TQ1-8/ calculated based on the start and the duration which is in ARQ-9" /> </mapping> <mapping> <identity value="rim" /> <map value=".effectiveTime.high" /> </mapping> <mapping> <identity value="ical" /> <map value="DTEND" /> </mapping> <mapping> <identity value="CDSS5.1" /> <map value="DE15.001" /> <comment value="Appointment Date/Time" /> </mapping> </element> <element id="Appointment.minutesDuration"> <path value="Appointment.minutesDuration" /> <short value="Can be less than start/end (e.g. estimate)" /> <definition value="BASE RESOURCE DEFINITION: Number of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end. CDS-S PROFILE DEFINITION: Length of the appointment in minutes." /> <max value="1" /> <type> <code value="positiveInt" /> </type> <mustSupport value="true" /> <mapping> <identity value="workflow" /> <map value="Request.occurrence[x]" /> </mapping> <mapping> <identity value="rim" /> <map value=".activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')].width" /> </mapping> <mapping> <identity value="ical" /> <map value="DURATION (e.g. PT15M)" /> </mapping> <mapping> <identity value="CDSS5.1" /> <map value="DE15.002" /> <comment value="Appointment Duration" /> </mapping> </element> <element id="Appointment.slot"> <path value="Appointment.slot" /> <short value="The slots that this appointment is filling" /> <definition value="The slots from the participants' schedules that will be filled by the appointment." /> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Slot" /> </type> <mapping> <identity value="rim" /> <map value=".outboundRelationship[@typeCode = 'REFR'].act[@classCode = 'ACT'][@moodCode = 'SLOT']" /> </mapping> </element> <element id="Appointment.created"> <path value="Appointment.created" /> <short value="The date that this appointment was initially created" /> <definition value="The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment." /> <comment value="This property is required for many use cases where the age of an appointment is considered in processing workflows for scheduling and billing of appointments." /> <max value="1" /> <type> <code value="dateTime" /> </type> <mapping> <identity value="workflow" /> <map value="Request.authoredOn" /> </mapping> <mapping> <identity value="rim" /> <map value=".author.time" /> </mapping> <mapping> <identity value="ical" /> <map value="CREATED" /> </mapping> </element> <element id="Appointment.comment"> <path value="Appointment.comment" /> <short value="Additional comments" /> <definition value="Additional comments about the appointment." /> <comment value="Additional text to aid in facilitating the appointment. For instance, a comment might be, "patient should proceed immediately to infusion room upon arrival" Where this is a planned appointment and the start/end dates are not set then this field can be used to provide additional guidance on the details of the appointment request, including any restrictions on when to book it." /> <max value="1" /> <type> <code value="string" /> </type> <mapping> <identity value="workflow" /> <map value="Request.note" /> </mapping> <mapping> <identity value="v2" /> <map value="NTE-3" /> </mapping> <mapping> <identity value="rim" /> <map value=".subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value" /> </mapping> <mapping> <identity value="ical" /> <map value="DESCRIPTION (for internal use)" /> </mapping> </element> <element id="Appointment.patientInstruction"> <path value="Appointment.patientInstruction" /> <short value="Detailed information and instructions for the patient" /> <definition value="While Appointment.comment contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before)." /> <max value="1" /> <type> <code value="string" /> </type> <mapping> <identity value="v2" /> <map value="NTE-3" /> </mapping> <mapping> <identity value="rim" /> <map value=".subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value" /> </mapping> <mapping> <identity value="ical" /> <map value="DESCRIPTION (for patient use)" /> </mapping> </element> <element id="Appointment.basedOn"> <path value="Appointment.basedOn" /> <short value="The service request this appointment is allocated to assess" /> <definition value="The service request this appointment is allocated to assess (e.g. incoming referral or procedure request)." /> <alias value="incomingReferral" /> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/ServiceRequest" /> </type> <mapping> <identity value="workflow" /> <map value="Request.basedOn" /> </mapping> <mapping> <identity value="rim" /> <map value=".outboundRelationship[@typeCode = 'FLFS'].act[@classCode < 'ActCareProvisionRequestType'][@moodCode = 'RQO']" /> </mapping> </element> <element id="Appointment.participant"> <path value="Appointment.participant" /> <short value="Participants involved in appointment" /> <definition value="List of participants involved in the appointment." /> <min value="1" /> <type> <code value="BackboneElement" /> </type> <constraint> <key value="app-1" /> <severity value="error" /> <human value="Either the type or actor on the participant SHALL be specified" /> <expression value="type.exists() or actor.exists()" /> <xpath value="(exists(f:type) or exists(f:actor))" /> <source value="http://hl7.org/fhir/StructureDefinition/Appointment" /> </constraint> <mapping> <identity value="workflow" /> <map value="Request.performer, Request.subject" /> </mapping> <mapping> <identity value="v2" /> <map value="PID, AIP, AIG, AIL" /> </mapping> <mapping> <identity value="rim" /> <map value="performer | reusableDevice | subject | location" /> </mapping> <mapping> <identity value="ical" /> <map value="ATTENDEE component to be created" /> </mapping> </element> <element id="Appointment.participant.type"> <path value="Appointment.participant.type" /> <short value="Role of participant in the appointment" /> <definition value="Role of participant in the appointment." /> <comment value="The role of the participant can be used to declare what the actor will be doing in the scope of this appointment. If the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning. This value SHALL be the same when creating an AppointmentResponse so that they can be matched, and subsequently update the Appointment." /> <type> <code value="CodeableConcept" /> </type> <isSummary value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ParticipantType" /> </extension> <strength value="extensible" /> <description value="Role of participant in encounter." /> <valueSet value="http://hl7.org/fhir/ValueSet/encounter-participant-type" /> </binding> <mapping> <identity value="v2" /> <map value="AIP-4, AIG-4" /> </mapping> <mapping> <identity value="rim" /> <map value="(performer | reusableDevice | subject | location).@typeCode" /> </mapping> <mapping> <identity value="ical" /> <map value="n/a" /> </mapping> </element> <element id="Appointment.participant.actor"> <path value="Appointment.participant.actor" /> <short value="Person, Location/HealthcareService or Device" /> <definition value="BASE RESOURCE DEFINITION: A Person, Location/HealthcareService or Device that is participating in the appointment. CDS-S PROFILE DEFINITION: The identity of the provider with whom the patient is scheduled to have or had a visit." /> <max value="1" /> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/PractitionerRole" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Device" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/HealthcareService" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Location" /> </type> <mustSupport value="true" /> <isSummary value="true" /> <mapping> <identity value="w5" /> <map value="FiveWs.who" /> </mapping> <mapping> <identity value="v2" /> <map value="PID-3-Patient ID List | AIL-3 | AIG-3 | AIP-3" /> </mapping> <mapping> <identity value="rim" /> <map value="performer.person | reusableDevice.manufacturedDevice | subject.patient | location.serviceDeliveryLocation" /> </mapping> <mapping> <identity value="ical" /> <map value="ATTENDEE: (Need to provide the common name CN and also the MAILTO properties from the practitioner resource) where the participant type is not "information-only"" /> </mapping> <mapping> <identity value="CDSS5.1" /> <map value="DE15.006" /> <comment value="Appointment - Provider Identity" /> </mapping> </element> <element id="Appointment.participant.required"> <path value="Appointment.participant.required" /> <short value="required | optional | information-only" /> <definition value="Whether this participant is required to be present at the meeting. This covers a use-case where two doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present." /> <max value="1" /> <type> <code value="code" /> </type> <isSummary value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ParticipantRequired" /> </extension> <strength value="required" /> <description value="Is the Participant required to attend the appointment." /> <valueSet value="http://hl7.org/fhir/ValueSet/participantrequired|4.0.0" /> </binding> <mapping> <identity value="rim" /> <map value="(performer | reusableDevice | subject | location).@performInd" /> </mapping> <mapping> <identity value="ical" /> <map value="ROLE=REQ-PARTICIPANT (roleparam)" /> </mapping> </element> <element id="Appointment.participant.status"> <path value="Appointment.participant.status" /> <short value="accepted | declined | tentative | needs-action" /> <definition value="Participation status of the actor." /> <min value="1" /> <max value="1" /> <type> <code value="code" /> </type> <isSummary value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="ParticipationStatus" /> </extension> <strength value="required" /> <description value="The Participation status of an appointment." /> <valueSet value="http://hl7.org/fhir/ValueSet/participationstatus|4.0.0" /> </binding> <mapping> <identity value="v2" /> <map value="AIP-12, AIG-14" /> </mapping> <mapping> <identity value="rim" /> <map value="(performer | reusableDevice | subject | location).statusCode" /> </mapping> <mapping> <identity value="ical" /> <map value="ATTENDEE;CN="John Doe";RSVP=TRUE:mailto:john@doe.com (rsvpparam | partstatparam)" /> </mapping> </element> <element id="Appointment.participant.period"> <path value="Appointment.participant.period" /> <short value="Participation period of the actor" /> <definition value="Participation period of the actor." /> <max value="1" /> <type> <code value="Period" /> </type> </element> <element id="Appointment.requestedPeriod"> <path value="Appointment.requestedPeriod" /> <short value="Potential date/time interval(s) requested to allocate the appointment within" /> <definition value="A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. The duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system." /> <comment value="This does not introduce a capacity for recurring appointments." /> <type> <code value="Period" /> </type> <mapping> <identity value="workflow" /> <map value="Request.occurrence[x]" /> </mapping> <mapping> <identity value="v2" /> <map value="ARQ-11" /> </mapping> <mapping> <identity value="rim" /> <map value=".activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')]" /> </mapping> </element> </differential> </StructureDefinition>

Name	Flags	Card.	Type	Description & Constraints
Appointment	I TU		DomainResource	A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) + Rule: Either start and end are specified, or neither + Rule: Only proposed or cancelled appointments can be missing start/end dates + Rule: Cancelation reason is only used for appointments that have been cancelled, or no-show Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
identifier	Σ	0..*	Identifier	External Ids for this item
status	?! Σ	1..1	code	proposed \| pending \| booked \| arrived \| fulfilled \| cancelled \| noshow \| entered-in-error \| checked-in \| waitlist AppointmentStatus ( Required)
cancelationReason	Σ	0..1	CodeableConcept	The coded reason for the appointment being cancelled Appointment cancellation reason ( Example)
serviceCategory	Σ	0..*	CodeableConcept	A broad categorization of the service that is to be performed during this appointment Service category ( Example)
serviceType	Σ	0..*	CodeableConcept	The specific service that is to be performed during this appointment Service type ( Example)
specialty	Σ	0..*	CodeableConcept	The specialty of a practitioner that would be required to perform the service requested in this appointment Practice Setting Code Value Set ( Preferred)
appointmentType	Σ	0..1	CodeableConcept	The style of appointment or patient that has been booked in the slot (not service type) v2 Appointment Reason Codes ( Preferred)
reasonCode	Σ	0..*	CodeableConcept	Coded reason this appointment is scheduled Encounter Reason Codes ( Preferred)
reasonReference		0..*	Reference( Condition \| Procedure \| Observation \| ImmunizationRecommendation)	Reason the appointment is to take place (resource)
priority		0..1	unsignedInt	Used to make informed decisions if needing to re-prioritize
description		0..1	string	Shown on a subject line in a meeting request, or appointment list
supportingInformation		0..*	Reference( Any)	Additional information to support the appointment
start	Σ	0..1	instant	When appointment is to take place
end	Σ	0..1	instant	When appointment is to conclude
minutesDuration		0..1	positiveInt	Can be less than start/end (e.g. estimate)
slot		0..*	Reference( Slot)	The slots that this appointment is filling
created		0..1	dateTime	The date that this appointment was initially created
comment		0..1	string	Additional comments
patientInstruction		0..1	string	Detailed information and instructions for the patient
basedOn		0..*	Reference( ServiceRequest)	The service request this appointment is allocated to assess
participant	I	1..*	BackboneElement	Participants involved in appointment + Rule: Either the type or actor on the participant SHALL be specified
type	Σ	0..*	CodeableConcept	Role of participant in the appointment Participant type ( Extensible)
actor	Σ	0..1	Reference( Patient \| Practitioner \| PractitionerRole \| RelatedPerson \| Device \| HealthcareService \| Location)	Person, Location/HealthcareService or Device
required	Σ	0..1	code	required \| optional \| information-only ParticipantRequired ( Required)
status	Σ	1..1	code	accepted \| declined \| tentative \| needs-action ParticipationStatus ( Required)
period		0..1	Period	Participation period of the actor
requestedPeriod		0..*	Period	Potential date/time interval(s) requested to allocate the appointment within
Documentation for this format