Release 4 4B

This page is part of the FHIR Specification (v4.0.1: R4 (v4.3.0: R4B - Mixed Normative and STU ) in it's permanent home (it will always be available at this URL). ). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R4B R4 R3 R2

12.10 Resource Appointment - Content

Patient Administration Work Group Maturity Level : 3   Trial Use Security Category : Patient Compartments : Device , Patient , Practitioner , RelatedPerson

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).

12.10.1 Scope and Usage

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 to 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.

This definition takes the concepts of appointments in a clinical setting and also extends them to be relevant in the community healthcare space, and to ease exposure to other appointment / calendar standards widely used outside of healthcare.

12.10.1.1 The basic workflow to create an appointment

  • Discovery/Addressing

    Before an appointment can be made, the address/endpoint details of the resource that we want to schedule an appointment with must be determined. This is often based on the healthcare service type and any formatting information which indicates how to make the request. This is typically handled via the Schedule resource.

  • Checking Availability on the Schedule (optional)

    This optional step permits the checking of any existing available times ( Slot resources associated with a selected Schedule ) that can be booked against. Just because a time is indicated as available doesn't guarantee that an appointment can be made. The booking system that is going to process the request may make other qualifying decisions to determine if the appointment can be made, such as permissions, assessments, availability of other resources, etc.

    This step is optional, as the creation of the appointment is never a guaranteed action. But by performing this availability check, you can increase the chances of making a successful booking.

  • Making the Appointment Request

    When an appointment is required, a requester creates new Appointment resource with the Appointment.status="proposed".
    All included participants (optional or mandatory) should have the status="needs-action" to allow filtering and displaying appointments to user-participants for accepting or rejecting new and updated requests. Based on internal system business rules, certain statuses may be automatically updated, for example: "reject because the requested participant is on vacation" or "this type of user is not allowed to request those specific appointments".

  • Replying to the request

    The reply process is simply performed by the person/system handing the requests, updating the participant statuses on the appointment as needed. If there are multiple systems involved, then these will create AppointmentResponse entries with the desired statuses.

    Once all participants have their participation status created/updated (and the main system marking the appointment participant records with the AppointmentResponse statuses) then the overall status of the Appointment is updated.

  • Checking the overall status (Requester)

    The requester (organizer) of the appointment checks for the overall status of the appointment (and appointment responses, where applicable) using FHIR pub-sub techniques.

    Where the participant statuses indicate that a re-scheduling is required, then the process may start again, with other systems replying to a new set of times.

  • Waitlisting the Appointment (optional)

    This optional step permits creating a waitlisted appointment. This could occur if an appointment needs to be booked into a time that is not ideal for the patient due to lack of available time slots. In this workflow, there would be two appointments, the booked appointment in the time slot that is currently available, and the waitlisted appointment with a requestedPeriod spanning the time that the patient would prefer if new slots become available.

    If new time slots become available during the requestedPeriod, the scheduling system, or staff at the scheduling organization, can notify the patient that a new time slot is available. If the patient chooses, the waitlisted appointment would then be booked into that specific slot, and the previously booked appointment would be canceled. The specific business process for notifying patients of new availability is not specified, and is up to the implementing system to determine.

12.10.1.2 There are 2 typical workflows that occur with appointments

  • Outlook Style - Community

    These types of requests are typically handled by selecting a specific time from a list of available slots, then making the request for that timeslot.

  • Hospital Scheduling - Clinical

    Clinical scheduling is often far more complex in its requirements and processing. Often this involves checking multiple availabilities across multiple systems and timing with other internal systems, not just those exposed by the Slot resources.

    Consideration should be given to situations where scheduling needs to be handled in more of a queue-like process.

    Implementation Note: Note: This type of clinical appointment scheduling has not been specifically covered with this definition of the Appointment resource (and other related resources), however if you would like to contribute to the modification of this resource to cover these use cases, please contact the HL7 Patient Administration work-group.

12.10.2 Boundaries and Relationships

12.10.2.1 Appointment Request/Response Pattern

When using a request-response style of appointment this is done using Appointment and AppointmentResponse resources.
The request is made in the form of an Appointment with a proposed or pending status, and the list of actors with a participation status of "needs-action".

Participants in the appointment respond with their acceptance (or not) to the appointment by creating AppointmentResponse resources.
Once all the participants have replied, then the Appointment resource is able to be updated with an overall status which collates the results of all the participants and presents the approved details of the appointment.

The participant type property can be used to represent a specific role that a practitioner is required to perform for the appointment. This could be specified without an actor when the actual practitioner is not known, and will be filled in closer to the scheduled time.
This property must be the same between the Appointment-participant and the AppointmentResponse so that the appropriate values can be allocated. If you need multiple actors of a specific type, then multiple participants with that type value are included on the appointment.

12.10.2.2 Appointment Statuses and Encounters

Appointments can be considered as Administrative only, and the Encounter is expected to have clinical implications.

