ITB - Online appointment booking service, published by Service Well AB. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/servicewell/servicewell.fhir.wof-portal/ and changes regularly. See the Directory of published versions
| Official URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/portal-available-appointment | Version: 1.0.0 | |||
| Active as of 2026-04-20 | Computable Name: PortalAvailableAppointment | |||
The public API model for 'Available Appointments'
Appointment representation of an available appointment.
Inherits IHE Scheduling Appointment.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | WofBaseAppointment | 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 | ||||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||||
![]() ![]() ![]() |
SOΣ | 0..1 | id | Server-managed resource version
| ||||||
![]() ![]() ![]() |
SOΣ | 1..* | canonical(StructureDefinition) | Profile declaration for this portal resource Required Pattern: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/portal-available-appointment
| ||||||
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() |
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 | ||||||
![]() ![]() ![]() |
1..1 | Reference() | ActivityDefinitionReference URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/activity-definition-reference | |||||||
![]() ![]() |
SΣ | 2..* | Identifier | External Ids for this item Slice: Unordered, Open by value:type.text | ||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||
![]() ![]() ![]() ![]() |
OΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
| ||||||
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | External Ids for this item | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identifier-based reference to the Appointment concept in the source system. Example General: http://www.acme.com/identifiers/patient | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Source systems identifier for the appointment Example General: 123456 | ||||||
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | External Ids for this item | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/slot-id | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||||
![]() ![]() |
?!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. Required Pattern: proposed | ||||||
![]() ![]() |
SΣ | 1..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: IHE ITI Scheduling Snomed CT Services (extensible) | ||||||
![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system | ||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system | ||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system | ||||||
![]() ![]() |
SΣ | 1..1 | instant | When appointment is to take place | ||||||
![]() ![]() |
SΣ | 1..1 | instant | When appointment is to conclude | ||||||
![]() ![]() |
C | 1..* | BackboneElement | Participants involved in appointment Slice: Unordered, Open by type:actor Constraints: app-1 | ||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(Location | Patient | Practitioner | PractitionerRole | HealthcareService) | Person, Location/HealthcareService or Device | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | ||||||
![]() ![]() ![]() |
C | 0..1 | BackboneElement | Participants involved in appointment Constraints: app-1 | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(HealthcareServicePortal) | Person, Location/HealthcareService or Device | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | ||||||
![]() ![]() ![]() |
C | 0..1 | BackboneElement | Participants involved in appointment Constraints: app-1 | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(PractitionerRolePortal) | Person, Location/HealthcareService or Device | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | ||||||
![]() ![]() |
S | 1..1 | Period | Potential date/time interval(s) requested to allocate the appointment within | ||||||
![]() ![]() ![]() |
ΣC | 1..1 | dateTime | Starting time with inclusive boundary | ||||||
![]() ![]() ![]() |
ΣC | 1..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||||
Documentation for this format | ||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Appointment.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Appointment.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Appointment.identifier:sourceSystemIdentifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Appointment.identifier:slot-id.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Appointment.status | Base | required | AppointmentStatus | 📍4.0.1 | FHIR Std. |
| Appointment.serviceType | Base | extensible | IHE ITI Scheduling Snomed CT Services | 📦1.0.0 | Scheduling v1.0 |
| Appointment.participant.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Appointment.participant:healthcareService.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Appointment.participant:practitionerRole.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| app-1 | error | Appointment.participant, Appointment.participant:healthcareService, Appointment.participant:practitionerRole | Either the type or actor on the participant SHALL be specified |
type.exists() or actor.exists()
|
| app-2 | error | Appointment | Either start and end are specified, or neither |
start.exists() = end.exists()
|
| app-3 | error | Appointment | Only proposed or cancelled appointments can be missing start/end dates |
(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
|
| app-4 | error | Appointment | Cancelation reason is only used for appointments that have been cancelled, or no-show |
Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
|
| dom-2 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Appointment | 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 |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Appointment | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from WofBaseAppointment
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | WofBaseAppointment | 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) | |||||
![]() ![]() |
||||||||
![]() ![]() ![]() |
0..1 | id | Server-managed resource version | |||||
![]() ![]() ![]() |
1..* | canonical(StructureDefinition) | Profile declaration for this portal resource Required Pattern: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/portal-available-appointment | |||||
![]() ![]() |
1..* | Extension | Extension | |||||
![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() |
1..1 | Reference() | ActivityDefinitionReference URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/activity-definition-reference | |||||
![]() ![]() |
2..* | Identifier | External Ids for this item Slice: Unordered, Open by value:type.text | |||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
O | 0..1 | CodeableConcept | Description of identifier
| ||||
![]() ![]() ![]() |
1..1 | Identifier | External Ids for this item | |||||
![]() ![]() ![]() ![]() |
||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Plain text representation of the concept Required Pattern: source systems appointment concept | |||||
![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identifier-based reference to the Appointment concept in the source system. | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | string | Source systems identifier for the appointment | ||||
![]() ![]() ![]() |
S | 1..1 | Identifier | External Ids for this item | ||||
![]() ![]() ![]() ![]() |
||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Plain text representation of the concept Required Pattern: id for the available slot | |||||
![]() ![]() ![]() ![]() |
0..1 | uri | The namespace for the identifier value Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/slot-id | |||||
![]() ![]() ![]() ![]() |
S | 1..1 | string | The value that is unique | ||||
![]() ![]() |
1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Required Pattern: proposed | |||||
![]() ![]() |
0..0 | A broad categorization of the service that is to be performed during this appointment | ||||||
![]() ![]() |
1..* | CodeableConcept | The specific service that is to be performed during this appointment | |||||
![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system | |||||
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |||||
![]() ![]() |
0..0 | Coded reason this appointment is scheduled | ||||||
![]() ![]() |
0..0 | Additional comments | ||||||
![]() ![]() |
1..* | BackboneElement | Participants involved in appointment Slice: Unordered, Open by type:actor | |||||
![]() ![]() ![]() |
0..1 | BackboneElement | Participants involved in appointment | |||||
![]() ![]() ![]() ![]() |
1..1 | Reference(HealthcareServicePortal) | Person, Location/HealthcareService or Device | |||||
![]() ![]() ![]() |
0..1 | BackboneElement | Participants involved in appointment | |||||
![]() ![]() ![]() ![]() |
1..1 | Reference(PractitionerRolePortal) | Person, Location/HealthcareService or Device | |||||
![]() ![]() |
||||||||
![]() ![]() ![]() |
1..1 | dateTime | Starting time with inclusive boundary | |||||
![]() ![]() ![]() |
1..1 | dateTime | End time with inclusive boundary, if not ongoing | |||||
Documentation for this format | ||||||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | WofBaseAppointment | 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 | ||||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() |
SOΣ | 0..1 | id | Server-managed resource version
| ||||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||||
![]() ![]() ![]() |
SOΣ | 1..* | canonical(StructureDefinition) | Profile declaration for this portal resource Required Pattern: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/portal-available-appointment
| ||||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() |
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 | ||||||
![]() ![]() ![]() |
1..1 | Reference() | ActivityDefinitionReference URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/activity-definition-reference | |||||||
![]() ![]() |
SΣ | 2..* | Identifier | External Ids for this item Slice: Unordered, Open by value:type.text | ||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||
![]() ![]() ![]() ![]() |
OΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
| ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||||
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | External Ids for this item | ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||
![]() ![]() ![]() ![]() |
OΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
| ||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Plain text representation of the concept Required Pattern: source systems appointment concept | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identifier-based reference to the Appointment concept in the source system. Example General: http://www.acme.com/identifiers/patient | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Source systems identifier for the appointment Example General: 123456 | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||||
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | External Ids for this item | ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||
![]() ![]() ![]() ![]() |
OΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
| ||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Plain text representation of the concept Required Pattern: id for the available slot | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/slot-id | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||||
![]() ![]() |
?!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. Required Pattern: proposed | ||||||
![]() ![]() |
SΣ | 1..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: IHE ITI Scheduling Snomed CT Services (extensible) | ||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system | ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||||
![]() ![]() |
SΣ | 1..1 | instant | When appointment is to take place | ||||||
![]() ![]() |
SΣ | 1..1 | instant | When appointment is to conclude | ||||||
![]() ![]() |
C | 1..* | BackboneElement | Participants involved in appointment Slice: Unordered, Open by type:actor Constraints: app-1 | ||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(Location | Patient | Practitioner | PractitionerRole | HealthcareService) | Person, Location/HealthcareService or Device | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | ||||||
![]() ![]() ![]() ![]() |
0..1 | Period | Participation period of the actor | |||||||
![]() ![]() ![]() |
C | 0..1 | BackboneElement | Participants involved in appointment Constraints: app-1 | ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(HealthcareServicePortal) | Person, Location/HealthcareService or Device | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | ||||||
![]() ![]() ![]() ![]() |
0..1 | Period | Participation period of the actor | |||||||
![]() ![]() ![]() |
C | 0..1 | BackboneElement | Participants involved in appointment Constraints: app-1 | ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(PractitionerRolePortal) | Person, Location/HealthcareService or Device | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | ||||||
![]() ![]() ![]() ![]() |
0..1 | Period | Participation period of the actor | |||||||
![]() ![]() |
S | 1..1 | Period | Potential date/time interval(s) requested to allocate the appointment within | ||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() |
ΣC | 1..1 | dateTime | Starting time with inclusive boundary | ||||||
![]() ![]() ![]() |
ΣC | 1..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||||
Documentation for this format | ||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Appointment.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Appointment.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Appointment.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| Appointment.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Appointment.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Appointment.identifier:sourceSystemIdentifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Appointment.identifier:sourceSystemIdentifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Appointment.identifier:slot-id.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Appointment.identifier:slot-id.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Appointment.status | Base | required | AppointmentStatus | 📍4.0.1 | FHIR Std. |
| Appointment.serviceType | Base | extensible | IHE ITI Scheduling Snomed CT Services | 📦1.0.0 | Scheduling v1.0 |
| Appointment.participant.type | Base | extensible | Participant type | 📦4.0.1 | FHIR Std. |
| Appointment.participant.required | Base | required | ParticipantRequired | 📍4.0.1 | FHIR Std. |
| Appointment.participant.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Appointment.participant:healthcareService.type | Base | extensible | Participant type | 📦4.0.1 | FHIR Std. |
| Appointment.participant:healthcareService.required | Base | required | ParticipantRequired | 📍4.0.1 | FHIR Std. |
| Appointment.participant:healthcareService.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Appointment.participant:practitionerRole.type | Base | extensible | Participant type | 📦4.0.1 | FHIR Std. |
| Appointment.participant:practitionerRole.required | Base | required | ParticipantRequired | 📍4.0.1 | FHIR Std. |
| Appointment.participant:practitionerRole.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| app-1 | error | Appointment.participant, Appointment.participant:healthcareService, Appointment.participant:practitionerRole | Either the type or actor on the participant SHALL be specified |
type.exists() or actor.exists()
|
| app-2 | error | Appointment | Either start and end are specified, or neither |
start.exists() = end.exists()
|
| app-3 | error | Appointment | Only proposed or cancelled appointments can be missing start/end dates |
(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
|
| app-4 | error | Appointment | Cancelation reason is only used for appointments that have been cancelled, or no-show |
Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
|
| dom-2 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Appointment | 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 |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Appointment | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from WofBaseAppointment
Summary
Mandatory: 13 elements(2 nested mandatory elements)
Must-Support: 4 elements
Prohibited: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | WofBaseAppointment | 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 | ||||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||||
![]() ![]() ![]() |
SOΣ | 0..1 | id | Server-managed resource version
| ||||||
![]() ![]() ![]() |
SOΣ | 1..* | canonical(StructureDefinition) | Profile declaration for this portal resource Required Pattern: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/portal-available-appointment
| ||||||
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() |
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 | ||||||
![]() ![]() ![]() |
1..1 | Reference() | ActivityDefinitionReference URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/activity-definition-reference | |||||||
![]() ![]() |
SΣ | 2..* | Identifier | External Ids for this item Slice: Unordered, Open by value:type.text | ||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||
![]() ![]() ![]() ![]() |
OΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
| ||||||
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | External Ids for this item | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identifier-based reference to the Appointment concept in the source system. Example General: http://www.acme.com/identifiers/patient | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Source systems identifier for the appointment Example General: 123456 | ||||||
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | External Ids for this item | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/slot-id | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||||
![]() ![]() |
?!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. Required Pattern: proposed | ||||||
![]() ![]() |
SΣ | 1..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: IHE ITI Scheduling Snomed CT Services (extensible) | ||||||
![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system | ||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system | ||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system | ||||||
![]() ![]() |
SΣ | 1..1 | instant | When appointment is to take place | ||||||
![]() ![]() |
SΣ | 1..1 | instant | When appointment is to conclude | ||||||
![]() ![]() |
C | 1..* | BackboneElement | Participants involved in appointment Slice: Unordered, Open by type:actor Constraints: app-1 | ||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(Location | Patient | Practitioner | PractitionerRole | HealthcareService) | Person, Location/HealthcareService or Device | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | ||||||
![]() ![]() ![]() |
C | 0..1 | BackboneElement | Participants involved in appointment Constraints: app-1 | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(HealthcareServicePortal) | Person, Location/HealthcareService or Device | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | ||||||
![]() ![]() ![]() |
C | 0..1 | BackboneElement | Participants involved in appointment Constraints: app-1 | ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(PractitionerRolePortal) | Person, Location/HealthcareService or Device | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | ||||||
![]() ![]() |
S | 1..1 | Period | Potential date/time interval(s) requested to allocate the appointment within | ||||||
![]() ![]() ![]() |
ΣC | 1..1 | dateTime | Starting time with inclusive boundary | ||||||
![]() ![]() ![]() |
ΣC | 1..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||||
Documentation for this format | ||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Appointment.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Appointment.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Appointment.identifier:sourceSystemIdentifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Appointment.identifier:slot-id.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Appointment.status | Base | required | AppointmentStatus | 📍4.0.1 | FHIR Std. |
| Appointment.serviceType | Base | extensible | IHE ITI Scheduling Snomed CT Services | 📦1.0.0 | Scheduling v1.0 |
| Appointment.participant.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Appointment.participant:healthcareService.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Appointment.participant:practitionerRole.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| app-1 | error | Appointment.participant, Appointment.participant:healthcareService, Appointment.participant:practitionerRole | Either the type or actor on the participant SHALL be specified |
type.exists() or actor.exists()
|
| app-2 | error | Appointment | Either start and end are specified, or neither |
start.exists() = end.exists()
|
| app-3 | error | Appointment | Only proposed or cancelled appointments can be missing start/end dates |
(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
|
| app-4 | error | Appointment | Cancelation reason is only used for appointments that have been cancelled, or no-show |
Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
|
| dom-2 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Appointment | 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 |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Appointment | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from WofBaseAppointment
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | WofBaseAppointment | 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) | |||||
![]() ![]() |
||||||||
![]() ![]() ![]() |
0..1 | id | Server-managed resource version | |||||
![]() ![]() ![]() |
1..* | canonical(StructureDefinition) | Profile declaration for this portal resource Required Pattern: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/portal-available-appointment | |||||
![]() ![]() |
1..* | Extension | Extension | |||||
![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() |
1..1 | Reference() | ActivityDefinitionReference URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/activity-definition-reference | |||||
![]() ![]() |
2..* | Identifier | External Ids for this item Slice: Unordered, Open by value:type.text | |||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
O | 0..1 | CodeableConcept | Description of identifier
| ||||
![]() ![]() ![]() |
1..1 | Identifier | External Ids for this item | |||||
![]() ![]() ![]() ![]() |
||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Plain text representation of the concept Required Pattern: source systems appointment concept | |||||
![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identifier-based reference to the Appointment concept in the source system. | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | string | Source systems identifier for the appointment | ||||
![]() ![]() ![]() |
S | 1..1 | Identifier | External Ids for this item | ||||
![]() ![]() ![]() ![]() |
||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Plain text representation of the concept Required Pattern: id for the available slot | |||||
![]() ![]() ![]() ![]() |
0..1 | uri | The namespace for the identifier value Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/slot-id | |||||
![]() ![]() ![]() ![]() |
S | 1..1 | string | The value that is unique | ||||
![]() ![]() |
1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Required Pattern: proposed | |||||
![]() ![]() |
0..0 | A broad categorization of the service that is to be performed during this appointment | ||||||
![]() ![]() |
1..* | CodeableConcept | The specific service that is to be performed during this appointment | |||||
![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system | |||||
![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |||||
![]() ![]() |
0..0 | Coded reason this appointment is scheduled | ||||||
![]() ![]() |
0..0 | Additional comments | ||||||
![]() ![]() |
1..* | BackboneElement | Participants involved in appointment Slice: Unordered, Open by type:actor | |||||
![]() ![]() ![]() |
0..1 | BackboneElement | Participants involved in appointment | |||||
![]() ![]() ![]() ![]() |
1..1 | Reference(HealthcareServicePortal) | Person, Location/HealthcareService or Device | |||||
![]() ![]() ![]() |
0..1 | BackboneElement | Participants involved in appointment | |||||
![]() ![]() ![]() ![]() |
1..1 | Reference(PractitionerRolePortal) | Person, Location/HealthcareService or Device | |||||
![]() ![]() |
||||||||
![]() ![]() ![]() |
1..1 | dateTime | Starting time with inclusive boundary | |||||
![]() ![]() ![]() |
1..1 | dateTime | End time with inclusive boundary, if not ongoing | |||||
Documentation for this format | ||||||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | WofBaseAppointment | 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 | ||||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() |
SOΣ | 0..1 | id | Server-managed resource version
| ||||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||||
![]() ![]() ![]() |
SOΣ | 1..* | canonical(StructureDefinition) | Profile declaration for this portal resource Required Pattern: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/portal-available-appointment
| ||||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() |
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 | ||||||
![]() ![]() ![]() |
1..1 | Reference() | ActivityDefinitionReference URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/activity-definition-reference | |||||||
![]() ![]() |
SΣ | 2..* | Identifier | External Ids for this item Slice: Unordered, Open by value:type.text | ||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||
![]() ![]() ![]() ![]() |
OΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
| ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||||
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | External Ids for this item | ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||
![]() ![]() ![]() ![]() |
OΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
| ||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Plain text representation of the concept Required Pattern: source systems appointment concept | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identifier-based reference to the Appointment concept in the source system. Example General: http://www.acme.com/identifiers/patient | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Source systems identifier for the appointment Example General: 123456 | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||||
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | External Ids for this item | ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||
![]() ![]() ![]() ![]() |
OΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
| ||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Plain text representation of the concept Required Pattern: id for the available slot | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/slot-id | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||||
![]() ![]() |
?!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. Required Pattern: proposed | ||||||
![]() ![]() |
SΣ | 1..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: IHE ITI Scheduling Snomed CT Services (extensible) | ||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() |
Σ | 1..* | Coding | Code defined by a terminology system | ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||||
![]() ![]() |
SΣ | 1..1 | instant | When appointment is to take place | ||||||
![]() ![]() |
SΣ | 1..1 | instant | When appointment is to conclude | ||||||
![]() ![]() |
C | 1..* | BackboneElement | Participants involved in appointment Slice: Unordered, Open by type:actor Constraints: app-1 | ||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(Location | Patient | Practitioner | PractitionerRole | HealthcareService) | Person, Location/HealthcareService or Device | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | ||||||
![]() ![]() ![]() ![]() |
0..1 | Period | Participation period of the actor | |||||||
![]() ![]() ![]() |
C | 0..1 | BackboneElement | Participants involved in appointment Constraints: app-1 | ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(HealthcareServicePortal) | Person, Location/HealthcareService or Device | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | ||||||
![]() ![]() ![]() ![]() |
0..1 | Period | Participation period of the actor | |||||||
![]() ![]() ![]() |
C | 0..1 | BackboneElement | Participants involved in appointment Constraints: app-1 | ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(PractitionerRolePortal) | Person, Location/HealthcareService or Device | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. | ||||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | ||||||
![]() ![]() ![]() ![]() |
0..1 | Period | Participation period of the actor | |||||||
![]() ![]() |
S | 1..1 | Period | Potential date/time interval(s) requested to allocate the appointment within | ||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
![]() ![]() ![]() |
ΣC | 1..1 | dateTime | Starting time with inclusive boundary | ||||||
![]() ![]() ![]() |
ΣC | 1..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||||
Documentation for this format | ||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Appointment.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Appointment.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Appointment.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| Appointment.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Appointment.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Appointment.identifier:sourceSystemIdentifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Appointment.identifier:sourceSystemIdentifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Appointment.identifier:slot-id.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Appointment.identifier:slot-id.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Appointment.status | Base | required | AppointmentStatus | 📍4.0.1 | FHIR Std. |
| Appointment.serviceType | Base | extensible | IHE ITI Scheduling Snomed CT Services | 📦1.0.0 | Scheduling v1.0 |
| Appointment.participant.type | Base | extensible | Participant type | 📦4.0.1 | FHIR Std. |
| Appointment.participant.required | Base | required | ParticipantRequired | 📍4.0.1 | FHIR Std. |
| Appointment.participant.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Appointment.participant:healthcareService.type | Base | extensible | Participant type | 📦4.0.1 | FHIR Std. |
| Appointment.participant:healthcareService.required | Base | required | ParticipantRequired | 📍4.0.1 | FHIR Std. |
| Appointment.participant:healthcareService.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Appointment.participant:practitionerRole.type | Base | extensible | Participant type | 📦4.0.1 | FHIR Std. |
| Appointment.participant:practitionerRole.required | Base | required | ParticipantRequired | 📍4.0.1 | FHIR Std. |
| Appointment.participant:practitionerRole.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| app-1 | error | Appointment.participant, Appointment.participant:healthcareService, Appointment.participant:practitionerRole | Either the type or actor on the participant SHALL be specified |
type.exists() or actor.exists()
|
| app-2 | error | Appointment | Either start and end are specified, or neither |
start.exists() = end.exists()
|
| app-3 | error | Appointment | Only proposed or cancelled appointments can be missing start/end dates |
(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
|
| app-4 | error | Appointment | Cancelation reason is only used for appointments that have been cancelled, or no-show |
Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
|
| dom-2 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Appointment | 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 |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Appointment | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from WofBaseAppointment
Summary
Mandatory: 13 elements(2 nested mandatory elements)
Must-Support: 4 elements
Prohibited: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron