Name | Flags | Card. | Type |
Description & Constraints
|
---|---|---|---|---|
|
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: Cancellation reason is only used for appointments that have been cancelled, or noshow + Rule: The start must be less than or equal to the end + Guideline: An appointment may have an originatingAppointment or recurrenceTemplate, but not both + Rule: Cancellation date is only used for appointments that have been cancelled, or noshow Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension |
|
|
Σ | 0..* | Identifier | External Ids for this item
|
|
?! Σ C | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
Binding: Appointment Status ( Required) |
|
Σ C | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled
Binding: Appointment Cancellation Reason ( Example) |
|
Σ | 0..* | CodeableConcept | Classification when becoming an encounter
Binding: EncounterClass ( Preferred) |
|
Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment
Binding: Service Category ( Example) |
|
Σ | 0..* | CodeableReference( HealthcareService) | The specific service that is to be performed during this appointment
Binding: Service Type ( Example) |
|
Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment
Binding: Practice Setting Code Value Set ( Preferred) |
|
Σ | 0..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type)
Binding: hl7VS-appointmentReasonCodes ( Preferred) |
|
Σ | 0..* | CodeableReference( Condition | Procedure | Observation | ImmunizationRecommendation) | Reason this appointment is scheduled
Binding: Encounter Reason Codes ( Preferred) |
|
0..1 | CodeableConcept | Used to make informed decisions if needing to re-prioritize
Binding: ActPriority ( Example) |
|
|
0..1 | string | Shown on a subject line in a meeting request, or appointment list
|
|
|
0..* | Reference( Appointment) | Appointment replaced by this Appointment
|
|
|
0..* | VirtualServiceDetail | Connection details of a virtual service (e.g. conference call)
|
|
|
0..* | Reference( Any) | Additional information to support the appointment
|
|
|
0..1 | Reference( Appointment) | The previous appointment in a series
|
|
|
C | 0..1 | Reference( Appointment) | The originating appointment in a recurring set of appointments
|
|
Σ C | 0..1 | instant | When appointment is to take place
|
|
Σ C | 0..1 | instant | When appointment is to conclude
|
|
0..1 | positiveInt | Can be less than start/end (e.g. estimate)
|
|
|
0..* | Period | Potential date/time interval(s) requested to allocate the appointment within
|
|
|
0..* | Reference( Slot) | The slots that this appointment is filling
|
|
|
0..* | Reference( Account) | The set of accounts that may be used for billing for this Appointment
|
|
|
0..1 | dateTime | The date that this appointment was initially created
|
|
|
C | 0..1 | dateTime | When the appointment was cancelled
|
|
0..* | Annotation | Additional comments
|
|
|
0..* | CodeableReference( DocumentReference | Binary | Communication) | Detailed information and instructions for the patient
|
|
|
0..* | Reference( CarePlan | DeviceRequest | MedicationRequest | ServiceRequest) | The request this appointment is allocated to assess
|
|
|
Σ | 0..1 | Reference( Patient | Group) | The patient or group associated with the appointment
|
|
C | 1..* | BackboneElement | Participants involved in appointment
+ Rule: Either the type or actor on the participant SHALL be specified |
|
Σ C | 0..* | CodeableConcept | Role of participant in the appointment
Binding: Participant Type ( Extensible) |
|
0..1 | Period | Participation period of the actor
|
|
|
Σ C | 0..1 | Reference( Patient | Group | Practitioner | PractitionerRole | CareTeam | RelatedPerson | Device | HealthcareService | Location) | The individual, device, location, or service participating in the appointment
|
|
Σ | 0..1 | boolean | The participant is required to attend (optional when false)
|
|
Σ | 1..1 | code | accepted | declined | tentative | needs-action
Binding: Participation Status ( Required) |
|
0..1 | positiveInt | The sequence number in the recurrence
|
|
|
0..1 | boolean | Indicates that this appointment varies from a recurrence pattern
|
|
|
C | 0..* | BackboneElement | Details of the recurrence pattern/template used to generate occurrences
|
|
0..1 | CodeableConcept | The timezone of the occurrences
Binding: IANA Timezones ( Required) |
|
|
1..1 | CodeableConcept | The frequency of the recurrence
Binding: Appointment Recurrence Type ( Preferred) |
|
|
0..1 | date | The date when the recurrence should end
|
|
|
0..1 | positiveInt | The number of planned occurrences
|
|
|
0..* | date | Specific dates for a recurring set of appointments (no template)
|
|
|
0..1 | BackboneElement | Information about weekly recurring appointments
|
|
|
0..1 | boolean | Recurs on Mondays
|
|
|
0..1 | boolean | Recurs on Tuesday
|
|
|
0..1 | boolean | Recurs on Wednesday
|
|
|
0..1 | boolean | Recurs on Thursday
|
|
|
0..1 | boolean | Recurs on Friday
|
|
|
0..1 | boolean | Recurs on Saturday
|
|
|
0..1 | boolean | Recurs on Sunday
|
|
|
0..1 | positiveInt | Recurs every nth week
|
|
|
0..1 | BackboneElement | Information about monthly recurring appointments
|
|
|
0..1 | positiveInt | Recurs on a specific day of the month
|
|
|
0..1 | Coding | Indicates which week of the month the appointment should occur
Binding: Week Of Month ( Required) |
|
|
0..1 | Coding | Indicates which day of the week the appointment should occur
Binding: Days Of Week ( Required) |
|
|
1..1 | positiveInt | Recurs every nth month
|
|
|
0..1 | BackboneElement | Information about yearly recurring appointments
|
|
|
1..1 | positiveInt | Recurs every nth year
|
|
|
0..* | date | Any dates that should be excluded from the series
|
|
|
0..* | positiveInt | Any recurrence IDs that should be excluded from the recurrence
|
|
|