In general, it is expected that appointments will result in the creation of an Encounter. The encounter is typically created when the service starts, not when the patient arrives. When the patient arrives, an appointment can be marked with a status of Arrived.

In an Emergency Room context, the appointment Resource is probably not appropriate to be used. In these cases, an Encounter should be created.

The Appointment request pattern used is different from the order-response pattern used elsewhere in FHIR.
This is due to the close relationship to the iCal standard. Many non-clinical systems use generic non-health appointment systems which implement this standard, and the desire to integrate with the consumer who has no access to health based software is highly desirable.
The mappings to the iCal standard have been provided to guide implementation of gateways between FHIR servers and iCal systems.

12.10.2.3 Appointment Locations and Participation

The location of the appointment is to be defined by using a participant that references a Location or HealthcareService resource.
This permits the location to also have its availability checked via a schedule and any conflicts more easily managed.

12.10.3 References

This resource is referenced by AppointmentResponse , CarePlan , Encounter and ImagingStudy .

This resource implements the Request pattern.

12.10.3 12.10.4 Resource Content

Structure

Name Flags Card. Type Description & Constraints doco
. . 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 AppointmentCancellationReason ( Example )
. . . serviceType Σ 0..* CodeableConcept The specific service that is to be performed during this appointment
Service type ServiceType ( 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 hl7VS-appointmentReasonCodes ( 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 ParticipantType ( 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

doco Documentation for this format

UML Diagram ( Legend )

Appointment ( DomainResource ) 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) identifier : Identifier [0..*] 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 (this element modifies the meaning of other elements) status : code [1..1] « The free/busy status of an appointment. null (Strength=Required) AppointmentStatus ! » 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 cancelationReason : CodeableConcept [0..1] « null (Strength=Example) AppointmentCancellationReason ?? » A broad categorization of the service that is to be performed during this appointment serviceCategory : CodeableConcept [0..*] « null (Strength=Example) ServiceCategory ?? » The specific service that is to be performed during this appointment serviceType : CodeableConcept [0..*] « null (Strength=Example) ServiceType ?? » The specialty of a practitioner that would be required to perform the service requested in this appointment specialty : CodeableConcept [0..*] « null (Strength=Preferred) PracticeSettingCodeValueSet ? » The style of appointment or patient that has been booked in the slot (not service type) appointmentType : CodeableConcept [0..1] « null (Strength=Preferred) v2.0276 Hl7VSAppointmentReasonCodes ? » The coded reason that this appointment is being scheduled. This is more clinical than administrative reasonCode : CodeableConcept [0..*] « The Reason for the appointment to take place. null (Strength=Preferred) EncounterReasonCodes ? » 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 reasonReference : Reference [0..*] « Condition | Procedure | Observation | ImmunizationRecommendation » 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) priority : unsignedInt [0..1] 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 description : string [0..1] Additional information to support the appointment provided when making the appointment supportingInformation : Reference [0..*] « Any » Date/Time that the appointment is to take place start : instant [0..1] Date/Time that the appointment is to conclude end : instant [0..1] 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 minutesDuration : positiveInt [0..1] The slots from the participants' schedules that will be filled by the appointment slot : Reference [0..*] « Slot » 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 created : dateTime [0..1] Additional comments about the appointment comment : string [0..1] 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) patientInstruction : string [0..1] The service request this appointment is allocated to assess (e.g. incoming referral or procedure request) basedOn : Reference [0..*] « ServiceRequest » 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 requestedPeriod : Period [0..*] Participant Role of participant in the appointment type : CodeableConcept [0..*] « Role of participant in encounter. null (Strength=Extensible) ParticipantType + » A Person, Location/HealthcareService or Device that is participating in the appointment actor : Reference [0..1] « Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location » 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 required : code [0..1] « Is the Participant required to attend the appointment. null (Strength=Required) ParticipantRequired ! » Participation status of the actor status : code [1..1] « The Participation status of an appointment. null (Strength=Required) ParticipationStatus ! » Participation period of the actor period : Period [0..1] List of participants involved in the appointment participant [1..*]

XML Template 

<Appointment xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier External Ids for this item --></identifier>
 <status value="[code]"/><!-- 1..1 proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist -->
 <cancelationReason><!-- 0..1 CodeableConcept The coded reason for the appointment being cancelled --></cancelationReason>
 <serviceCategory><!-- 0..* CodeableConcept A broad categorization of the service that is to be performed during this appointment --></serviceCategory>
 <serviceType><!-- 0..* CodeableConcept The specific service that is to be performed during this appointment --></serviceType>
 <specialty><!-- 0..* CodeableConcept The specialty of a practitioner that would be required to perform the service requested in this appointment --></specialty>
 <</appointmentType>

 <appointmentType><!-- 0..1 CodeableConcept The style of appointment or patient that has been booked in the slot (not service type)  --></appointmentType>

 <reasonCode><!-- 0..* CodeableConcept Coded reason this appointment is scheduled --></reasonCode>
 <|
   </reasonReference>

 <reasonReference><!-- 0..* Reference(Condition|ImmunizationRecommendation|
   Observation|Procedure) Reason the appointment is to take place (resource) --></reasonReference>
 <priority value="[unsignedInt]"/><!-- 0..1 Used to make informed decisions if needing to re-prioritize -->
 <description value="[string]"/><!-- 0..1 Shown on a subject line in a meeting request, or appointment list -->
 <supportingInformation><!-- 0..* Reference(Any) Additional information to support the appointment --></supportingInformation>
 <start value="[instant]"/><!-- 0..1 When appointment is to take place -->
 <end value="[instant]"/><!-- 0..1 When appointment is to conclude -->
 <minutesDuration value="[positiveInt]"/><!-- 0..1 Can be less than start/end (e.g. estimate) -->
 <slot><!-- 0..* Reference(Slot) The slots that this appointment is filling --></slot>
 <created value="[dateTime]"/><!-- 0..1 The date that this appointment was initially created -->
 <comment value="[string]"/><!-- 0..1 Additional comments -->
 <patientInstruction value="[string]"/><!-- 0..1 Detailed information and instructions for the patient -->
 <basedOn><!-- 0..* Reference(ServiceRequest) The service request this appointment is allocated to assess --></basedOn>
 <participant>  <!-- 1..* Participants involved in appointment -->
  <type><!-- 0..* CodeableConcept Role of participant in the appointment --></type>
  <|
    </actor>

  <actor><!-- 0..1 Reference(Device|HealthcareService|Location|Patient|
    Practitioner|PractitionerRole|RelatedPerson) Person, Location/HealthcareService or Device --></actor>
  <required value="[code]"/><!-- 0..1 required | optional | information-only -->
  <status value="[code]"/><!-- 1..1 accepted | declined | tentative | needs-action -->
  <period><!-- 0..1 Period Participation period of the actor --></period>
 </participant>
 <requestedPeriod><!-- 0..* Period Potential date/time interval(s) requested to allocate the appointment within --></requestedPeriod>
</Appointment>

JSON Template 

{doco
  "resourceType" : "Appointment",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // External Ids for this item
  "status" : "<code>", // R!  proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
  "cancelationReason" : { CodeableConcept }, // The coded reason for the appointment being cancelled
  "serviceCategory" : [{ CodeableConcept }], // A broad categorization of the service that is to be performed during this appointment
  "serviceType" : [{ CodeableConcept }], // The specific service that is to be performed during this appointment
  "specialty" : [{ CodeableConcept }], // The specialty of a practitioner that would be required to perform the service requested in this appointment
  "

  "appointmentType" : { CodeableConcept }, // The style of appointment or patient that has been booked in the slot (not service type) 

  "reasonCode" : [{ CodeableConcept }], // Coded reason this appointment is scheduled
  "|
   

  "reasonReference" : [{ Reference(Condition|ImmunizationRecommendation|
   Observation|Procedure) }], // Reason the appointment is to take place (resource)
  "priority" : "<unsignedInt>", // Used to make informed decisions if needing to re-prioritize
  "description" : "<string>", // Shown on a subject line in a meeting request, or appointment list
  "supportingInformation" : [{ Reference(Any) }], // Additional information to support the appointment
  "start" : "<instant>", // When appointment is to take place
  "end" : "<instant>", // When appointment is to conclude
  "minutesDuration" : "<positiveInt>", // Can be less than start/end (e.g. estimate)
  "slot" : [{ Reference(Slot) }], // The slots that this appointment is filling
  "created" : "<dateTime>", // The date that this appointment was initially created
  "comment" : "<string>", // Additional comments
  "patientInstruction" : "<string>", // Detailed information and instructions for the patient
  "basedOn" : [{ Reference(ServiceRequest) }], // The service request this appointment is allocated to assess
  "participant" : [{ // R!  Participants involved in appointment
    "type" : [{ CodeableConcept }], // Role of participant in the appointment
    "|
    

    "actor" : { Reference(Device|HealthcareService|Location|Patient|
    Practitioner|PractitionerRole|RelatedPerson) }, // Person, Location/HealthcareService or Device
    "required" : "<code>", // required | optional | information-only
    "status" : "<code>", // R!  accepted | declined | tentative | needs-action
    "period" : { Period } // Participation period of the actor
  }],
  "requestedPeriod" : [{ Period }] // Potential date/time interval(s) requested to allocate the appointment within
}

Turtle Template 

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:Appointment;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:Appointment.identifier [ Identifier ], ... ; # 0..* External Ids for this item
  fhir:Appointment.status [ code ]; # 1..1 proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
  fhir:Appointment.cancelationReason [ CodeableConcept ]; # 0..1 The coded reason for the appointment being cancelled
  fhir:Appointment.serviceCategory [ CodeableConcept ], ... ; # 0..* A broad categorization of the service that is to be performed during this appointment
  fhir:Appointment.serviceType [ CodeableConcept ], ... ; # 0..* The specific service that is to be performed during this appointment
  fhir:Appointment.specialty [ CodeableConcept ], ... ; # 0..* The specialty of a practitioner that would be required to perform the service requested in this appointment
  fhir:Appointment.appointmentType [ CodeableConcept ]; # 0..1 The style of appointment or patient that has been booked in the slot (not service type)
  fhir:Appointment.reasonCode [ CodeableConcept ], ... ; # 0..* Coded reason this appointment is scheduled
  fhir:

  fhir:Appointment.reasonReference [ Reference(Condition|ImmunizationRecommendation|Observation|Procedure) ], ... ; # 0..* Reason the appointment is to take place (resource)

  fhir:Appointment.priority [ unsignedInt ]; # 0..1 Used to make informed decisions if needing to re-prioritize
  fhir:Appointment.description [ string ]; # 0..1 Shown on a subject line in a meeting request, or appointment list
  fhir:Appointment.supportingInformation [ Reference(Any) ], ... ; # 0..* Additional information to support the appointment
  fhir:Appointment.start [ instant ]; # 0..1 When appointment is to take place
  fhir:Appointment.end [ instant ]; # 0..1 When appointment is to conclude
  fhir:Appointment.minutesDuration [ positiveInt ]; # 0..1 Can be less than start/end (e.g. estimate)
  fhir:Appointment.slot [ Reference(Slot) ], ... ; # 0..* The slots that this appointment is filling
  fhir:Appointment.created [ dateTime ]; # 0..1 The date that this appointment was initially created
  fhir:Appointment.comment [ string ]; # 0..1 Additional comments
  fhir:Appointment.patientInstruction [ string ]; # 0..1 Detailed information and instructions for the patient
  fhir:Appointment.basedOn [ Reference(ServiceRequest) ], ... ; # 0..* The service request this appointment is allocated to assess
  fhir:Appointment.participant [ # 1..* Participants involved in appointment
    fhir:Appointment.participant.type [ CodeableConcept ], ... ; # 0..* Role of participant in the appointment
    fhir:|
  

    fhir:Appointment.participant.actor [ Reference(Device|HealthcareService|Location|Patient|Practitioner|PractitionerRole|
  RelatedPerson) ]; # 0..1 Person, Location/HealthcareService or Device
    fhir:Appointment.participant.required [ code ]; # 0..1 required | optional | information-only
    fhir:Appointment.participant.status [ code ]; # 1..1 accepted | declined | tentative | needs-action
    fhir:Appointment.participant.period [ Period ]; # 0..1 Participation period of the actor
  ], ...;
  fhir:Appointment.requestedPeriod [ Period ], ... ; # 0..* Potential date/time interval(s) requested to allocate the appointment within
]

