Finnish Scheduling
2.0.0-rc2 - ballot

Publication Build: This will be filled in by the publication tooling

## Resource Profile: FiSchedulingAppointment

Official URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/fi-scheduling-appointment | Version: 2.0.0-rc2
Draft as of 2025-05-09 | Computable Name: FiSchedulingAppointment

Profile for appointment (ajanvaraus) in Finnish Scheduling environment.

### Scope and Usage

Usage:

- Examples for this Resource Profile: Appointment/example-appointment-4

### Formal Views of Profile Content

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

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Appointment | C | 0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:AdditionalInformationURL |  | 0..* | url | Additional Information URL URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/additional-information-url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:AppointmentMutability |  | 0..1 | (Complex) | Appointment Mutability URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/mutable ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:CareGuaranteeDetails |  | 0..1 | string | Care Guarantee Details URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/care-guarantee-details ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:CareplanIdentifier |  | 0..* | Identifier | Careplan Identifier URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/careplan-identifier ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:ChildAppointment |  | 0..1 | Identifier | Child Appointment URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/child-appointment ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:CustomerJourney |  | 0..* | (Complex) | Customer Journey URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/customer-journey ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:NotificationInfo |  | 0..* | ContactPoint | Notification Information URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/notification-info ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:NotificationMedium |  | 0..* | Coding | Notification Medium URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/notification-medium ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:PractitionerGender |  | 0..1 | Coding | Practitioner Gender URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/practitioner-gender ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:QueueNo |  | 0..* | string | Queue Number URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/queue-number ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:ReferralId |  | 0..* | string | Referral Id URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/referral-id ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:RequestedService |  | 0..1 | (Complex) | Requested Service Info URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/requested-service-info ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:ResourceCalendarId |  | 0..* | (Complex) | Resource Calendar URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/resource-calendar ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:SelfServiceInfo |  | 0..1 | (Complex) | Self Service Information URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/self-service-info ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:ServiceAdditionalInformation |  | 0..* | string, url | Additional Information on Service URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/service-additional-information ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:TicketNo |  | 0..* | string | Ticket Number URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/ticket-number ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:TopicId |  | 0..1 | Identifier | Topic Id URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/topic-id ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status | ?!Σ | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment. ele-1: All FHIR elements must have a @value or children
Slices for serviceCategory | Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Slice: Unordered, Open by exists:coding Binding: ServiceCategory (example) ele-1: All FHIR elements must have a @value or children
serviceCategory:thlCodedCategory | Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) ele-1: All FHIR elements must have a @value or children
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children
coding:thlType | Σ | 1..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children
system | Σ | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Required Pattern: urn:oid:1.2.246.537.6.50
coding:hl7Type | Σ | 0..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children
system | Σ | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Required Pattern: http://terminology.hl7.org/CodeSystem/service-category
Slices for serviceType | Σ | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Slice: Unordered, Open by exists:coding Binding: ServiceType (example) ele-1: All FHIR elements must have a @value or children
serviceType:thlCodedType | Σ | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: ServiceType (example) ele-1: All FHIR elements must have a @value or children
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children
coding:thlType | Σ | 1..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children
system | Σ | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Required Pattern: urn:oid:1.2.246.537.6.49
coding:hl7Type | Σ | 0..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children
system | Σ | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Required Pattern: http://terminology.hl7.org/CodeSystem/service-type
Slices for reasonCode | Σ | 0..* | CodeableConcept | Coded reason this appointment is scheduled Slice: Unordered, Open by exists:coding Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. ele-1: All FHIR elements must have a @value or children
reasonCode:sliceSisaltotarkenne | Σ | 0..* | CodeableConcept | Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. ele-1: All FHIR elements must have a @value or children
coding | Σ | 1..1 | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children
reasonCode:slicePalvelutarve | Σ | 0..1 | CodeableConcept | Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. ele-1: All FHIR elements must have a @value or children
text | Σ | 1..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children
reasonReference |  | 0..* | Reference(Condition) {c} | Reason the appointment is to take place (resource) ele-1: All FHIR elements must have a @value or children
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). ele-1: All FHIR elements must have a @value or children Fixed Value: Condition
participant | C | 1..* | BackboneElement | Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. ele-1: All FHIR elements must have a @value or children
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Appointment.status | required | AppointmentStatus `http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1` from the FHIR Standard
Appointment.serviceCategory | example | ServiceCategory `http://hl7.org/fhir/ValueSet/service-category` from the FHIR Standard
Appointment.serviceCategory:thlCodedCategory | example | ServiceCategory `http://hl7.org/fhir/ValueSet/service-category` from the FHIR Standard
Appointment.serviceType | example | ServiceType `http://hl7.org/fhir/ValueSet/service-type` from the FHIR Standard
Appointment.serviceType:thlCodedType | example | ServiceType `http://hl7.org/fhir/ValueSet/service-type` from the FHIR Standard
Appointment.reasonCode | preferred | EncounterReasonCodes `http://hl7.org/fhir/ValueSet/encounter-reason` from the FHIR Standard
Appointment.reasonCode:sliceSisaltotarkenne | preferred | EncounterReasonCodes `http://hl7.org/fhir/ValueSet/encounter-reason` from the FHIR Standard
Appointment.reasonCode:slicePalvelutarve | preferred | EncounterReasonCodes `http://hl7.org/fhir/ValueSet/encounter-reason` from the FHIR Standard
Appointment.reasonReference.type | extensible | Fixed Value: Condition `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Appointment.participant.status | required | ParticipationStatus `http://hl7.org/fhir/ValueSet/participationstatus|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
app-1 | error | Appointment.participant | 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 Appointment

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Appointment |  | 0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:AdditionalInformationURL |  | 0..* | url | Additional Information URL URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/additional-information-url
extension:AppointmentMutability |  | 0..1 | (Complex) | Appointment Mutability URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/mutable
extension:CareGuaranteeDetails |  | 0..1 | string | Care Guarantee Details URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/care-guarantee-details
extension:CareplanIdentifier |  | 0..* | Identifier | Careplan Identifier URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/careplan-identifier
extension:ChildAppointment |  | 0..1 | Identifier | Child Appointment URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/child-appointment
extension:CustomerJourney |  | 0..* | (Complex) | Customer Journey URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/customer-journey
extension:NotificationInfo |  | 0..* | ContactPoint | Notification Information URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/notification-info
extension:NotificationMedium |  | 0..* | Coding | Notification Medium URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/notification-medium
extension:PractitionerGender |  | 0..1 | Coding | Practitioner Gender URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/practitioner-gender
extension:QueueNo |  | 0..* | string | Queue Number URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/queue-number
extension:ReferralId |  | 0..* | string | Referral Id URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/referral-id
extension:RequestedService |  | 0..1 | (Complex) | Requested Service Info URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/requested-service-info
extension:ResourceCalendarId |  | 0..* | (Complex) | Resource Calendar URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/resource-calendar
extension:SelfServiceInfo |  | 0..1 | (Complex) | Self Service Information URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/self-service-info
extension:ServiceAdditionalInformation |  | 0..* | string, url | Additional Information on Service URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/service-additional-information
extension:TicketNo |  | 0..* | string | Ticket Number URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/ticket-number
extension:TopicId |  | 0..1 | Identifier | Topic Id URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/topic-id
cancelationReason |  |  |  |
coding |  |  |  |
system |  | 0..1 | uri | Identity of the terminology system Required Pattern: urn:oid:1.2.246.537.6.126
Slices for serviceCategory |  | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Slice: Unordered, Open by exists:coding
serviceCategory:thlCodedCategory |  | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment
Slices for coding |  | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system
coding:thlType |  | 1..* | Coding | Code defined by a terminology system
system |  | 1..1 | uri | Identity of the terminology system Required Pattern: urn:oid:1.2.246.537.6.50
coding:hl7Type |  | 0..* | Coding | Code defined by a terminology system
system |  | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/service-category
Slices for serviceType |  | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Slice: Unordered, Open by exists:coding
serviceType:thlCodedType |  | 0..* | CodeableConcept | The specific service that is to be performed during this appointment
Slices for coding |  | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system
coding:thlType |  | 1..* | Coding | Code defined by a terminology system
system |  | 1..1 | uri | Identity of the terminology system Required Pattern: urn:oid:1.2.246.537.6.49
coding:hl7Type |  | 0..* | Coding | Code defined by a terminology system
system |  | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/service-type
appointmentType |  |  |  |
coding |  |  |  |
system |  | 0..1 | uri | Identity of the terminology system Required Pattern: 1.2.246.537.6.884
Slices for reasonCode |  | 0..* | CodeableConcept | Coded reason this appointment is scheduled Slice: Unordered, Open by exists:coding
reasonCode:sliceSisaltotarkenne |  | 0..* | CodeableConcept | Coded reason this appointment is scheduled
coding |  | 1..1 | Coding | Code defined by a terminology system
reasonCode:slicePalvelutarve |  | 0..1 | CodeableConcept | Coded reason this appointment is scheduled
text |  | 1..1 | string | Plain text representation of the concept
reasonReference |  | 0..* | Reference(Condition) {c} | Reason the appointment is to take place (resource)
type |  | 0..1 | uri | Type the reference refers to (e.g. "Patient") Fixed Value: Condition
patientInstruction |  |  |  |
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:PatientInstructionURL |  | 0..1 | url | Patient Instruction URL URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/patient-instruction-url
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Appointment | C | 0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:AdditionalInformationURL |  | 0..* | url | Additional Information URL URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/additional-information-url
extension:AppointmentMutability |  | 0..1 | (Complex) | Appointment Mutability URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/mutable
extension:CareGuaranteeDetails |  | 0..1 | string | Care Guarantee Details URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/care-guarantee-details
extension:CareplanIdentifier |  | 0..* | Identifier | Careplan Identifier URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/careplan-identifier
extension:ChildAppointment |  | 0..1 | Identifier | Child Appointment URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/child-appointment
extension:CustomerJourney |  | 0..* | (Complex) | Customer Journey URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/customer-journey
extension:NotificationInfo |  | 0..* | ContactPoint | Notification Information URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/notification-info
extension:NotificationMedium |  | 0..* | Coding | Notification Medium URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/notification-medium
extension:PractitionerGender |  | 0..1 | Coding | Practitioner Gender URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/practitioner-gender
extension:QueueNo |  | 0..* | string | Queue Number URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/queue-number
extension:ReferralId |  | 0..* | string | Referral Id URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/referral-id
extension:RequestedService |  | 0..1 | (Complex) | Requested Service Info URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/requested-service-info
extension:ResourceCalendarId |  | 0..* | (Complex) | Resource Calendar URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/resource-calendar
extension:SelfServiceInfo |  | 0..1 | (Complex) | Self Service Information URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/self-service-info
extension:ServiceAdditionalInformation |  | 0..* | string, url | Additional Information on Service URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/service-additional-information
extension:TicketNo |  | 0..* | string | Ticket Number URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/ticket-number
extension:TopicId |  | 0..1 | Identifier | Topic Id URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/topic-id
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | External Ids for this item
status | ?!Σ | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment.
cancelationReason | Σ | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example)
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
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 | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: urn:oid:1.2.246.537.6.126
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 0..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
Slices for serviceCategory | Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Slice: Unordered, Open by exists:coding Binding: ServiceCategory (example)
serviceCategory:thlCodedCategory | Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system
coding:thlType | Σ | 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 Required Pattern: urn:oid:1.2.246.537.6.50
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 0..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
coding:hl7Type | Σ | 0..* | 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 Required Pattern: http://terminology.hl7.org/CodeSystem/service-category
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 0..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
Slices for serviceType | Σ | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Slice: Unordered, Open by exists:coding Binding: ServiceType (example)
serviceType:thlCodedType | Σ | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: ServiceType (example)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system
coding:thlType | Σ | 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 Required Pattern: urn:oid:1.2.246.537.6.49
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 0..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
coding:hl7Type | Σ | 0..* | 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 Required Pattern: http://terminology.hl7.org/CodeSystem/service-type
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 0..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
specialty | Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred)
appointmentType | Σ | 0..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred)
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
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 | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: 1.2.246.537.6.884
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 0..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
Slices for reasonCode | Σ | 0..* | CodeableConcept | Coded reason this appointment is scheduled Slice: Unordered, Open by exists:coding Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place.
reasonCode:sliceSisaltotarkenne | Σ | 0..* | CodeableConcept | Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place.
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..1 | Coding | Code defined by a terminology system
text | Σ | 0..1 | string | Plain text representation of the concept
reasonCode:slicePalvelutarve | Σ | 0..1 | CodeableConcept | Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place.
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
reasonReference |  | 0..* | Reference(Condition) {c} | Reason the appointment is to take place (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
reference | Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Fixed Value: Condition
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
priority |  | 0..1 | unsignedInt | Used to make informed decisions if needing to re-prioritize
description |  | 0..1 | string | Shown on a subject line in a meeting request, or appointment list
supportingInformation |  | 0..* | Reference(Resource) | Additional information to support the appointment
start | Σ | 0..1 | instant | When appointment is to take place
end | Σ | 0..1 | instant | When appointment is to conclude
minutesDuration |  | 0..1 | positiveInt | Can be less than start/end (e.g. estimate)
slot |  | 0..* | Reference(Slot) | The slots that this appointment is filling
created |  | 0..1 | dateTime | The date that this appointment was initially created
comment |  | 0..1 | string | Additional comments
patientInstruction |  | 0..1 | string | Detailed information and instructions for the patient
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:PatientInstructionURL |  | 0..1 | url | Patient Instruction URL URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/patient-instruction-url
value |  | 0..1 | string | Primitive value for string Max Length:1048576
basedOn |  | 0..* | Reference(ServiceRequest) | The service request this appointment is allocated to assess
participant | C | 1..* | BackboneElement | Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
actor | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | 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 | Σ | 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 |  | 0..* | Period | Potential date/time interval(s) requested to allocate the appointment within
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Appointment.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Appointment.status | required | AppointmentStatus `http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1` from the FHIR Standard
Appointment.cancelationReason | example | AppointmentCancellationReason `http://hl7.org/fhir/ValueSet/appointment-cancellation-reason` from the FHIR Standard
Appointment.serviceCategory | example | ServiceCategory `http://hl7.org/fhir/ValueSet/service-category` from the FHIR Standard
Appointment.serviceCategory:thlCodedCategory | example | ServiceCategory `http://hl7.org/fhir/ValueSet/service-category` from the FHIR Standard
Appointment.serviceType | example | ServiceType `http://hl7.org/fhir/ValueSet/service-type` from the FHIR Standard
Appointment.serviceType:thlCodedType | example | ServiceType `http://hl7.org/fhir/ValueSet/service-type` from the FHIR Standard
Appointment.specialty | preferred | PracticeSettingCodeValueSet `http://hl7.org/fhir/ValueSet/c80-practice-codes` from the FHIR Standard
Appointment.appointmentType | preferred | Hl7VSAppointmentReasonCodes `http://terminology.hl7.org/ValueSet/v2-0276`
Appointment.reasonCode | preferred | EncounterReasonCodes `http://hl7.org/fhir/ValueSet/encounter-reason` from the FHIR Standard
Appointment.reasonCode:sliceSisaltotarkenne | preferred | EncounterReasonCodes `http://hl7.org/fhir/ValueSet/encounter-reason` from the FHIR Standard
Appointment.reasonCode:slicePalvelutarve | preferred | EncounterReasonCodes `http://hl7.org/fhir/ValueSet/encounter-reason` from the FHIR Standard
Appointment.reasonReference.type | extensible | Fixed Value: Condition `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Appointment.participant.type | extensible | ParticipantType `http://hl7.org/fhir/ValueSet/encounter-participant-type` from the FHIR Standard
Appointment.participant.required | required | ParticipantRequired `http://hl7.org/fhir/ValueSet/participantrequired|4.0.1` from the FHIR Standard
Appointment.participant.status | required | ParticipationStatus `http://hl7.org/fhir/ValueSet/participationstatus|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
app-1 | error | Appointment.participant | 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 Appointment

Summary

Mandatory: 0 element(10 nested mandatory elements)
Fixed: 1 element

Extensions

This structure refers to these extensions:

- https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/additional-information-url
- https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/mutable
- https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/care-guarantee-details
- https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/careplan-identifier
- https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/child-appointment
- https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/customer-journey
- https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/notification-info
- https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/notification-medium
- https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/practitioner-gender
- https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/queue-number
- https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/referral-id
- https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/requested-service-info
- https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/resource-calendar
- https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/self-service-info
- https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/service-additional-information
- https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/ticket-number
- https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/topic-id
- https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/patient-instruction-url

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Appointment.serviceCategory
- The element 1 is sliced based on the value of Appointment.serviceCategory.coding
- The element 1 is sliced based on the value of Appointment.serviceType
- The element 1 is sliced based on the value of Appointment.serviceType.coding
- The element 1 is sliced based on the value of Appointment.reasonCode

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Appointment | C | 0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:AdditionalInformationURL |  | 0..* | url | Additional Information URL URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/additional-information-url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:AppointmentMutability |  | 0..1 | (Complex) | Appointment Mutability URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/mutable ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:CareGuaranteeDetails |  | 0..1 | string | Care Guarantee Details URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/care-guarantee-details ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:CareplanIdentifier |  | 0..* | Identifier | Careplan Identifier URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/careplan-identifier ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:ChildAppointment |  | 0..1 | Identifier | Child Appointment URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/child-appointment ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:CustomerJourney |  | 0..* | (Complex) | Customer Journey URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/customer-journey ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:NotificationInfo |  | 0..* | ContactPoint | Notification Information URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/notification-info ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:NotificationMedium |  | 0..* | Coding | Notification Medium URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/notification-medium ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:PractitionerGender |  | 0..1 | Coding | Practitioner Gender URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/practitioner-gender ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:QueueNo |  | 0..* | string | Queue Number URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/queue-number ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:ReferralId |  | 0..* | string | Referral Id URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/referral-id ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:RequestedService |  | 0..1 | (Complex) | Requested Service Info URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/requested-service-info ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:ResourceCalendarId |  | 0..* | (Complex) | Resource Calendar URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/resource-calendar ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:SelfServiceInfo |  | 0..1 | (Complex) | Self Service Information URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/self-service-info ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:ServiceAdditionalInformation |  | 0..* | string, url | Additional Information on Service URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/service-additional-information ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:TicketNo |  | 0..* | string | Ticket Number URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/ticket-number ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:TopicId |  | 0..1 | Identifier | Topic Id URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/topic-id ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status | ?!Σ | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment. ele-1: All FHIR elements must have a @value or children
Slices for serviceCategory | Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Slice: Unordered, Open by exists:coding Binding: ServiceCategory (example) ele-1: All FHIR elements must have a @value or children
serviceCategory:thlCodedCategory | Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) ele-1: All FHIR elements must have a @value or children
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children
coding:thlType | Σ | 1..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children
system | Σ | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Required Pattern: urn:oid:1.2.246.537.6.50
coding:hl7Type | Σ | 0..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children
system | Σ | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Required Pattern: http://terminology.hl7.org/CodeSystem/service-category
Slices for serviceType | Σ | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Slice: Unordered, Open by exists:coding Binding: ServiceType (example) ele-1: All FHIR elements must have a @value or children
serviceType:thlCodedType | Σ | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: ServiceType (example) ele-1: All FHIR elements must have a @value or children
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children
coding:thlType | Σ | 1..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children
system | Σ | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Required Pattern: urn:oid:1.2.246.537.6.49
coding:hl7Type | Σ | 0..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children
system | Σ | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Required Pattern: http://terminology.hl7.org/CodeSystem/service-type
Slices for reasonCode | Σ | 0..* | CodeableConcept | Coded reason this appointment is scheduled Slice: Unordered, Open by exists:coding Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. ele-1: All FHIR elements must have a @value or children
reasonCode:sliceSisaltotarkenne | Σ | 0..* | CodeableConcept | Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. ele-1: All FHIR elements must have a @value or children
coding | Σ | 1..1 | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children
reasonCode:slicePalvelutarve | Σ | 0..1 | CodeableConcept | Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. ele-1: All FHIR elements must have a @value or children
text | Σ | 1..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children
reasonReference |  | 0..* | Reference(Condition) {c} | Reason the appointment is to take place (resource) ele-1: All FHIR elements must have a @value or children
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). ele-1: All FHIR elements must have a @value or children Fixed Value: Condition
participant | C | 1..* | BackboneElement | Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. ele-1: All FHIR elements must have a @value or children
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Appointment.status | required | AppointmentStatus `http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1` from the FHIR Standard
Appointment.serviceCategory | example | ServiceCategory `http://hl7.org/fhir/ValueSet/service-category` from the FHIR Standard
Appointment.serviceCategory:thlCodedCategory | example | ServiceCategory `http://hl7.org/fhir/ValueSet/service-category` from the FHIR Standard
Appointment.serviceType | example | ServiceType `http://hl7.org/fhir/ValueSet/service-type` from the FHIR Standard
Appointment.serviceType:thlCodedType | example | ServiceType `http://hl7.org/fhir/ValueSet/service-type` from the FHIR Standard
Appointment.reasonCode | preferred | EncounterReasonCodes `http://hl7.org/fhir/ValueSet/encounter-reason` from the FHIR Standard
Appointment.reasonCode:sliceSisaltotarkenne | preferred | EncounterReasonCodes `http://hl7.org/fhir/ValueSet/encounter-reason` from the FHIR Standard
Appointment.reasonCode:slicePalvelutarve | preferred | EncounterReasonCodes `http://hl7.org/fhir/ValueSet/encounter-reason` from the FHIR Standard
Appointment.reasonReference.type | extensible | Fixed Value: Condition `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Appointment.participant.status | required | ParticipationStatus `http://hl7.org/fhir/ValueSet/participationstatus|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
app-1 | error | Appointment.participant | 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 Appointment

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Appointment |  | 0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:AdditionalInformationURL |  | 0..* | url | Additional Information URL URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/additional-information-url
extension:AppointmentMutability |  | 0..1 | (Complex) | Appointment Mutability URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/mutable
extension:CareGuaranteeDetails |  | 0..1 | string | Care Guarantee Details URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/care-guarantee-details
extension:CareplanIdentifier |  | 0..* | Identifier | Careplan Identifier URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/careplan-identifier
extension:ChildAppointment |  | 0..1 | Identifier | Child Appointment URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/child-appointment
extension:CustomerJourney |  | 0..* | (Complex) | Customer Journey URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/customer-journey
extension:NotificationInfo |  | 0..* | ContactPoint | Notification Information URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/notification-info
extension:NotificationMedium |  | 0..* | Coding | Notification Medium URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/notification-medium
extension:PractitionerGender |  | 0..1 | Coding | Practitioner Gender URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/practitioner-gender
extension:QueueNo |  | 0..* | string | Queue Number URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/queue-number
extension:ReferralId |  | 0..* | string | Referral Id URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/referral-id
extension:RequestedService |  | 0..1 | (Complex) | Requested Service Info URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/requested-service-info
extension:ResourceCalendarId |  | 0..* | (Complex) | Resource Calendar URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/resource-calendar
extension:SelfServiceInfo |  | 0..1 | (Complex) | Self Service Information URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/self-service-info
extension:ServiceAdditionalInformation |  | 0..* | string, url | Additional Information on Service URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/service-additional-information
extension:TicketNo |  | 0..* | string | Ticket Number URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/ticket-number
extension:TopicId |  | 0..1 | Identifier | Topic Id URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/topic-id
cancelationReason |  |  |  |
coding |  |  |  |
system |  | 0..1 | uri | Identity of the terminology system Required Pattern: urn:oid:1.2.246.537.6.126
Slices for serviceCategory |  | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Slice: Unordered, Open by exists:coding
serviceCategory:thlCodedCategory |  | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment
Slices for coding |  | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system
coding:thlType |  | 1..* | Coding | Code defined by a terminology system
system |  | 1..1 | uri | Identity of the terminology system Required Pattern: urn:oid:1.2.246.537.6.50
coding:hl7Type |  | 0..* | Coding | Code defined by a terminology system
system |  | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/service-category
Slices for serviceType |  | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Slice: Unordered, Open by exists:coding
serviceType:thlCodedType |  | 0..* | CodeableConcept | The specific service that is to be performed during this appointment
Slices for coding |  | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system
coding:thlType |  | 1..* | Coding | Code defined by a terminology system
system |  | 1..1 | uri | Identity of the terminology system Required Pattern: urn:oid:1.2.246.537.6.49
coding:hl7Type |  | 0..* | Coding | Code defined by a terminology system
system |  | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/service-type
appointmentType |  |  |  |
coding |  |  |  |
system |  | 0..1 | uri | Identity of the terminology system Required Pattern: 1.2.246.537.6.884
Slices for reasonCode |  | 0..* | CodeableConcept | Coded reason this appointment is scheduled Slice: Unordered, Open by exists:coding
reasonCode:sliceSisaltotarkenne |  | 0..* | CodeableConcept | Coded reason this appointment is scheduled
coding |  | 1..1 | Coding | Code defined by a terminology system
reasonCode:slicePalvelutarve |  | 0..1 | CodeableConcept | Coded reason this appointment is scheduled
text |  | 1..1 | string | Plain text representation of the concept
reasonReference |  | 0..* | Reference(Condition) {c} | Reason the appointment is to take place (resource)
type |  | 0..1 | uri | Type the reference refers to (e.g. "Patient") Fixed Value: Condition
patientInstruction |  |  |  |
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:PatientInstructionURL |  | 0..1 | url | Patient Instruction URL URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/patient-instruction-url
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Appointment | C | 0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:AdditionalInformationURL |  | 0..* | url | Additional Information URL URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/additional-information-url
extension:AppointmentMutability |  | 0..1 | (Complex) | Appointment Mutability URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/mutable
extension:CareGuaranteeDetails |  | 0..1 | string | Care Guarantee Details URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/care-guarantee-details
extension:CareplanIdentifier |  | 0..* | Identifier | Careplan Identifier URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/careplan-identifier
extension:ChildAppointment |  | 0..1 | Identifier | Child Appointment URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/child-appointment
extension:CustomerJourney |  | 0..* | (Complex) | Customer Journey URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/customer-journey
extension:NotificationInfo |  | 0..* | ContactPoint | Notification Information URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/notification-info
extension:NotificationMedium |  | 0..* | Coding | Notification Medium URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/notification-medium
extension:PractitionerGender |  | 0..1 | Coding | Practitioner Gender URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/practitioner-gender
extension:QueueNo |  | 0..* | string | Queue Number URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/queue-number
extension:ReferralId |  | 0..* | string | Referral Id URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/referral-id
extension:RequestedService |  | 0..1 | (Complex) | Requested Service Info URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/requested-service-info
extension:ResourceCalendarId |  | 0..* | (Complex) | Resource Calendar URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/resource-calendar
extension:SelfServiceInfo |  | 0..1 | (Complex) | Self Service Information URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/self-service-info
extension:ServiceAdditionalInformation |  | 0..* | string, url | Additional Information on Service URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/service-additional-information
extension:TicketNo |  | 0..* | string | Ticket Number URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/ticket-number
extension:TopicId |  | 0..1 | Identifier | Topic Id URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/topic-id
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | External Ids for this item
status | ?!Σ | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment.
cancelationReason | Σ | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example)
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
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 | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: urn:oid:1.2.246.537.6.126
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 0..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
Slices for serviceCategory | Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Slice: Unordered, Open by exists:coding Binding: ServiceCategory (example)
serviceCategory:thlCodedCategory | Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system
coding:thlType | Σ | 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 Required Pattern: urn:oid:1.2.246.537.6.50
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 0..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
coding:hl7Type | Σ | 0..* | 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 Required Pattern: http://terminology.hl7.org/CodeSystem/service-category
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 0..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
Slices for serviceType | Σ | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Slice: Unordered, Open by exists:coding Binding: ServiceType (example)
serviceType:thlCodedType | Σ | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: ServiceType (example)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system
coding:thlType | Σ | 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 Required Pattern: urn:oid:1.2.246.537.6.49
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 0..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
coding:hl7Type | Σ | 0..* | 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 Required Pattern: http://terminology.hl7.org/CodeSystem/service-type
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 0..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
specialty | Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred)
appointmentType | Σ | 0..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred)
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
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 | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: 1.2.246.537.6.884
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 0..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
Slices for reasonCode | Σ | 0..* | CodeableConcept | Coded reason this appointment is scheduled Slice: Unordered, Open by exists:coding Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place.
reasonCode:sliceSisaltotarkenne | Σ | 0..* | CodeableConcept | Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place.
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..1 | Coding | Code defined by a terminology system
text | Σ | 0..1 | string | Plain text representation of the concept
reasonCode:slicePalvelutarve | Σ | 0..1 | CodeableConcept | Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place.
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
reasonReference |  | 0..* | Reference(Condition) {c} | Reason the appointment is to take place (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
reference | Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Fixed Value: Condition
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
priority |  | 0..1 | unsignedInt | Used to make informed decisions if needing to re-prioritize
description |  | 0..1 | string | Shown on a subject line in a meeting request, or appointment list
supportingInformation |  | 0..* | Reference(Resource) | Additional information to support the appointment
start | Σ | 0..1 | instant | When appointment is to take place
end | Σ | 0..1 | instant | When appointment is to conclude
minutesDuration |  | 0..1 | positiveInt | Can be less than start/end (e.g. estimate)
slot |  | 0..* | Reference(Slot) | The slots that this appointment is filling
created |  | 0..1 | dateTime | The date that this appointment was initially created
comment |  | 0..1 | string | Additional comments
patientInstruction |  | 0..1 | string | Detailed information and instructions for the patient
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:PatientInstructionURL |  | 0..1 | url | Patient Instruction URL URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/patient-instruction-url
value |  | 0..1 | string | Primitive value for string Max Length:1048576
basedOn |  | 0..* | Reference(ServiceRequest) | The service request this appointment is allocated to assess
participant | C | 1..* | BackboneElement | Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter.
actor | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | 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 | Σ | 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 |  | 0..* | Period | Potential date/time interval(s) requested to allocate the appointment within
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Appointment.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Appointment.status | required | AppointmentStatus `http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1` from the FHIR Standard
Appointment.cancelationReason | example | AppointmentCancellationReason `http://hl7.org/fhir/ValueSet/appointment-cancellation-reason` from the FHIR Standard
Appointment.serviceCategory | example | ServiceCategory `http://hl7.org/fhir/ValueSet/service-category` from the FHIR Standard
Appointment.serviceCategory:thlCodedCategory | example | ServiceCategory `http://hl7.org/fhir/ValueSet/service-category` from the FHIR Standard
Appointment.serviceType | example | ServiceType `http://hl7.org/fhir/ValueSet/service-type` from the FHIR Standard
Appointment.serviceType:thlCodedType | example | ServiceType `http://hl7.org/fhir/ValueSet/service-type` from the FHIR Standard
Appointment.specialty | preferred | PracticeSettingCodeValueSet `http://hl7.org/fhir/ValueSet/c80-practice-codes` from the FHIR Standard
Appointment.appointmentType | preferred | Hl7VSAppointmentReasonCodes `http://terminology.hl7.org/ValueSet/v2-0276`
Appointment.reasonCode | preferred | EncounterReasonCodes `http://hl7.org/fhir/ValueSet/encounter-reason` from the FHIR Standard
Appointment.reasonCode:sliceSisaltotarkenne | preferred | EncounterReasonCodes `http://hl7.org/fhir/ValueSet/encounter-reason` from the FHIR Standard
Appointment.reasonCode:slicePalvelutarve | preferred | EncounterReasonCodes `http://hl7.org/fhir/ValueSet/encounter-reason` from the FHIR Standard
Appointment.reasonReference.type | extensible | Fixed Value: Condition `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Appointment.participant.type | extensible | ParticipantType `http://hl7.org/fhir/ValueSet/encounter-participant-type` from the FHIR Standard
Appointment.participant.required | required | ParticipantRequired `http://hl7.org/fhir/ValueSet/participantrequired|4.0.1` from the FHIR Standard
Appointment.participant.status | required | ParticipationStatus `http://hl7.org/fhir/ValueSet/participationstatus|4.0.1` from the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
app-1 | error | Appointment.participant | 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 Appointment

Summary

Mandatory: 0 element(10 nested mandatory elements)
Fixed: 1 element

Extensions

This structure refers to these extensions:

- https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/additional-information-url
- https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/mutable
- https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/care-guarantee-details
- https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/careplan-identifier
- https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/child-appointment
- https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/customer-journey
- https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/notification-info
- https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/notification-medium
- https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/practitioner-gender
- https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/queue-number
- https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/referral-id
- https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/requested-service-info
- https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/resource-calendar
- https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/self-service-info
- https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/service-additional-information
- https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/ticket-number
- https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/topic-id
- https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/patient-instruction-url

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Appointment.serviceCategory
- The element 1 is sliced based on the value of Appointment.serviceCategory.coding
- The element 1 is sliced based on the value of Appointment.serviceType
- The element 1 is sliced based on the value of Appointment.serviceType.coding
- The element 1 is sliced based on the value of Appointment.reasonCode

Other representations of profile: CSV, Excel, Schematron