This is the set of resources that conform to either of the profiles HL7® AT Scheduling Appointment Profile (https://fhir.hl7.at/tc/wg/scheduling/r5/StructureDefinition/at-scheduling-appointment) and HL7® AT Scheduling Appointment Profile (https://fhir.hl7.at/tc/wg/scheduling/r5/StructureDefinition/at-scheduling-appointment). E.g. what you have to deal with if you get resources conforming to one of them
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() | C | 0..* | 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) Constraints: app-2, app-3, app-4, app-5, app-6, app-7 | |
![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() | 0..1 | code | Language of the resource content Binding: ?? (required): IETF language tag for a human language | |
![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |
![]() ![]() | 0..* | Resource | Contained, inline Resources | |
![]() ![]() | 0..* | Extension | Extension | |
![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() | Σ | 0..* | Identifier | External Ids for this item |
![]() ![]() | ?!Σ | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: ?? (required): The free/busy status of an appointment. |
![]() ![]() | Σ | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: ?? (example) |
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() | Σ | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept |
![]() ![]() | Σ | 0..* | CodeableConcept | Classification when becoming an encounter Binding: ?? (extensible) |
![]() ![]() | Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ?? (example) |
![]() ![]() | Σ | 0..* | CodeableReference(HL7® AT Scheduling HealthcareService Profile | #sd-4-at-scheduling-healthcareservice-at-scheduling-healthcareservice) | The specific service that is to be performed during this appointment Binding: ?? (extensible) |
![]() ![]() | SΣ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: ?? (preferred) |
![]() ![]() | Σ | 0..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: ?? (preferred) |
![]() ![]() | Σ | 0..* | CodeableReference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason this appointment is scheduled Binding: ?? (preferred): The Reason for the appointment to take place. |
![]() ![]() | 0..1 | CodeableConcept | Used to make informed decisions if needing to re-prioritize Binding: ?? (example): Indicates the urgency of the appointment. | |
![]() ![]() | 0..1 | string | Shown on a subject line in a meeting request, or appointment list | |
![]() ![]() | 0..* | Reference(HL7® AT Scheduling Appointment Profile), Reference(HL7® AT Scheduling Appointment Profile) | Appointment replaced by this Appointment | |
![]() ![]() | 0..* | VirtualServiceDetail | Connection details of a virtual service (e.g. conference call) | |
![]() ![]() | 0..* | Reference(Resource) | Additional information to support the appointment | |
![]() ![]() | 0..1 | Reference(HL7® AT Scheduling Appointment Profile), Reference(HL7® AT Scheduling Appointment Profile) | The previous appointment in a series | |
![]() ![]() | 0..1 | Reference(HL7® AT Scheduling Appointment Profile), Reference(HL7® AT Scheduling Appointment Profile) | The originating appointment in a recurring set of appointments | |
![]() ![]() | Σ | 0..1 | instant | When appointment is to take place |
![]() ![]() | Σ | 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(HL7® AT Scheduling Slot Profile | #sd-5-at-scheduling-slot-at-scheduling-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 | |
![]() ![]() | 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(HL7® AT Core Patient Profile | Group) | The patient or group associated with the appointment |
![]() ![]() | SC | 1..* | BackboneElement | Participants involved in appointment Constraints: app-1 |
![]() ![]() ![]() | 0..* | Extension | Extension | |
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() | Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ?? (extensible): Role of participant in encounter. |
![]() ![]() ![]() | 0..1 | Period | Participation period of the actor | |
![]() ![]() ![]() | SΣ | 1..1 | Reference(Patient | Group | Practitioner | PractitionerRole | CareTeam | RelatedPerson | Device | HealthcareService | Location) | The individual, device, location, or service participating in the appointment |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ?? (extensible): Aa resource (or, for logical models, the URI of the logical model). |
![]() ![]() ![]() ![]() | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() | SΣ | 0..1 | string | Text alternative for the resource |
![]() ![]() ![]() | Σ | 0..1 | boolean | The participant is required to attend (optional when false) |
![]() ![]() ![]() | SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ?? (required): The Participation status of an appointment. |
![]() ![]() | 0..1 | positiveInt | The sequence number in the recurrence | |
![]() ![]() | 0..1 | boolean | Indicates that this appointment varies from a recurrence pattern | |
![]() ![]() | 0..* | BackboneElement | Details of the recurrence pattern/template used to generate occurrences | |
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() | 0..1 | CodeableConcept | The timezone of the occurrences Binding: ?? (required): IANA Timezones (BCP 175) | |
![]() ![]() ![]() | 1..1 | CodeableConcept | The frequency of the recurrence Binding: ?? (preferred): IANA Timezones (BCP 175) | |
![]() ![]() ![]() | 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..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 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..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 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: ?? (required): The set of weeks in a month. | |
![]() ![]() ![]() ![]() | 0..1 | Coding | Indicates which day of the week the appointment should occur Binding: ?? (required): The days of the week. | |
![]() ![]() ![]() ![]() | 1..1 | positiveInt | Recurs every nth month | |
![]() ![]() ![]() | 0..1 | BackboneElement | Information about yearly recurring appointments | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 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 | |
Documentation for this format | ||||