Scheduling
1.0.1-current - ci-build
Scheduling
1.0.1-current - ci-build
Scheduling, published by IHE IT Infrastructure Technical Committee. This guide is not an authorized publication; it is the continuous build for version 1.0.1-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/ITI.Scheduling/ and changes regularly. See the Directory of published versions
| Official URL: https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-appt | Version: 1.0.1-current | |||
| Active as of 2023-01-13 | Computable Name: IHE_ITI_Appointment_Profile | |||
The IHE ITI Scheduling Appointment Profile is used with the '$find', '$hold', and '$book' operations and when fetching appointments.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Appointment
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Appointment |
0..* | Appointment | 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) | |
  Slices for extension |
Content/Rules for all slices | |||
   status-reason-extension |
S | 0..1 | CodeableConcept | Reason For Current Status URL: https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/extension-status-reason Binding: IHE ITI Sched Status Reason Codes (preferred): The reason for the current state of the Appointment |
 identifier |
S | 0..* | Identifier | External Ids for this item |
| status |
S | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist |
| serviceType |
S | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: IHE ITI Scheduling Snomed CT Services (extensible) |
| specialty |
S | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: IHE ITI Scheduling Specialties (extensible) |
| start |
S | 1..1 | instant | When appointment is to take place |
| end |
S | 1..1 | instant | When appointment is to conclude |
| participant |
||||
 actor |
S | 1..1 | Reference(Location | Patient | Practitioner | PractitionerRole | HealthcareService) | Person, Location/HealthcareService or Device |
 status |
