This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). 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 R3 R2
Detailed Descriptions for the elements in the Appointment resource.
Appointment | |
Definition | A scheduled healthcare event for a patient and/or practitioner(s) where a service may take place at a specific date/time. |
Control | 1..1 |
Appointment.identifier | |
Definition | This records identifiers associated with this appointment concern that are defined by business processed 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). |
Control | 0..* |
Type | Identifier |
Appointment.priority | |
Definition | 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) (Need to change back to CodeableConcept). |
Control | 0..1 |
Type | integer |
Appointment.status | |
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. |
Control | 1..1 |
Binding | AppointmentStatus: Required: http://hl7.org/fhir/appointmentstatus (The free/busy status of an appointment) |
Type | code |
Is Modifier | true |
Appointment.type | |
Definition | The type of appointments that is being booked (ideally this would be an identifiable service - which is at a location, rather than the location itself). |
Control | 0..1 |
Type | CodeableConcept |
Appointment.reason | |
Definition | The reason that this appointment is being scheduled, this is more clinical than administrative. |
Control | 0..1 |
Binding | ApptReason: Preferred: See http://hl7.org/fhir/vs/encounter-reason (The Reason for the appointment to take place) |
Type | CodeableConcept |
Appointment.description | |
Definition | 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. |
Control | 0..1 |
Type | string |
Appointment.start | |
Definition | Date/Time that the appointment is to take place. |
Control | 1..1 |
Type | instant |
Appointment.end | |
Definition | Date/Time that the appointment is to conclude. |
Control | 1..1 |
Type | instant |
Appointment.slot | |
Definition | The slot that this appointment is filling. If provided then the schedule will not be provided as slots are not recursive, and the start/end values MUST be the same as from the slot. |
Control | 0..* |
Type | Reference(Slot) |
Appointment.location | |
Definition | The primary location that this appointment is to take place. |
Control | 0..1 |
Type | Reference(Location) |
Appointment.comment | |
Definition | Additional comments about the appointment. |
Control | 0..1 |
Type | string |
Appointment.order | |
Definition | An Order that lead to the creation of this appointment. |
Control | 0..1 |
Type | Reference(Order) |
Appointment.participant | |
Definition | List of participants involved in the appointment. |
Control | 1..* |
Appointment.participant.type | |
Definition | Role of participant in the appointment. |
Control | 0..* |
Binding | ParticipantType: Preferred: See http://hl7.org/fhir/vs/encounter-participant-type (Role of participant in encounter) |
Type | CodeableConcept |
Appointment.participant.actor | |
Definition | A Person of device that is participating in the appointment, usually Practitioner, Patient, RelatedPerson or Device. |
Control | 0..1 |
Type | Reference(Any) |
Comments | Should this be multiple? And move to a child enitity. |
Appointment.participant.required | |
Definition | Is this participant required to be present at the meeting. This covers a use-case where 2 doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present. |
Control | 0..1 |
Binding | ParticipantRequired: Required: http://hl7.org/fhir/participantrequired (Is the Participant required to attend the appointment) |
Type | code |
Appointment.participant.status | |
Definition | Participation status of the Patient. |
Control | 1..1 |
Binding | ParticipationStatus: Required: http://hl7.org/fhir/participationstatus (The Participation status of an appointment) |
Type | code |
Appointment.lastModifiedBy | |
Definition | Who recorded the appointment. |
Control | 0..1 |
Type | Reference(Practitioner | Patient | RelatedPerson) |
Appointment.lastModified | |
Definition | Date when the appointment was recorded. |
Control | 0..1 |
Type | dateTime |