Changes since R3 R4

Appointment Appointment.status Change value set from http://hl7.org/fhir/ValueSet/appointmentstatus to http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1 Appointment.cancelationReason Added Element Appointment.serviceCategory Max Cardinality changed from 1 to * Appointment.reasonCode Added Element Appointment.reasonReference Added Element Appointment.patientInstruction Added Element Appointment.basedOn Added Element Appointment.participant.actor Type Reference: Added Target Type PractitionerRole Appointment.participant.required Change value set from http://hl7.org/fhir/ValueSet/participantrequired to http://hl7.org/fhir/ValueSet/participantrequired|4.0.1 Appointment.participant.status Change value set from http://hl7.org/fhir/ValueSet/participationstatus to http://hl7.org/fhir/ValueSet/participationstatus|4.0.1 Appointment.participant.period Added Element Appointment.reason deleted Appointment.indication deleted Appointment.incomingReferral
  • deleted No Changes

See the Full Difference for further information

This analysis is available as XML or JSON .

Conversions between R3 and R4

See R3 <--> R4 Conversion Maps (status = 3 tests that all execute ok. All tests pass round-trip testing and all r3 resources are valid.)

Structure

Name Flags Card. Type Description & Constraints doco
. . 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 AppointmentCancellationReason ( Example )
. . . serviceType Σ 0..* CodeableConcept The specific service that is to be performed during this appointment
Service type ServiceType ( 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 hl7VS-appointmentReasonCodes ( 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 ParticipantType ( 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

doco Documentation for this format

UML Diagram ( Legend )

Appointment ( DomainResource ) 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) identifier : Identifier [0..*] 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 (this element modifies the meaning of other elements) status : code [1..1] « The free/busy status of an appointment. null (Strength=Required) AppointmentStatus ! » 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 cancelationReason : CodeableConcept [0..1] « null (Strength=Example) AppointmentCancellationReason ?? » A broad categorization of the service that is to be performed during this appointment serviceCategory : CodeableConcept [0..*] « null (Strength=Example) ServiceCategory ?? » The specific service that is to be performed during this appointment serviceType : CodeableConcept [0..*] « null (Strength=Example) ServiceType ?? » The specialty of a practitioner that would be required to perform the service requested in this appointment specialty : CodeableConcept [0..*] « null (Strength=Preferred) PracticeSettingCodeValueSet ? » The style of appointment or patient that has been booked in the slot (not service type) appointmentType : CodeableConcept [0..1] « null (Strength=Preferred) v2.0276 Hl7VSAppointmentReasonCodes ? » The coded reason that this appointment is being scheduled. This is more clinical than administrative reasonCode : CodeableConcept [0..*] « The Reason for the appointment to take place. null (Strength=Preferred) EncounterReasonCodes ? » 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 reasonReference : Reference [0..*] « Condition | Procedure | Observation | ImmunizationRecommendation » 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) priority : unsignedInt [0..1] 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 description : string [0..1] Additional information to support the appointment provided when making the appointment supportingInformation : Reference [0..*] « Any » Date/Time that the appointment is to take place start : instant [0..1] Date/Time that the appointment is to conclude end : instant [0..1] 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 minutesDuration : positiveInt [0..1] The slots from the participants' schedules that will be filled by the appointment slot : Reference [0..*] « Slot » 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 created : dateTime [0..1] Additional comments about the appointment comment : string [0..1] 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) patientInstruction : string [0..1] The service request this appointment is allocated to assess (e.g. incoming referral or procedure request) basedOn : Reference [0..*] « ServiceRequest » 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 requestedPeriod : Period [0..*] Participant Role of participant in the appointment type : CodeableConcept [0..*] « Role of participant in encounter. null (Strength=Extensible) ParticipantType + » A Person, Location/HealthcareService or Device that is participating in the appointment actor : Reference [0..1] « Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location » 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 required : code [0..1] « Is the Participant required to attend the appointment. null (Strength=Required) ParticipantRequired ! » Participation status of the actor status : code [1..1] « The Participation status of an appointment. null (Strength=Required) ParticipationStatus ! » Participation period of the actor period : Period [0..1] List of participants involved in the appointment participant [1..*]

XML Template 

<Appointment xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier External Ids for this item --></identifier>
 <status value="[code]"/><!-- 1..1 proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist -->
 <cancelationReason><!-- 0..1 CodeableConcept The coded reason for the appointment being cancelled --></cancelationReason>
 <serviceCategory><!-- 0..* CodeableConcept A broad categorization of the service that is to be performed during this appointment --></serviceCategory>
 <serviceType><!-- 0..* CodeableConcept The specific service that is to be performed during this appointment --></serviceType>
 <specialty><!-- 0..* CodeableConcept The specialty of a practitioner that would be required to perform the service requested in this appointment --></specialty>
 <</appointmentType>

 <appointmentType><!-- 0..1 CodeableConcept The style of appointment or patient that has been booked in the slot (not service type)  --></appointmentType>

 <reasonCode><!-- 0..* CodeableConcept Coded reason this appointment is scheduled --></reasonCode>
 <|
   </reasonReference>

 <reasonReference><!-- 0..* Reference(Condition|ImmunizationRecommendation|
   Observation|Procedure) Reason the appointment is to take place (resource) --></reasonReference>
 <priority value="[unsignedInt]"/><!-- 0..1 Used to make informed decisions if needing to re-prioritize -->
 <description value="[string]"/><!-- 0..1 Shown on a subject line in a meeting request, or appointment list -->
 <supportingInformation><!-- 0..* Reference(Any) Additional information to support the appointment --></supportingInformation>
 <start value="[instant]"/><!-- 0..1 When appointment is to take place -->
 <end value="[instant]"/><!-- 0..1 When appointment is to conclude -->
 <minutesDuration value="[positiveInt]"/><!-- 0..1 Can be less than start/end (e.g. estimate) -->
 <slot><!-- 0..* Reference(Slot) The slots that this appointment is filling --></slot>
 <created value="[dateTime]"/><!-- 0..1 The date that this appointment was initially created -->
 <comment value="[string]"/><!-- 0..1 Additional comments -->
 <patientInstruction value="[string]"/><!-- 0..1 Detailed information and instructions for the patient -->
 <basedOn><!-- 0..* Reference(ServiceRequest) The service request this appointment is allocated to assess --></basedOn>
 <participant>  <!-- 1..* Participants involved in appointment -->
  <type><!-- 0..* CodeableConcept Role of participant in the appointment --></type>
  <|
    </actor>

  <actor><!-- 0..1 Reference(Device|HealthcareService|Location|Patient|
    Practitioner|PractitionerRole|RelatedPerson) Person, Location/HealthcareService or Device --></actor>
  <required value="[code]"/><!-- 0..1 required | optional | information-only -->
  <status value="[code]"/><!-- 1..1 accepted | declined | tentative | needs-action -->
  <period><!-- 0..1 Period Participation period of the actor --></period>
 </participant>
 <requestedPeriod><!-- 0..* Period Potential date/time interval(s) requested to allocate the appointment within --></requestedPeriod>
</Appointment>

JSON Template 

{doco
  "resourceType" : "Appointment",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // External Ids for this item
  "status" : "<code>", // R!  proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
  "cancelationReason" : { CodeableConcept }, // The coded reason for the appointment being cancelled
  "serviceCategory" : [{ CodeableConcept }], // A broad categorization of the service that is to be performed during this appointment
  "serviceType" : [{ CodeableConcept }], // The specific service that is to be performed during this appointment
  "specialty" : [{ CodeableConcept }], // The specialty of a practitioner that would be required to perform the service requested in this appointment
  "

  "appointmentType" : { CodeableConcept }, // The style of appointment or patient that has been booked in the slot (not service type) 

  "reasonCode" : [{ CodeableConcept }], // Coded reason this appointment is scheduled
  "|
   

  "reasonReference" : [{ Reference(Condition|ImmunizationRecommendation|
   Observation|Procedure) }], // Reason the appointment is to take place (resource)
  "priority" : "<unsignedInt>", // Used to make informed decisions if needing to re-prioritize
  "description" : "<string>", // Shown on a subject line in a meeting request, or appointment list
  "supportingInformation" : [{ Reference(Any) }], // Additional information to support the appointment
  "start" : "<instant>", // When appointment is to take place
  "end" : "<instant>", // When appointment is to conclude
  "minutesDuration" : "<positiveInt>", // Can be less than start/end (e.g. estimate)
  "slot" : [{ Reference(Slot) }], // The slots that this appointment is filling
  "created" : "<dateTime>", // The date that this appointment was initially created
  "comment" : "<string>", // Additional comments
  "patientInstruction" : "<string>", // Detailed information and instructions for the patient
  "basedOn" : [{ Reference(ServiceRequest) }], // The service request this appointment is allocated to assess
  "participant" : [{ // R!  Participants involved in appointment
    "type" : [{ CodeableConcept }], // Role of participant in the appointment
    "|
    

    "actor" : { Reference(Device|HealthcareService|Location|Patient|
    Practitioner|PractitionerRole|RelatedPerson) }, // Person, Location/HealthcareService or Device
    "required" : "<code>", // required | optional | information-only
    "status" : "<code>", // R!  accepted | declined | tentative | needs-action
    "period" : { Period } // Participation period of the actor
  }],
  "requestedPeriod" : [{ Period }] // Potential date/time interval(s) requested to allocate the appointment within
}

Turtle Template 

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:Appointment;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:Appointment.identifier [ Identifier ], ... ; # 0..* External Ids for this item
  fhir:Appointment.status [ code ]; # 1..1 proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
  fhir:Appointment.cancelationReason [ CodeableConcept ]; # 0..1 The coded reason for the appointment being cancelled
  fhir:Appointment.serviceCategory [ CodeableConcept ], ... ; # 0..* A broad categorization of the service that is to be performed during this appointment
  fhir:Appointment.serviceType [ CodeableConcept ], ... ; # 0..* The specific service that is to be performed during this appointment
  fhir:Appointment.specialty [ CodeableConcept ], ... ; # 0..* The specialty of a practitioner that would be required to perform the service requested in this appointment
  fhir:Appointment.appointmentType [ CodeableConcept ]; # 0..1 The style of appointment or patient that has been booked in the slot (not service type)
  fhir:Appointment.reasonCode [ CodeableConcept ], ... ; # 0..* Coded reason this appointment is scheduled
  fhir:

  fhir:Appointment.reasonReference [ Reference(Condition|ImmunizationRecommendation|Observation|Procedure) ], ... ; # 0..* Reason the appointment is to take place (resource)

  fhir:Appointment.priority [ unsignedInt ]; # 0..1 Used to make informed decisions if needing to re-prioritize
  fhir:Appointment.description [ string ]; # 0..1 Shown on a subject line in a meeting request, or appointment list
  fhir:Appointment.supportingInformation [ Reference(Any) ], ... ; # 0..* Additional information to support the appointment
  fhir:Appointment.start [ instant ]; # 0..1 When appointment is to take place
  fhir:Appointment.end [ instant ]; # 0..1 When appointment is to conclude
  fhir:Appointment.minutesDuration [ positiveInt ]; # 0..1 Can be less than start/end (e.g. estimate)
  fhir:Appointment.slot [ Reference(Slot) ], ... ; # 0..* The slots that this appointment is filling
  fhir:Appointment.created [ dateTime ]; # 0..1 The date that this appointment was initially created
  fhir:Appointment.comment [ string ]; # 0..1 Additional comments
  fhir:Appointment.patientInstruction [ string ]; # 0..1 Detailed information and instructions for the patient
  fhir:Appointment.basedOn [ Reference(ServiceRequest) ], ... ; # 0..* The service request this appointment is allocated to assess
  fhir:Appointment.participant [ # 1..* Participants involved in appointment
    fhir:Appointment.participant.type [ CodeableConcept ], ... ; # 0..* Role of participant in the appointment
    fhir:|
  

    fhir:Appointment.participant.actor [ Reference(Device|HealthcareService|Location|Patient|Practitioner|PractitionerRole|
  RelatedPerson) ]; # 0..1 Person, Location/HealthcareService or Device
    fhir:Appointment.participant.required [ code ]; # 0..1 required | optional | information-only
    fhir:Appointment.participant.status [ code ]; # 1..1 accepted | declined | tentative | needs-action
    fhir:Appointment.participant.period [ Period ]; # 0..1 Participation period of the actor
  ], ...;
  fhir:Appointment.requestedPeriod [ Period ], ... ; # 0..* Potential date/time interval(s) requested to allocate the appointment within
]