S | 1..1 | code | accepted | declined | tentative | needs-action |
| requestedPeriod |
S | 1..1 | Period | Potential date/time interval(s) requested to allocate the appointment within |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Appointment.serviceType | extensible | IHE_ITI_Scheduling_Snomed_CT_Serviceshttps://profiles.ihe.net/ITI/Scheduling/ValueSet/sct-servicesfrom this IG | |
| Appointment.specialty | extensible | IHE_ITI_Scheduling_Specialtieshttps://profiles.ihe.net/ITI/Scheduling/ValueSet/specialtyfrom this IG |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Appointment |
C | 0..* | Appointment | 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) app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
Content/Rules for all slices | |||
| status-reason-extension |
S | 0..1 | CodeableConcept | Reason For Current Status URL: https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/extension-status-reason Binding: IHE ITI Sched Status Reason Codes (preferred): The reason for the current state of the Appointment ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 identifier |
SΣ | 0..* | Identifier | External Ids for this item ele-1: All FHIR elements must have a @value or children |
| status |
?!SΣ | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment. ele-1: All FHIR elements must have a @value or children |
| serviceType |
SΣ | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: IHE ITI Scheduling Snomed CT Services (extensible) ele-1: All FHIR elements must have a @value or children |
| specialty |
SΣ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: IHE ITI Scheduling Specialties (extensible) ele-1: All FHIR elements must have a @value or children |
| start |
SΣ | 1..1 | instant | When appointment is to take place ele-1: All FHIR elements must have a @value or children |
| end |
SΣ | 1..1 | instant | When appointment is to conclude ele-1: All FHIR elements must have a @value or children |
| participant |
C | 1..* | BackboneElement | Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| actor |
SΣ | 1..1 | Reference(Location | Patient | Practitioner | PractitionerRole | HealthcareService) | Person, Location/HealthcareService or Device ele-1: All FHIR elements must have a @value or children |
| status |
SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. ele-1: All FHIR elements must have a @value or children |
| requestedPeriod |
S | 1..1 | Period | Potential date/time interval(s) requested to allocate the appointment within ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Appointment.status | required | AppointmentStatushttp://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1from the FHIR Standard | |
| Appointment.serviceType | extensible | IHE_ITI_Scheduling_Snomed_CT_Serviceshttps://profiles.ihe.net/ITI/Scheduling/ValueSet/sct-servicesfrom this IG | |
| Appointment.specialty | extensible | IHE_ITI_Scheduling_Specialtieshttps://profiles.ihe.net/ITI/Scheduling/ValueSet/specialtyfrom this IG | |
| Appointment.participant.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1from the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Appointment |
C | 0..* | Appointment | 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) app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| status-reason-extension |
S | 0..1 | CodeableConcept | Reason For Current Status URL: https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/extension-status-reason Binding: IHE ITI Sched Status Reason Codes (preferred): The reason for the current state of the Appointment | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
SΣ | 0..* | Identifier | External Ids for this item | ||||
| status |
?!SΣ | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment. | ||||
| cancelationReason |
Σ | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example) | ||||
| serviceCategory |
Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) | ||||
| serviceType |
SΣ | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: IHE ITI Scheduling Snomed CT Services (extensible) | ||||
| specialty |
SΣ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: IHE ITI Scheduling Specialties (extensible) | ||||
| appointmentType |
Σ | 0..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred) | ||||
| reasonCode |
Σ | 0..* | CodeableConcept | Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. | ||||
| 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(Resource) | Additional information to support the appointment | |||||
| start |
SΣ | 1..1 | instant | When appointment is to take place | ||||
| end |
SΣ | 1..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 |
C | 1..* | BackboneElement | Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
| actor |
SΣ | 1..1 | Reference(Location | Patient | Practitioner | PractitionerRole | HealthcareService) | Person, Location/HealthcareService or Device | ||||
| required |
Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. | ||||
| status |
SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | ||||
| period |
0..1 | Period | Participation period of the actor | |||||
| requestedPeriod |
S | 1..1 | Period | Potential date/time interval(s) requested to allocate the appointment within | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Appointment.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Appointment.status | required | AppointmentStatushttp://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1from the FHIR Standard | ||||
| Appointment.cancelationReason | example | AppointmentCancellationReasonhttp://hl7.org/fhir/ValueSet/appointment-cancellation-reasonfrom the FHIR Standard | ||||
| Appointment.serviceCategory | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-categoryfrom the FHIR Standard | ||||
| Appointment.serviceType | extensible | IHE_ITI_Scheduling_Snomed_CT_Serviceshttps://profiles.ihe.net/ITI/Scheduling/ValueSet/sct-servicesfrom this IG | ||||
| Appointment.specialty | extensible | IHE_ITI_Scheduling_Specialtieshttps://profiles.ihe.net/ITI/Scheduling/ValueSet/specialtyfrom this IG | ||||
| Appointment.appointmentType | preferred | Hl7VSAppointmentReasonCodeshttp://terminology.hl7.org/ValueSet/v2-0276 | ||||
| Appointment.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reasonfrom the FHIR Standard | ||||
| Appointment.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-typefrom the FHIR Standard | ||||
| Appointment.participant.required | required | ParticipantRequiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1from the FHIR Standard | ||||
| Appointment.participant.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1from the FHIR Standard |
This structure is derived from Appointment
Differential View
This structure is derived from Appointment
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Appointment |
0..* | Appointment | 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) | |
| Slices for extension |
Content/Rules for all slices | |||
| status-reason-extension |
S | 0..1 | CodeableConcept | Reason For Current Status URL: https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/extension-status-reason Binding: IHE ITI Sched Status Reason Codes (preferred): The reason for the current state of the Appointment |
| identifier |
S | 0..* | Identifier | External Ids for this item |
| status |
S | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist |
| serviceType |
S | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: IHE ITI Scheduling Snomed CT Services (extensible) |
| specialty |
S | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: IHE ITI Scheduling Specialties (extensible) |
| start |
S | 1..1 | instant | When appointment is to take place |
| end |
S | 1..1 | instant | When appointment is to conclude |
| participant |
||||
| actor |
S | 1..1 | Reference(Location | Patient | Practitioner | PractitionerRole | HealthcareService) | Person, Location/HealthcareService or Device |
| status |
S | 1..1 | code | accepted | declined | tentative | needs-action |
| requestedPeriod |
S | 1..1 | Period | Potential date/time interval(s) requested to allocate the appointment within |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Appointment.serviceType | extensible | IHE_ITI_Scheduling_Snomed_CT_Serviceshttps://profiles.ihe.net/ITI/Scheduling/ValueSet/sct-servicesfrom this IG | |
| Appointment.specialty | extensible | IHE_ITI_Scheduling_Specialtieshttps://profiles.ihe.net/ITI/Scheduling/ValueSet/specialtyfrom this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Appointment |
C | 0..* | Appointment | 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) app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
Content/Rules for all slices | |||
| status-reason-extension |
S | 0..1 | CodeableConcept | Reason For Current Status URL: https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/extension-status-reason Binding: IHE ITI Sched Status Reason Codes (preferred): The reason for the current state of the Appointment ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| identifier |
SΣ | 0..* | Identifier | External Ids for this item ele-1: All FHIR elements must have a @value or children |
| status |
?!SΣ | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment. ele-1: All FHIR elements must have a @value or children |
| serviceType |
SΣ | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: IHE ITI Scheduling Snomed CT Services (extensible) ele-1: All FHIR elements must have a @value or children |
| specialty |
SΣ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: IHE ITI Scheduling Specialties (extensible) ele-1: All FHIR elements must have a @value or children |
| start |
SΣ | 1..1 | instant | When appointment is to take place ele-1: All FHIR elements must have a @value or children |
| end |
SΣ | 1..1 | instant | When appointment is to conclude ele-1: All FHIR elements must have a @value or children |
| participant |
C | 1..* | BackboneElement | Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| actor |
SΣ | 1..1 | Reference(Location | Patient | Practitioner | PractitionerRole | HealthcareService) | Person, Location/HealthcareService or Device ele-1: All FHIR elements must have a @value or children |
| status |
SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. ele-1: All FHIR elements must have a @value or children |
| requestedPeriod |
S | 1..1 | Period | Potential date/time interval(s) requested to allocate the appointment within ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Appointment.status | required | AppointmentStatushttp://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1from the FHIR Standard | |
| Appointment.serviceType | extensible | IHE_ITI_Scheduling_Snomed_CT_Serviceshttps://profiles.ihe.net/ITI/Scheduling/ValueSet/sct-servicesfrom this IG | |
| Appointment.specialty | extensible | IHE_ITI_Scheduling_Specialtieshttps://profiles.ihe.net/ITI/Scheduling/ValueSet/specialtyfrom this IG | |
| Appointment.participant.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1from the FHIR Standard |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Appointment |
C | 0..* | Appointment | 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) app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| status-reason-extension |
S | 0..1 | CodeableConcept | Reason For Current Status URL: https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/extension-status-reason Binding: IHE ITI Sched Status Reason Codes (preferred): The reason for the current state of the Appointment | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
SΣ | 0..* | Identifier | External Ids for this item | ||||
| status |
?!SΣ | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment. | ||||
| cancelationReason |
Σ | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example) | ||||
| serviceCategory |
Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) | ||||
| serviceType |
SΣ | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: IHE ITI Scheduling Snomed CT Services (extensible) | ||||
| specialty |
SΣ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: IHE ITI Scheduling Specialties (extensible) | ||||
| appointmentType |
Σ | 0..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred) | ||||
| reasonCode |
Σ | 0..* | CodeableConcept | Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. | ||||
| 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(Resource) | Additional information to support the appointment | |||||
| start |
SΣ | 1..1 | instant | When appointment is to take place | ||||
| end |
SΣ | 1..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 |
C | 1..* | BackboneElement | Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type |
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
| actor |
SΣ | 1..1 | Reference(Location | Patient | Practitioner | PractitionerRole | HealthcareService) | Person, Location/HealthcareService or Device | ||||
| required |
Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. | ||||
| status |
SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | ||||
| period |
0..1 | Period | Participation period of the actor | |||||
| requestedPeriod |
S | 1..1 | Period | Potential date/time interval(s) requested to allocate the appointment within | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Appointment.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| Appointment.status | required | AppointmentStatushttp://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1from the FHIR Standard | ||||
| Appointment.cancelationReason | example | AppointmentCancellationReasonhttp://hl7.org/fhir/ValueSet/appointment-cancellation-reasonfrom the FHIR Standard | ||||
| Appointment.serviceCategory | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-categoryfrom the FHIR Standard | ||||
| Appointment.serviceType | extensible | IHE_ITI_Scheduling_Snomed_CT_Serviceshttps://profiles.ihe.net/ITI/Scheduling/ValueSet/sct-servicesfrom this IG | ||||
| Appointment.specialty | extensible | IHE_ITI_Scheduling_Specialtieshttps://profiles.ihe.net/ITI/Scheduling/ValueSet/specialtyfrom this IG | ||||
| Appointment.appointmentType | preferred | Hl7VSAppointmentReasonCodeshttp://terminology.hl7.org/ValueSet/v2-0276 | ||||
| Appointment.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reasonfrom the FHIR Standard | ||||
| Appointment.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-typefrom the FHIR Standard | ||||
| Appointment.participant.required | required | ParticipantRequiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1from the FHIR Standard | ||||
| Appointment.participant.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1from the FHIR Standard |
This structure is derived from Appointment
Other representations of profile: CSV, Excel, Schematron
IG © 2024+ IHE IT Infrastructure Technical Committee. Package ihe.iti.scheduling#1.0.1-current based on FHIR 4.0.1. Generated 2024-12-16
Links: Table of Contents |
QA Report
| New Issue | Issues
Version History |
|
Propose a change