ITB - Online appointment booking service
1.0.0 - Initial Release

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

Resource Profile: Available Appointment Portal

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

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Appointment 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
... meta Σ 0..1 Meta Metadata about the resource
.... versionId SOΣ 0..1 id Server-managed resource version
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base Appointment
.... profile SOΣ 1..* canonical(StructureDefinition) Profile declaration for this portal resource

Required Pattern: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/portal-available-appointment
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base Appointment
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension: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
.... extension:activityDefinitionReference 1..1 Reference() ActivityDefinitionReference
URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/activity-definition-reference
... Slices for identifier SΣ 2..* Identifier External Ids for this item
Slice: Unordered, Open by value:type.text
.... identifier:All Slices Content/Rules for all slices
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type 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.
ObligationsActor
SHOULD:ignore https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client
.... identifier:sourceSystemIdentifier SΣ 1..1 Identifier External Ids for this item
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system SΣ 1..1 uri Identifier-based reference to the Appointment concept in the source system.
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string Source systems identifier for the appointment
Example General: 123456
.... identifier:slot-id SΣ 1..1 Identifier External Ids for this item
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/slot-id
..... value SΣ 1..1 string The value that is unique
Example General: 123456
... serviceType SΣ 1..* CodeableConcept The specific service that is to be performed during this appointment
Binding: IHE ITI Scheduling Snomed CT Services (extensible)
.... coding Σ 1..* Coding Code defined by a terminology system
..... system Σ 1..1 uri Identity of the terminology system
..... code Σ 1..1 code Symbol in syntax defined by the system
... start SΣ 1..1 instant When appointment is to take place
... end SΣ 1..1 instant When appointment is to conclude
... Slices for participant C 1..* BackboneElement Participants involved in appointment
Slice: Unordered, Open by type:actor
Constraints: app-1
.... participant:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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
Binding: ParticipationStatus (required): The Participation status of an appointment.
.... participant:healthcareService C 0..1 BackboneElement Participants involved in appointment
Constraints: app-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor SΣ 1..1 Reference(HealthcareServicePortal) Person, Location/HealthcareService or Device
..... status SΣ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
.... participant:practitionerRole C 0..1 BackboneElement Participants involved in appointment
Constraints: app-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor SΣ 1..1 Reference(PractitionerRolePortal) Person, Location/HealthcareService or Device
..... status SΣ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
... requestedPeriod S 1..1 Period Potential date/time interval(s) requested to allocate the appointment within
.... start ΣC 1..1 dateTime Starting time with inclusive boundary
.... end ΣC 1..1 dateTime End time with inclusive boundary, if not ongoing

doco Documentation for this format

Terminology Bindings

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.

Constraints

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Appointment 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)
... meta
.... versionId 0..1 id Server-managed resource version
.... profile 1..* canonical(StructureDefinition) Profile declaration for this portal resource
Required Pattern: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/portal-available-appointment
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:activityDefinitionReference 1..1 Reference() ActivityDefinitionReference
URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/activity-definition-reference
.... identifier:All Slices Content/Rules for all slices
..... type O 0..1 CodeableConcept Description of identifier
ObligationsActor
SHOULD:ignore https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client
.... identifier:sourceSystemIdentifier 1..1 Identifier External Ids for this item
..... type
...... text 1..1 string Plain text representation of the concept
Required Pattern: source systems appointment concept
..... system S 1..1 uri Identifier-based reference to the Appointment concept in the source system.
..... value S 1..1 string Source systems identifier for the appointment
.... identifier:slot-id S 1..1 Identifier External Ids for this item
..... type
...... text 1..1 string Plain text representation of the concept
Required Pattern: id for the available slot
..... system 0..1 uri The namespace for the identifier value
Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/slot-id
..... value S 1..1 string The value that is unique
... status 1..1 code proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
Required Pattern: proposed
... serviceCategory 0..0 A broad categorization of the service that is to be performed during this appointment
... serviceType 1..* CodeableConcept The specific service that is to be performed during this appointment
.... coding 1..* Coding Code defined by a terminology system
..... system 1..1 uri Identity of the terminology system
..... code 1..1 code Symbol in syntax defined by the system
... reasonCode 0..0 Coded reason this appointment is scheduled
... comment 0..0 Additional comments
... Slices for participant 1..* BackboneElement Participants involved in appointment
Slice: Unordered, Open by type:actor
.... participant:healthcareService 0..1 BackboneElement Participants involved in appointment
..... actor 1..1 Reference(HealthcareServicePortal) Person, Location/HealthcareService or Device
.... participant:practitionerRole 0..1 BackboneElement Participants involved in appointment
..... actor 1..1 Reference(PractitionerRolePortal) Person, Location/HealthcareService or Device
... requestedPeriod
.... start 1..1 dateTime Starting time with inclusive boundary
.... end 1..1 dateTime End time with inclusive boundary, if not ongoing

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Appointment 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
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SOΣ 0..1 id Server-managed resource version
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base Appointment
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile SOΣ 1..* canonical(StructureDefinition) Profile declaration for this portal resource

