| Left: | Appointment Portal (https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/portal-appointment) |
| Right: | Appointment Portal (https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/portal-appointment) |
| Error | StructureDefinition.version | Values for version differ: '1.0.0' vs '1.0.1' |
| Information | StructureDefinition.date | Values for date differ: '2026-04-20T11:19:47+00:00' vs '2026-06-09T06:48:23+00:00' |
| Information | StructureDefinition.jurisdiction | Added the item 'null#null' |
| Name | Value | Comments | |
|---|---|---|---|
abstract | false | ||
baseDefinition | https://canonical.fhir.link/servicewell/wof-base/StructureDefinition/wof-base-appointment | ||
copyright | |||
date | 2026-04-20T11:19:47+00:00 | 2026-06-09T06:48:23+00:00 |
|
description | The public API model for 'Portal Appointment Appointment representation of a booked visit. Inherits IHE Scheduling Appointment. This profile is to be used in a patient context and where the appointment status is anything other than '#proposed'. | ||
experimental | |||
fhirVersion | 4.0.1 | ||
jurisdiction | |||
![]() jurisdiction[0] | null#null |
| |
kind | resource | ||
name | PortalAppointment | ||
publisher | Service Well AB | ||
purpose | |||
status | active | ||
title | Appointment Portal | ||
type | Appointment | ||
url | https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/portal-appointment | ||
version | 1.0.0 | 1.0.1 |
|
| Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments![]() | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() | 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) | 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) | |||||||||||||
![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | Σ | 0..1 | id | Logical id of this artifact | |||||||||||||
![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource | |||||||||||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||
![]() ![]() ![]() | SOΣ | 0..1 | id | Server-managed resource version
| SOΣ | 0..1 | id | Server-managed resource version
| |||||||||||||
![]() ![]() ![]() | Σ | 0..1 | instant | When the resource version last changed | Σ | 0..1 | instant | When the resource version last changed | |||||||||||||
![]() ![]() ![]() | Σ | 0..1 | uri | Identifies where the resource comes from | Σ | 0..1 | uri | Identifies where the resource comes from | |||||||||||||
![]() ![]() ![]() | SOΣ | 1..* | canonical(StructureDefinition) | Profile declaration for this portal resource
| SOΣ | 1..* | canonical(StructureDefinition) | Profile declaration for this portal resource
| |||||||||||||
![]() ![]() ![]() | Σ | 0..* | Coding | Security Labels applied to this resource Binding: ?? (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | Σ | 0..* | Coding | Security Labels applied to this resource Binding: ?? (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||||||||||
![]() ![]() ![]() | Σ | 0..* | Coding | Tags applied to this resource Binding: ?? (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | Σ | 0..* | Coding | Tags applied to this resource Binding: ?? (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |||||||||||||
![]() ![]() | ?!Σ | 0..0 | A set of rules under which this content was created | ?!Σ | 0..0 | A set of rules under which this content was created | |||||||||||||||
![]() ![]() | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| |||||||||||||||
![]() ![]() | 0..0 | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | 0..0 | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||||||||||
![]() ![]() | 0..0 | Contained, inline Resources | 0..0 | Contained, inline Resources | |||||||||||||||||
![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||||
![]() ![]() | ?! | 0..0 | Extension | ?! | 0..0 | Extension | |||||||||||||||
![]() ![]() | SΣ | 1..* | Identifier | External Ids for this item Slice: Unordered, Open by value:type.text | SΣ | 1..* | Identifier | External Ids for this item Slice: Unordered, Open by value:type.text | |||||||||||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||||
![]() ![]() ![]() | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: ?? (required): Identifies the purpose for this identifier, if known . | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: ?? (required): Identifies the purpose for this identifier, if known . | |||||||||||||
![]() ![]() ![]() | OΣ | 0..1 | CodeableConcept | Description of identifier Binding: ?? (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
| OΣ | 0..1 | CodeableConcept | Description of identifier Binding: ?? (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 | 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 | string | The value that is unique Example General: 123456 | |||||||||||||
![]() ![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use | Σ | 0..1 | Period | Time period when id is/was valid for use | |||||||||||||
![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | Σ | 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: ?? (required): The free/busy status of an appointment. | ?!SΣ | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: ?? (required) | |||||||||||||
![]() ![]() | Σ | 0..0 | The coded reason for the appointment being cancelled Binding: ?? (example) | Σ | 0..0 | The coded reason for the appointment being cancelled Binding: ?? (example) | |||||||||||||||
![]() ![]() | Σ | 0..0 | A broad categorization of the service that is to be performed during this appointment Binding: ?? (example) | Σ | 0..0 | A broad categorization of the service that is to be performed during this appointment Binding: ?? (example) | |||||||||||||||
![]() ![]() | SΣ | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: ?? (extensible) | SΣ | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: ?? (extensible) | |||||||||||||
![]() ![]() | SΣ | 0..0 | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: ?? (extensible) | SΣ | 0..0 | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: ?? (extensible) | |||||||||||||||
![]() ![]() | Σ | 0..0 | The style of appointment or patient that has been booked in the slot (not service type) Binding: ?? (preferred) | Σ | 0..0 | The style of appointment or patient that has been booked in the slot (not service type) Binding: ?? (preferred) | |||||||||||||||
![]() ![]() | Σ | 0..0 | Coded reason this appointment is scheduled Binding: ?? (preferred): The Reason for the appointment to take place. | Σ | 0..0 | Coded reason this appointment is scheduled Binding: ?? (preferred): The Reason for the appointment to take place. | |||||||||||||||
![]() ![]() | 0..0 | Reason the appointment is to take place (resource) | 0..0 | Reason the appointment is to take place (resource) | |||||||||||||||||
![]() ![]() | 0..0 | Used to make informed decisions if needing to re-prioritize | 0..0 | Used to make informed decisions if needing to re-prioritize | |||||||||||||||||
![]() ![]() | 0..0 | Shown on a subject line in a meeting request, or appointment list | 0..0 | Shown on a subject line in a meeting request, or appointment list | |||||||||||||||||
![]() ![]() | 0..0 | Additional information to support the appointment | 0..0 | Additional information to support the appointment | |||||||||||||||||
![]() ![]() | SΣ | 1..1 | instant | When appointment is to take place | SΣ | 1..1 | instant | When appointment is to take place | |||||||||||||
![]() ![]() | SΣ | 1..1 | instant | When appointment is to conclude | SΣ | 1..1 | instant | When appointment is to conclude | |||||||||||||
![]() ![]() | 0..0 | Can be less than start/end (e.g. estimate) | 0..0 | Can be less than start/end (e.g. estimate) | |||||||||||||||||
![]() ![]() | 0..0 | The slots that this appointment is filling | 0..0 | The slots that this appointment is filling | |||||||||||||||||
![]() ![]() | 0..0 | The date that this appointment was initially created | 0..0 | The date that this appointment was initially created | |||||||||||||||||
![]() ![]() | S | 0..1 | string | Additional comments | S | 0..1 | string | Additional comments | |||||||||||||
![]() ![]() | 0..0 | Detailed information and instructions for the patient | 0..0 | Detailed information and instructions for the patient | |||||||||||||||||
![]() ![]() | 0..0 | The service request this appointment is allocated to assess | 0..0 | The service request this appointment is allocated to assess | |||||||||||||||||
![]() ![]() | C | 3..3 | BackboneElement | Participants involved in appointment Slice: Unordered, Open by value:actor.type | C | 3..3 | BackboneElement | Participants involved in appointment Slice: Unordered, Open by value:actor.type | |||||||||||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||
![]() ![]() ![]() | Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ?? (extensible): Role of participant in encounter. | Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ?? (extensible): Role of participant in encounter. | |||||||||||||
![]() ![]() ![]() | SΣ | 1..1 | Reference(Location | Patient | Practitioner | PractitionerRole | HealthcareService) | Person, Location/HealthcareService or Device | SΣ | 1..1 | Reference(Location | Patient | Practitioner | PractitionerRole | HealthcareService) | Person, Location/HealthcareService or Device | |||||||||||||
![]() ![]() ![]() | Σ | 0..1 | code | required | optional | information-only Binding: ?? (required): Is the Participant required to attend the appointment. | Σ | 0..1 | code | required | optional | information-only Binding: ?? (required): Is the Participant required to attend the appointment. | |||||||||||||
![]() ![]() ![]() | SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ?? (required): The Participation status of an appointment. | SΣ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ?? (required): The Participation status of an appointment. | |||||||||||||
![]() ![]() ![]() | 0..1 | Period | Participation period of the actor | 0..1 | Period | Participation period of the actor | |||||||||||||||
![]() ![]() | S | 1..1 | Period | Potential date/time interval(s) requested to allocate the appointment within | S | 1..1 | Period | Potential date/time interval(s) requested to allocate the appointment within | |||||||||||||
Documentation for this format | |||||||||||||||||||||