Changes since Release 3 4

Appointment Appointment.status Change value set from http://hl7.org/fhir/ValueSet/appointmentstatus to http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1 Appointment.cancelationReason Added Element Appointment.serviceCategory Max Cardinality changed from 1 to * Appointment.reasonCode Added Element Appointment.reasonReference Added Element Appointment.patientInstruction Added Element Appointment.basedOn Added Element Appointment.participant.actor Type Reference: Added Target Type PractitionerRole Appointment.participant.required Change value set from http://hl7.org/fhir/ValueSet/participantrequired to http://hl7.org/fhir/ValueSet/participantrequired|4.0.1 Appointment.participant.status Change value set from http://hl7.org/fhir/ValueSet/participationstatus to http://hl7.org/fhir/ValueSet/participationstatus|4.0.1 Appointment.participant.period Added Element Appointment.reason deleted Appointment.indication deleted Appointment.incomingReferral
  • deleted No Changes

See the Full Difference for further information

This analysis is available as XML or JSON .

Conversions between R3 and R4

See R3 <--> R4 Conversion Maps (status = 3 tests that all execute ok. All tests pass round-trip testing and all r3 resources are valid.)

 

See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) + see the extensions & the dependency analysis

12.10.3.1 12.10.4.1 Terminology Bindings