Required Pattern: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/portal-available-appointment
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base Appointment
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 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".
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
.... extension: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
.... extension:activityDefinitionReference 1..1 Reference() ActivityDefinitionReference
URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/activity-definition-reference
... Slices for identifier SΣ 2..* Identifier External Ids for this item
Slice: Unordered, Open by value:type.text
.... identifier:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type 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.
ObligationsActor
SHOULD:ignore https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:sourceSystemIdentifier SΣ 1..1 Identifier External Ids for this item
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type 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.
ObligationsActor
SHOULD:ignore https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
...... text Σ 1..1 string Plain text representation of the concept
Required Pattern: source systems appointment concept
..... system SΣ 1..1 uri Identifier-based reference to the Appointment concept in the source system.
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string Source systems identifier for the appointment
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:slot-id SΣ 1..1 Identifier External Ids for this item
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type 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.
ObligationsActor
SHOULD:ignore https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
...... text Σ 1..1 string Plain text representation of the concept
Required Pattern: id for the available slot
..... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/slot-id
..... value SΣ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... 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.
Required Pattern: proposed
... serviceType SΣ 1..* CodeableConcept The specific service that is to be performed during this appointment
Binding: IHE ITI Scheduling Snomed CT Services (extensible)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 1..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... start SΣ 1..1 instant When appointment is to take place
... end SΣ 1..1 instant When appointment is to conclude
... Slices for participant C 1..* BackboneElement Participants involved in appointment
Slice: Unordered, Open by type:actor
Constraints: app-1
.... participant:All Slices Content/Rules for all slices
..... 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
.... participant:healthcareService C 0..1 BackboneElement Participants involved in appointment
Constraints: app-1
..... 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(HealthcareServicePortal) 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
.... participant:practitionerRole C 0..1 BackboneElement Participants involved in appointment
Constraints: app-1
..... 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(PractitionerRolePortal) 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
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... start ΣC 1..1 dateTime Starting time with inclusive boundary
.... end ΣC 1..1 dateTime End time with inclusive boundary, if not ongoing

doco Documentation for this format

Terminology Bindings

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.

Constraints

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:

  • The element 1 is sliced based on the value of Appointment.identifier
  • The element 1 is sliced based on the value of Appointment.participant

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Appointment 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
... meta Σ 0..1 Meta Metadata about the resource
.... versionId SOΣ 0..1 id Server-managed resource version
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base Appointment
.... profile SOΣ 1..* canonical(StructureDefinition) Profile declaration for this portal resource

Required Pattern: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/portal-available-appointment
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base Appointment
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension: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
.... extension:activityDefinitionReference 1..1 Reference() ActivityDefinitionReference
URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/activity-definition-reference
... Slices for identifier SΣ 2..* Identifier External Ids for this item
Slice: Unordered, Open by value:type.text
.... identifier:All Slices Content/Rules for all slices
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type 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.
ObligationsActor
SHOULD:ignore https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client
.... identifier:sourceSystemIdentifier SΣ 1..1 Identifier External Ids for this item
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system SΣ 1..1 uri Identifier-based reference to the Appointment concept in the source system.
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string Source systems identifier for the appointment
Example General: 123456
.... identifier:slot-id SΣ 1..1 Identifier External Ids for this item
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/slot-id
..... value SΣ 1..1 string The value that is unique
Example General: 123456
... serviceType SΣ 1..* CodeableConcept The specific service that is to be performed during this appointment
Binding: IHE ITI Scheduling Snomed CT Services (extensible)
.... coding Σ 1..* Coding Code defined by a terminology system
..... system Σ 1..1 uri Identity of the terminology system
..... code Σ 1..1 code Symbol in syntax defined by the system
... start SΣ 1..1 instant When appointment is to take place
... end SΣ 1..1 instant When appointment is to conclude
... Slices for participant C 1..* BackboneElement Participants involved in appointment
Slice: Unordered, Open by type:actor
Constraints: app-1
.... participant:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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
Binding: ParticipationStatus (required): The Participation status of an appointment.
.... participant:healthcareService C 0..1 BackboneElement Participants involved in appointment
Constraints: app-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor SΣ 1..1 Reference(HealthcareServicePortal) Person, Location/HealthcareService or Device
..... status SΣ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
.... participant:practitionerRole C 0..1 BackboneElement Participants involved in appointment
Constraints: app-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor SΣ 1..1 Reference(PractitionerRolePortal) Person, Location/HealthcareService or Device
..... status SΣ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
... requestedPeriod S 1..1 Period Potential date/time interval(s) requested to allocate the appointment within
.... start ΣC 1..1 dateTime Starting time with inclusive boundary
.... end ΣC 1..1 dateTime End time with inclusive boundary, if not ongoing

