Appointment
Appointment view.
Columns
| Name | Type | Description |
| id | String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| lastUpdated | Datetime | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
| implicitRules | String | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
| language | String | The base language in which the resource is written. |
| text_div | String | The div of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
| text_status | String | The status of the text. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it 'clinically safe' for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
| contained | String | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
| extension | String | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| modifierExtension | String | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| identifier_value | String | The value of the identifier. 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_use | String | The identifier-use of the identifier-use. 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_type_coding | String | The coding of the identifier-type. 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_type_text | String | The text of the identifier-type. 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_system | String | The identifier-system of the identifier-system. 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_period_start | String | The start of the identifier-period. 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_period_end | String | The end of the identifier-period. 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). |
| status | String | 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. |
| cancelationReason_coding | String | The coding of the cancelationReason. 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_text | String | The text of the cancelationReason. 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. |
| serviceCategory_coding | String | The coding of the serviceCategory. A broad categorization of the service that is to be performed during this appointment. |
| serviceCategory_text | String | The text of the serviceCategory. A broad categorization of the service that is to be performed during this appointment. |
| serviceType_coding | String | The coding of the serviceType. The specific service that is to be performed during this appointment. |
| serviceType_text | String | The text of the serviceType. The specific service that is to be performed during this appointment. |
| specialty_coding | String | The coding of the specialty. The specialty of a practitioner that would be required to perform the service requested in this appointment. |
| specialty_text | String | The text of the specialty. The specialty of a practitioner that would be required to perform the service requested in this appointment. |
| appointmentType_coding | String | The coding of the appointmentType. The style of appointment or patient that has been booked in the slot (not service type). |
| appointmentType_text | String | The text of the appointmentType. The style of appointment or patient that has been booked in the slot (not service type). |
| reasonCode_coding | String | The coding of the reasonCode. The coded reason that this appointment is being scheduled. This is more clinical than administrative. |
| reasonCode_text | String | The text of the reasonCode. The coded reason that this appointment is being scheduled. This is more clinical than administrative. |
| reasonReference_display | String | The display of the reasonReference. 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 | String | The reference of the reasonReference. 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_identifier_value | String | The value of the reasonReference-identifier. 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_type | String | The reasonReference-type of the reasonReference-type. 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. |
| priority | String | 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). |
| description | String | 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. |
| supportingInformation_display | String | The display of the supportingInformation. Additional information to support the appointment provided when making the appointment. |
| supportingInformation_reference | String | The reference of the supportingInformation. Additional information to support the appointment provided when making the appointment. |
| supportingInformation_identifier_value | String | The value of the supportingInformation-identifier. Additional information to support the appointment provided when making the appointment. |
| supportingInformation_type | String | The supportingInformation-type of the supportingInformation-type. Additional information to support the appointment provided when making the appointment. |
| start | String | Date/Time that the appointment is to take place. |
| end | String | Date/Time that the appointment is to conclude. |
| minutesDuration | Int | 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. |
| slot_display | String | The display of the slot. The slots from the participants' schedules that will be filled by the appointment. |
| slot_reference | String | The reference of the slot. The slots from the participants' schedules that will be filled by the appointment. |
| slot_identifier_value | String | The value of the slot-identifier. The slots from the participants' schedules that will be filled by the appointment. |
| slot_type | String | The slot-type of the slot-type. The slots from the participants' schedules that will be filled by the appointment. |
| created | Datetime | 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 | String | Additional comments about the appointment. |
| patientInstruction | String | 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). |
| basedOn_display | String | The display of the basedOn. The service request this appointment is allocated to assess (e.g. incoming referral or procedure request). |
| basedOn_reference | String | The reference of the basedOn. The service request this appointment is allocated to assess (e.g. incoming referral or procedure request). |
| basedOn_identifier_value | String | The value of the basedOn-identifier. The service request this appointment is allocated to assess (e.g. incoming referral or procedure request). |
| basedOn_type | String | The basedOn-type of the basedOn-type. The service request this appointment is allocated to assess (e.g. incoming referral or procedure request). |
| participant_id | String | The participant-id of the participant-id. Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| participant_extension | String | The participant-extension of the participant-extension. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| participant_modifierExtension | String | The participant-modifierExtension of the participant-modifierExtension. May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| participant_type_coding | String | The coding of the participant-type. Role of participant in the appointment. |
| participant_type_text | String | The text of the participant-type. Role of participant in the appointment. |
| participant_actor_display | String | The display of the participant-actor. A Person, Location/HealthcareService or Device that is participating in the appointment. |
| participant_actor_reference | String | The reference of the participant-actor. A Person, Location/HealthcareService or Device that is participating in the appointment. |
| participant_actor_identifier_value | String | The value of the participant-actor-identifier. A Person, Location/HealthcareService or Device that is participating in the appointment. |
| participant_actor_type | String | The participant-actor-type of the participant-actor-type. A Person, Location/HealthcareService or Device that is participating in the appointment. |
| participant_required | String | The participant-required of the participant-required. 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. |
| participant_status | String | The participant-status of the participant-status. Participation status of the actor. |
| participant_period_start | Datetime | The start of the participant-period. Participation period of the actor. |
| participant_period_end | Datetime | The end of the participant-period. Participation period of the actor. |
| requestedPeriod_start | String | The start of the requestedPeriod. 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_end | String | The end of the requestedPeriod. 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. |
| SP_location | String | The SP_location search parameter. |
| SP_source | String | The SP_source search parameter. |
| SP_appointment_type_end | String | The SP_appointment_type_end search parameter. |
| SP_actor | String | The SP_actor search parameter. |
| SP_text | String | The SP_text search parameter. |
| SP_service_category_end | String | The SP_service_category_end search parameter. |
| SP_content | String | The SP_content search parameter. |
| SP_securitySP_start | String | The SP_securitySP_start search parameter. |
| SP_slot | String | The SP_slot search parameter. |
| SP_tagSP_start | String | The SP_tagSP_start search parameter. |
| SP_reason_reference | String | The SP_reason_reference search parameter. |
| SP_specialty_end | String | The SP_specialty_end search parameter. |
| SP_part_status_start | String | The SP_part_status_start search parameter. |
| SP_identifier_start | String | The SP_identifier_start search parameter. |
| SP_based_on | String | The SP_based_on search parameter. |
| SP_practitioner | String | The SP_practitioner search parameter. |
| SP_list | String | The SP_list search parameter. |
| SP_reason_code_start | String | The SP_reason_code_start search parameter. |
| SP_part_status_end | String | The SP_part_status_end search parameter. |
| SP_service_category_start | String | The SP_service_category_start search parameter. |
| SP_identifier_end | String | The SP_identifier_end search parameter. |
| SP_profile | String | The SP_profile search parameter. |
| SP_specialty_start | String | The SP_specialty_start search parameter. |
| SP_service_type_start | String | The SP_service_type_start search parameter. |
| SP_tagSP_end | String | The SP_tagSP_end search parameter. |
| SP_patient | String | The SP_patient search parameter. |
| SP_securitySP_end | String | The SP_securitySP_end search parameter. |
| SP_appointment_type_start | String | The SP_appointment_type_start search parameter. |
| SP_supporting_info | String | The SP_supporting_info search parameter. |
| SP_filter | String | The SP_filter search parameter. |
| SP_reason_code_end | String | The SP_reason_code_end search parameter. |
| SP_service_type_end | String | The SP_service_type_end search parameter. |
| SP_date | String | The SP_date search parameter. |