Path Definition Type Reference
Appointment.status The free/busy status of an appointment. Required AppointmentStatus
Appointment.cancelationReason Example AppointmentCancellationReason
Appointment.serviceCategory Example ServiceCategory
Appointment.serviceType Example ServiceType
Appointment.specialty Preferred PracticeSettingCodeValueSet
Appointment.appointmentType Preferred v2.0276 Hl7VSAppointmentReasonCodes
Appointment.reasonCode The Reason for the appointment to take place. Preferred EncounterReasonCodes
Appointment.participant.type Role of participant in encounter. Extensible ParticipantType
Appointment.participant.required Is the Participant required to attend the appointment. Required ParticipantRequired
Appointment.participant.status The Participation status of an appointment. Required ParticipationStatus

12.10.3.2 12.10.4.2 Constraints

id Level Location Description Expression
app-1 Rule Appointment.participant Either the type or actor on the participant SHALL be specified type.exists() or actor.exists()
app-2 Rule (base) Either start and end are specified, or neither start.exists() = end.exists()
app-3 Rule (base) Only proposed or cancelled appointments can be missing start/end dates (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4 Rule (base) Cancelation reason is only used for appointments that have been cancelled, or no-show Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')

12.10.4 12.10.5 Typical Status Transition Examples:

12.10.4.1 12.10.5.1 Typical flow of statuses for an appointment:

Activity Description Slot Appointment Appointment Response Encounter
The schedule is created/published
(Role: Scheduler) 		freeBusyType = FREE
An appointment request is created after locating an available slot
(Role: Requester) 		status = pending
participant.status = needs-action
The appointment request is processed and the slot status updated
(Role: Scheduler) 		freeBusyType = BUSY-TENTATIVE
The appointment is accepted as described – by all participants
(Role: Participant(s)) 		participantStatus = accepted
The appointment is confirmed as accepted by all participants
(Role: Scheduler) 		freeBusyType = BUSY status = booked
participant.status = accepted
Optional: Preparation for the appointment begins – could be preparing a room for the appointment, etc.
(Role: Participants/Admin) 		status = planned (optional)
location.status = planned
The patient arrives for the appointment, often sitting in a waiting room
(Role: Admin) 		status = arrived status = arrived
location.status = present
The practitioner and the patient meet and the provision of the service begins
(Role: Scheduler/Participant(s)/Admin) 		status = fulfilled status = in-progress
The encounter concludes
(Role: Scheduler/Participant(s)/Admin) 		status = finished

12.10.4.2 12.10.5.2 Flow for the rejection/cancellation of an appointment

Activity Description Slot Appointment Appointment Response
The schedule is created/published
(Role: Scheduler) 		freeBusyType = FREE
An appointment request is created
(Role: Requester) 		status = pending
participant.status = needs-action
The appointment request is processed and the slot status updated
(Role: Scheduler) 		freeBusyType = BUSY-TENTATIVE
Participant declines the Appointment
(Role: Participant) 		participantStatus = declined
The appointment is cancelled
(Role: Scheduler) 		freeBusyType = FREE status = cancelled
participant.status = declined

12.10.4.3 12.10.5.3 Flow for re-negotiation:

Activity Description Slot Appointment Appointment Response
The schedule is created/published
(Role: Scheduler) 		freeBusyType = FREE
An appointment is requested (e.g. with Brian and Peter)
(Role: Requester) 		status = proposed
participant(Brian).status = needs-action
participant(Peter).status = needs-action
The schedule is updated to inform others of interest in the slot
(Role: Scheduler) 		freeBusyType = BUSY-TENTATIVE
Brian accepts the appointment
(Role: Participant-Brian) 		(Brian).participantStatus = accepted
Appointment is updated with Brian's status
(Role: Scheduler) 		status = pending
participant(Brian).status = accepted
Peter suggests a new time
(Role: Participant-Peter) 		(Peter).participantStatus = tentative
(with new time)
Appointment is updated with new time, and indicates that action is needed by both participants
(Role: Scheduler) 		(new time details updated)
participant(Brian).status = needs-action
participant(Peter).status = needs-action
Brian accepts the appointment
(Role: Participant-Brian) 		(Brian).participantStatus = accepted
Appointment updated
(Role: Scheduler) 		participant(Brian).status = accepted

(Role: Participant-Peter) 		(Peter).participantStatus = accepted
Appointment updated
(Role: Scheduler) 		freeBusyType = BUSY status = booked
participant(Peter).status = accepted

12.10.4.4 12.10.5.4 Flow for a patient no-show:

Activity Description Slot Appointment Appointment Response Encounter
(from typical status flow) freeBusyType = BUSY status = booked
participant.status = accepted
Appointment is updated as a noshow
(Role: Scheduler/Admin) 		status = noshow (no encounter created)

12.10.4.5 12.10.5.5 Flow for a patient waitlist:

Activity Description Appointment (inconvenient) Appointment (preferred)
An appointment is booked for an inconvenient time using a typical status flow status = booked
participant.status = accepted
Waitlist appointment created status = booked
participant.status = accepted 		status = waitlist
requestedPeriod = (more convenient time period)
Patient notified of availability of a better slot status = booked status = proposed
participant.status = needs-action
Patient accepts better slot status = cancelled status = booked
participant.status = accepted

12.10.5 12.10.6 Notes:

  • Placer/Filler ( HL7 v2 )
    The appointment information is effectively the same between the filler and placer, and given the nature of the FHIR resource, there is only a single resource for both purposes. The placer is the actor that performs the PUT or POST operation on the resource, and the filler is the actor that receives these resource messages and processes the information and makes a decision if the appointment can be used.
  • Terminology - ServiceCategory, ServiceType and Specialty
    The 3 core clinical terminologies associated with the appointment may have relationships with each other through the terminology server, but not these might not be visible in the actual appointment resource or profile.
  • Interaction with other Standards
    The strong desire is that implementers of this resource should consider providing this resource in the iCalendar format as an alternative representation. Many 3rd party applications and component providers have parsers and user interface controls to display this information. This may lower the entry point to integrate outside the health-care specific applications, and into the consumer space. This would permit the easier creation of a mobile application that creates appointments in the devices native calendar.
    The iCalendar specification can be found at http://www.ietf.org/rfc/rfc2445.txt .

Trial-Use Note: Implementer feedback is sought on the values for Appointment.priority and how interoperable they are. Using an extension to record a CodeableConcept for named values may be tested at a future Connectathon.
Implementer feedback is also sought to clarify desired relationship linkages between ServiceCategory, ServiceType and Specialty, along with how they have approached the definition.

Feedback here .

12.10.6 12.10.7 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name Type Description Expression In Common
actor reference Any one of the individuals participating in the appointment Appointment.participant.actor
( Practitioner , Device , Patient , HealthcareService , PractitionerRole , RelatedPerson , Location )
appointment-type token The style of appointment or patient that has been booked in the slot (not service type) Appointment.appointmentType
based-on reference The service request this appointment is allocated to assess Appointment.basedOn
( ServiceRequest )
date date Appointment date/time. Appointment.start
identifier token An Identifier of the Appointment Appointment.identifier
location reference This location is listed in the participants of the appointment Appointment.participant.actor.where(resolve() is Location)
( Location )
part-status token The Participation status of the subject, or other participant on the appointment. Can be used to locate participants that have not responded to meeting requests. Appointment.participant.status
patient reference One of the individuals of the appointment is this patient Appointment.participant.actor.where(resolve() is Patient)
( Patient )
practitioner reference One of the individuals of the appointment is this practitioner Appointment.participant.actor.where(resolve() is Practitioner)
( Practitioner )
reason-code token Coded reason this appointment is scheduled Appointment.reasonCode
reason-reference reference Reason the appointment is to take place (resource) Appointment.reasonReference
( Condition , Observation , Procedure , ImmunizationRecommendation )
service-category token A broad categorization of the service that is to be performed during this appointment Appointment.serviceCategory
service-type token The specific service that is to be performed during this appointment Appointment.serviceType
slot reference The slots that this appointment is filling Appointment.slot
( Slot )
specialty token The specialty of a practitioner that would be required to perform the service requested in this appointment Appointment.specialty
status token The overall status of the appointment Appointment.status
supporting-info reference Additional information to support the appointment Appointment.supportingInformation
(Any)