doco Documentation for this format

Terminology Bindings

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.

Constraints

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Appointment 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)
... meta
.... versionId 0..1 id Server-managed resource version
.... profile 1..* canonical(StructureDefinition) Profile declaration for this portal resource
Required Pattern: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/portal-available-appointment
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:activityDefinitionReference 1..1 Reference() ActivityDefinitionReference
URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/activity-definition-reference
.... identifier:All Slices Content/Rules for all slices
..... type O 0..1 CodeableConcept Description of identifier
ObligationsActor
SHOULD:ignore https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client
.... identifier:sourceSystemIdentifier 1..1 Identifier External Ids for this item
..... type
...... text 1..1 string Plain text representation of the concept
Required Pattern: source systems appointment concept
..... system S 1..1 uri Identifier-based reference to the Appointment concept in the source system.
..... value S 1..1 string Source systems identifier for the appointment
.... identifier:slot-id S 1..1 Identifier External Ids for this item
..... type
...... text 1..1 string Plain text representation of the concept
Required Pattern: id for the available slot
..... system 0..1 uri The namespace for the identifier value
Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/slot-id
..... value S 1..1 string The value that is unique
... status 1..1 code proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
Required Pattern: proposed
... serviceCategory 0..0 A broad categorization of the service that is to be performed during this appointment
... serviceType 1..* CodeableConcept The specific service that is to be performed during this appointment
.... coding 1..* Coding Code defined by a terminology system
..... system 1..1 uri Identity of the terminology system
..... code 1..1 code Symbol in syntax defined by the system
... reasonCode 0..0 Coded reason this appointment is scheduled
... comment 0..0 Additional comments
... Slices for participant 1..* BackboneElement Participants involved in appointment
Slice: Unordered, Open by type:actor
.... participant:healthcareService 0..1 BackboneElement Participants involved in appointment
..... actor 1..1 Reference(HealthcareServicePortal) Person, Location/HealthcareService or Device
.... participant:practitionerRole 0..1 BackboneElement Participants involved in appointment
..... actor 1..1 Reference(PractitionerRolePortal) Person, Location/HealthcareService or Device
... requestedPeriod
.... start 1..1 dateTime Starting time with inclusive boundary
.... end 1..1 dateTime End time with inclusive boundary, if not ongoing

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Appointment 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
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SOΣ 0..1 id Server-managed resource version
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base Appointment
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile SOΣ 1..* canonical(StructureDefinition) Profile declaration for this portal resource

Required Pattern: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/portal-available-appointment
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base Appointment
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 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".
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
.... extension: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
.... extension:activityDefinitionReference 1..1 Reference() ActivityDefinitionReference
URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/activity-definition-reference
... Slices for identifier SΣ 2..* Identifier External Ids for this item
Slice: Unordered, Open by value:type.text
.... identifier:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type 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.
ObligationsActor
SHOULD:ignore https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:sourceSystemIdentifier SΣ 1..1 Identifier External Ids for this item
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type 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.
ObligationsActor
SHOULD:ignore https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
...... text Σ 1..1 string Plain text representation of the concept
Required Pattern: source systems appointment concept
..... system SΣ 1..1 uri Identifier-based reference to the Appointment concept in the source system.
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string Source systems identifier for the appointment
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:slot-id SΣ 1..1 Identifier External Ids for this item
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type 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.
ObligationsActor
SHOULD:ignore https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
...... text Σ 1..1 string Plain text representation of the concept
Required Pattern: id for the available slot
..... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: http://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/slot-id
..... value SΣ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... 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.
Required Pattern: proposed
... serviceType SΣ 1..* CodeableConcept The specific service that is to be performed during this appointment
Binding: IHE ITI Scheduling Snomed CT Services (extensible)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 1..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... start SΣ 1..1 instant When appointment is to take place
... end SΣ 1..1 instant When appointment is to conclude
... Slices for participant C 1..* BackboneElement Participants involved in appointment
Slice: Unordered, Open by type:actor
Constraints: app-1
.... participant:All Slices Content/Rules for all slices
..... 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
.... participant:healthcareService C 0..1 BackboneElement Participants involved in appointment
Constraints: app-1
..... 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(HealthcareServicePortal) 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
.... participant:practitionerRole C 0..1 BackboneElement Participants involved in appointment
Constraints: app-1
..... 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(PractitionerRolePortal) 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
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... start ΣC 1..1 dateTime Starting time with inclusive boundary
.... end ΣC 1..1 dateTime End time with inclusive boundary, if not ongoing

doco Documentation for this format

Terminology Bindings

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.

Constraints

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:

  • The element 1 is sliced based on the value of Appointment.identifier
  • The element 1 is sliced based on the value of Appointment.participant

 

Other representations of profile: CSV, Excel, Schematron