Finnish Scheduling
0.2.0-cibuild - ci-build Finland flag

Finnish Scheduling, published by HL7 Finland. This guide is not an authorized publication; it is the continuous build for version 0.2.0-cibuild built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/fhir-fi/finnish-scheduling/ and changes regularly. See the Directory of published versions

Resource Profile: FiSchedulingAppointment

Official URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/fi-scheduling-appointment Version: 0.2.0-cibuild
Draft as of 2024-09-09 Computable Name: FiSchedulingAppointment

Base profile for appointment (ajanvaraus) in Finnish Scheduling environment. The contents is based on the scheduling appointment specification.

Scope and Usage

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from Appointment

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
.... ServiceEvent 0..1 oid Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/fi-scheduling-service-event
.... TopicId 0..1 Identifier Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/TopicIdExtension
.... QueueNo 0..* string Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/QueueNoExtension
.... TicketNo 0..* string Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/TicketNoExtension
.... VisibleToCustodian 0..1 string Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/VisibleToCustodianExtension
.... CustomerJourney 0..* (Complex) Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/CustomerJourneyExtension
.... ParentAppointment 0..1 Identifier Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/ParentAppointment
.... SelfServiceExtension 0..1 (Complex) Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/SelfServiceExtension
.... ResourceCalendar 0..* (Complex) Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/ResourceCalendarIdExtension
.... ReferralId 0..* string Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/ReferralIdExtension
.... RequestedService 0..1 (Complex) Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/RequestedServiceExtension
.... MiscAppointmentData 0..1 string Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/MiscAppointmentDataExtension
.... PractitionerGender 0..1 Coding Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/PractitionerGenderExtension
.... NotificationMedium 0..* Coding Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/NotificationMediumExtension
.... CareGuarantee 0..1 string Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/CareGuaranteeExtension
.... AdditionalInformationURL 0..* url Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/AdditionalInformationURLExtension
.... CarePlan 0..* Identifier Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/CareplanIdentifierExtension
.... AppointmentMutability 0..1 (Complex) Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/AppointmentMutabilityExtension
... identifier 1..* Identifier External Ids for this item
.... value 1..1 string The value that is unique
... status 1..1 code suunniteltu | tilattu | varattu | peruttu | siirretty | alkanut | toteutunut | ehdotettu | saapumatta
.... coding
..... system 0..1 uri THL - Palvelutapahtuman peruuntumisen tai siirtymisen syy
Fixed Value: urn:oid:1.2.246.537.6.126.2008
... serviceCategory 0..* CodeableConcept A broad categorization of the service that is to be performed during this appointment
.... coding
..... system 0..1 uri AR/YDIN - Palvelutapahtumaluokitus
Fixed Value: urn:oid:1.2.246.537.6.88.2008
... serviceType 1..* CodeableConcept The specific service that is to be performed during this appointment
.... coding
..... system 0..1 uri THL - Sosiaali- ja terveysalan palvelunimikkeistö
Fixed Value: urn:oid:1.2.246.537.6.49.201501
... appointmentType 0..1 CodeableConcept The style of appointment or patient that has been booked in the slot (not service type)
.... coding
..... system 0..1 uri hl7fi: asiointitapa
Fixed Value: 1.2.246.537.6.884.2015
... 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
...... version 0..0
...... userSelected 0..0
..... text 0..0
.... reasonCode:slicePalvelutarve 0..1 CodeableConcept Coded reason this appointment is scheduled
..... coding 0..0
..... 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
... start 0..1 instant When appointment is to take place
... end 0..1 instant When appointment is to conclude
... created 0..1 dateTime The date that this appointment was initially created
... comment 0..1 string hl7fi: asiakkaalle tai ajanvarauksen katselijalle tarkoitettu vapaamuotoinen lisätieto
... patientInstruction 0..1 string hl7fi: vapaamuotoisena tekstinä ilmaistu potilasohje
.... extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... requestedPeriod 0..* Period Potential date/time interval(s) requested to allocate the appointment within

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... ServiceEvent 0..1 oid Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/fi-scheduling-service-event
.... TopicId 0..1 Identifier Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/TopicIdExtension
.... QueueNo 0..* string Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/QueueNoExtension
.... TicketNo 0..* string Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/TicketNoExtension
.... VisibleToCustodian 0..1 string Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/VisibleToCustodianExtension
.... CustomerJourney 0..* (Complex) Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/CustomerJourneyExtension
.... ParentAppointment 0..1 Identifier Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/ParentAppointment
.... SelfServiceExtension 0..1 (Complex) Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/SelfServiceExtension
.... ResourceCalendar 0..* (Complex) Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/ResourceCalendarIdExtension
.... ReferralId 0..* string Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/ReferralIdExtension
.... RequestedService 0..1 (Complex) Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/RequestedServiceExtension
.... MiscAppointmentData 0..1 string Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/MiscAppointmentDataExtension
.... PractitionerGender 0..1 Coding Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/PractitionerGenderExtension
.... NotificationMedium 0..* Coding Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/NotificationMediumExtension
.... CareGuarantee 0..1 string Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/CareGuaranteeExtension
.... AdditionalInformationURL 0..* url Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/AdditionalInformationURLExtension
.... CarePlan 0..* Identifier Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/CareplanIdentifierExtension
.... AppointmentMutability 0..1 (Complex) Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/AppointmentMutabilityExtension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... value Σ 1..1 string The value that is unique
Example General: 123456
... status ?!Σ 1..1 code suunniteltu | tilattu | varattu | peruttu | siirretty | alkanut | toteutunut | ehdotettu | saapumatta
Binding: AppointmentStatus (required): The free/busy status of an appointment.

... cancelationReason Σ 0..1 CodeableConcept The coded reason for the appointment being cancelled
Binding: AppointmentCancellationReason (example)
... serviceCategory Σ 0..* CodeableConcept A broad categorization of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
... serviceType Σ 1..* CodeableConcept The specific service that is to be performed during this appointment
Binding: ServiceType (example)
... appointmentType Σ 0..1 CodeableConcept The style of appointment or patient that has been booked in the slot (not service type)
Binding: hl7VS-appointmentReasonCodes (preferred)
... 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.


..... coding Σ 1..1 Coding Code defined by a terminology system
.... reasonCode:slicePalvelutarve Σ 0..1 CodeableConcept Coded reason this appointment is scheduled
Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place.


..... 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")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).


Fixed Value: Condition
... start Σ 0..1 instant When appointment is to take place
... end Σ 0..1 instant When appointment is to conclude
... created 0..1 dateTime The date that this appointment was initially created
... comment 0..1 string hl7fi: asiakkaalle tai ajanvarauksen katselijalle tarkoitettu vapaamuotoinen lisätieto
... patientInstruction 0..1 string hl7fi: vapaamuotoisena tekstinä ilmaistu potilasohje
.... extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... participant C 1..* BackboneElement Participants involved in appointment
app-1: Either the type or actor on the participant SHALL be specified
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.

... requestedPeriod 0..* Period Potential date/time interval(s) requested to allocate the appointment within

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Appointment.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Appointment.statusrequiredAppointmentStatus
http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1
from the FHIR Standard
Appointment.cancelationReasonexampleAppointmentCancellationReason
http://hl7.org/fhir/ValueSet/appointment-cancellation-reason
from the FHIR Standard
Appointment.serviceCategoryexampleServiceCategory
http://hl7.org/fhir/ValueSet/service-category
from the FHIR Standard
Appointment.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
from the FHIR Standard
Appointment.appointmentTypepreferredHl7VSAppointmentReasonCodes
http://terminology.hl7.org/ValueSet/v2-0276
Appointment.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
from the FHIR Standard
Appointment.reasonCode:sliceSisaltotarkennepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
from the FHIR Standard
Appointment.reasonCode:slicePalvelutarvepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
from the FHIR Standard
Appointment.reasonReference.typeextensibleFixed Value: Condition
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Appointment.participant.statusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
app-1errorAppointment.participantEither the type or actor on the participant SHALL be specified
: type.exists() or actor.exists()
app-2errorAppointmentEither start and end are specified, or neither
: start.exists() = end.exists()
app-3errorAppointmentOnly proposed or cancelled appointments can be missing start/end dates
: (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4errorAppointmentCancelation 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-2errorAppointmentIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAppointmentIf 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-4errorAppointmentIf 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-5errorAppointmentIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAppointmentA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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 BindingsPurpose
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
.... ServiceEvent 0..1 oid Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/fi-scheduling-service-event
.... TopicId 0..1 Identifier Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/TopicIdExtension
.... QueueNo 0..* string Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/QueueNoExtension
.... TicketNo 0..* string Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/TicketNoExtension
.... VisibleToCustodian 0..1 string Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/VisibleToCustodianExtension
.... CustomerJourney 0..* (Complex) Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/CustomerJourneyExtension
.... ParentAppointment 0..1 Identifier Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/ParentAppointment
.... SelfServiceExtension 0..1 (Complex) Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/SelfServiceExtension
.... ResourceCalendar 0..* (Complex) Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/ResourceCalendarIdExtension
.... ReferralId 0..* string Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/ReferralIdExtension
.... RequestedService 0..1 (Complex) Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/RequestedServiceExtension
.... MiscAppointmentData 0..1 string Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/MiscAppointmentDataExtension
.... PractitionerGender 0..1 Coding Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/PractitionerGenderExtension
.... NotificationMedium 0..* Coding Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/NotificationMediumExtension
.... CareGuarantee 0..1 string Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/CareGuaranteeExtension
.... AdditionalInformationURL 0..* url Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/AdditionalInformationURLExtension
.... CarePlan 0..* Identifier Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/CareplanIdentifierExtension
.... AppointmentMutability 0..1 (Complex) Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/AppointmentMutabilityExtension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..* Identifier External Ids for this item
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!Σ 1..1 code suunniteltu | tilattu | varattu | peruttu | siirretty | alkanut | toteutunut | ehdotettu | saapumatta
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 THL - Palvelutapahtuman peruuntumisen tai siirtymisen syy
Fixed Value: urn:oid:1.2.246.537.6.126.2008
..... 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
... serviceCategory Σ 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
.... 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 AR/YDIN - Palvelutapahtumaluokitus
Fixed Value: urn:oid:1.2.246.537.6.88.2008
..... 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
... serviceType Σ 1..* 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
.... 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 THL - Sosiaali- ja terveysalan palvelunimikkeistö
Fixed Value: urn:oid:1.2.246.537.6.49.201501
..... 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 hl7fi: asiointitapa
Fixed Value: 1.2.246.537.6.884.2015
..... 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
...... 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
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
.... 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
..... 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 hl7fi: asiakkaalle tai ajanvarauksen katselijalle tarkoitettu vapaamuotoinen lisätieto
... patientInstruction 0..1 string hl7fi: vapaamuotoisena tekstinä ilmaistu potilasohje
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Extension
Slice: Unordered, Open by value: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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Appointment.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Appointment.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Appointment.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Appointment.statusrequiredAppointmentStatus
http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1
from the FHIR Standard
Appointment.cancelationReasonexampleAppointmentCancellationReason
http://hl7.org/fhir/ValueSet/appointment-cancellation-reason
from the FHIR Standard
Appointment.serviceCategoryexampleServiceCategory
http://hl7.org/fhir/ValueSet/service-category
from the FHIR Standard
Appointment.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
from the FHIR Standard
Appointment.specialtypreferredPracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
from the FHIR Standard
Appointment.appointmentTypepreferredHl7VSAppointmentReasonCodes
http://terminology.hl7.org/ValueSet/v2-0276
Appointment.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
from the FHIR Standard
Appointment.reasonCode:sliceSisaltotarkennepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
from the FHIR Standard
Appointment.reasonCode:slicePalvelutarvepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
from the FHIR Standard
Appointment.reasonReference.typeextensibleFixed Value: Condition
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Appointment.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
from the FHIR Standard
Appointment.participant.requiredrequiredParticipantRequired
http://hl7.org/fhir/ValueSet/participantrequired|4.0.1
from the FHIR Standard
Appointment.participant.statusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
app-1errorAppointment.participantEither the type or actor on the participant SHALL be specified
: type.exists() or actor.exists()
app-2errorAppointmentEither start and end are specified, or neither
: start.exists() = end.exists()
app-3errorAppointmentOnly proposed or cancelled appointments can be missing start/end dates
: (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4errorAppointmentCancelation 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-2errorAppointmentIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAppointmentIf 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-4errorAppointmentIf 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-5errorAppointmentIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAppointmentA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Appointment

Summary

Mandatory: 3 elements(2 nested mandatory elements)
Fixed: 5 elements
Prohibited: 4 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

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

Differential View

This structure is derived from Appointment

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
.... ServiceEvent 0..1 oid Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/fi-scheduling-service-event
.... TopicId 0..1 Identifier Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/TopicIdExtension
.... QueueNo 0..* string Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/QueueNoExtension
.... TicketNo 0..* string Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/TicketNoExtension
.... VisibleToCustodian 0..1 string Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/VisibleToCustodianExtension
.... CustomerJourney 0..* (Complex) Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/CustomerJourneyExtension
.... ParentAppointment 0..1 Identifier Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/ParentAppointment
.... SelfServiceExtension 0..1 (Complex) Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/SelfServiceExtension
.... ResourceCalendar 0..* (Complex) Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/ResourceCalendarIdExtension
.... ReferralId 0..* string Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/ReferralIdExtension
.... RequestedService 0..1 (Complex) Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/RequestedServiceExtension
.... MiscAppointmentData 0..1 string Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/MiscAppointmentDataExtension
.... PractitionerGender 0..1 Coding Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/PractitionerGenderExtension
.... NotificationMedium 0..* Coding Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/NotificationMediumExtension
.... CareGuarantee 0..1 string Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/CareGuaranteeExtension
.... AdditionalInformationURL 0..* url Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/AdditionalInformationURLExtension
.... CarePlan 0..* Identifier Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/CareplanIdentifierExtension
.... AppointmentMutability 0..1 (Complex) Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/AppointmentMutabilityExtension
... identifier 1..* Identifier External Ids for this item
.... value 1..1 string The value that is unique
... status 1..1 code suunniteltu | tilattu | varattu | peruttu | siirretty | alkanut | toteutunut | ehdotettu | saapumatta
.... coding
..... system 0..1 uri THL - Palvelutapahtuman peruuntumisen tai siirtymisen syy
Fixed Value: urn:oid:1.2.246.537.6.126.2008
... serviceCategory 0..* CodeableConcept A broad categorization of the service that is to be performed during this appointment
.... coding
..... system 0..1 uri AR/YDIN - Palvelutapahtumaluokitus
Fixed Value: urn:oid:1.2.246.537.6.88.2008
... serviceType 1..* CodeableConcept The specific service that is to be performed during this appointment
.... coding
..... system 0..1 uri THL - Sosiaali- ja terveysalan palvelunimikkeistö
Fixed Value: urn:oid:1.2.246.537.6.49.201501
... appointmentType 0..1 CodeableConcept The style of appointment or patient that has been booked in the slot (not service type)
.... coding
..... system 0..1 uri hl7fi: asiointitapa
Fixed Value: 1.2.246.537.6.884.2015
... 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
...... version 0..0
...... userSelected 0..0
..... text 0..0
.... reasonCode:slicePalvelutarve 0..1 CodeableConcept Coded reason this appointment is scheduled
..... coding 0..0
..... 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
... start 0..1 instant When appointment is to take place
... end 0..1 instant When appointment is to conclude
... created 0..1 dateTime The date that this appointment was initially created
... comment 0..1 string hl7fi: asiakkaalle tai ajanvarauksen katselijalle tarkoitettu vapaamuotoinen lisätieto
... patientInstruction 0..1 string hl7fi: vapaamuotoisena tekstinä ilmaistu potilasohje
.... extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... requestedPeriod 0..* Period Potential date/time interval(s) requested to allocate the appointment within

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... ServiceEvent 0..1 oid Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/fi-scheduling-service-event
.... TopicId 0..1 Identifier Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/TopicIdExtension
.... QueueNo 0..* string Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/QueueNoExtension
.... TicketNo 0..* string Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/TicketNoExtension
.... VisibleToCustodian 0..1 string Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/VisibleToCustodianExtension
.... CustomerJourney 0..* (Complex) Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/CustomerJourneyExtension
.... ParentAppointment 0..1 Identifier Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/ParentAppointment
.... SelfServiceExtension 0..1 (Complex) Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/SelfServiceExtension
.... ResourceCalendar 0..* (Complex) Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/ResourceCalendarIdExtension
.... ReferralId 0..* string Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/ReferralIdExtension
.... RequestedService 0..1 (Complex) Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/RequestedServiceExtension
.... MiscAppointmentData 0..1 string Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/MiscAppointmentDataExtension
.... PractitionerGender 0..1 Coding Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/PractitionerGenderExtension
.... NotificationMedium 0..* Coding Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/NotificationMediumExtension
.... CareGuarantee 0..1 string Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/CareGuaranteeExtension
.... AdditionalInformationURL 0..* url Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/AdditionalInformationURLExtension
.... CarePlan 0..* Identifier Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/CareplanIdentifierExtension
.... AppointmentMutability 0..1 (Complex) Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/AppointmentMutabilityExtension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... value Σ 1..1 string The value that is unique
Example General: 123456
... status ?!Σ 1..1 code suunniteltu | tilattu | varattu | peruttu | siirretty | alkanut | toteutunut | ehdotettu | saapumatta
Binding: AppointmentStatus (required): The free/busy status of an appointment.

... cancelationReason Σ 0..1 CodeableConcept The coded reason for the appointment being cancelled
Binding: AppointmentCancellationReason (example)
... serviceCategory Σ 0..* CodeableConcept A broad categorization of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
... serviceType Σ 1..* CodeableConcept The specific service that is to be performed during this appointment
Binding: ServiceType (example)
... appointmentType Σ 0..1 CodeableConcept The style of appointment or patient that has been booked in the slot (not service type)
Binding: hl7VS-appointmentReasonCodes (preferred)
... 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.


..... coding Σ 1..1 Coding Code defined by a terminology system
.... reasonCode:slicePalvelutarve Σ 0..1 CodeableConcept Coded reason this appointment is scheduled
Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place.


..... 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")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).


Fixed Value: Condition
... start Σ 0..1 instant When appointment is to take place
... end Σ 0..1 instant When appointment is to conclude
... created 0..1 dateTime The date that this appointment was initially created
... comment 0..1 string hl7fi: asiakkaalle tai ajanvarauksen katselijalle tarkoitettu vapaamuotoinen lisätieto
... patientInstruction 0..1 string hl7fi: vapaamuotoisena tekstinä ilmaistu potilasohje
.... extension 0..* Extension Extension
Slice: Unordered, Open by value:url
... participant C 1..* BackboneElement Participants involved in appointment
app-1: Either the type or actor on the participant SHALL be specified
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.

... requestedPeriod 0..* Period Potential date/time interval(s) requested to allocate the appointment within

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Appointment.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Appointment.statusrequiredAppointmentStatus
http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1
from the FHIR Standard
Appointment.cancelationReasonexampleAppointmentCancellationReason
http://hl7.org/fhir/ValueSet/appointment-cancellation-reason
from the FHIR Standard
Appointment.serviceCategoryexampleServiceCategory
http://hl7.org/fhir/ValueSet/service-category
from the FHIR Standard
Appointment.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
from the FHIR Standard
Appointment.appointmentTypepreferredHl7VSAppointmentReasonCodes
http://terminology.hl7.org/ValueSet/v2-0276
Appointment.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
from the FHIR Standard
Appointment.reasonCode:sliceSisaltotarkennepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
from the FHIR Standard
Appointment.reasonCode:slicePalvelutarvepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
from the FHIR Standard
Appointment.reasonReference.typeextensibleFixed Value: Condition
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Appointment.participant.statusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
app-1errorAppointment.participantEither the type or actor on the participant SHALL be specified
: type.exists() or actor.exists()
app-2errorAppointmentEither start and end are specified, or neither
: start.exists() = end.exists()
app-3errorAppointmentOnly proposed or cancelled appointments can be missing start/end dates
: (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4errorAppointmentCancelation 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-2errorAppointmentIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAppointmentIf 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-4errorAppointmentIf 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-5errorAppointmentIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAppointmentA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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 BindingsPurpose
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
.... ServiceEvent 0..1 oid Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/fi-scheduling-service-event
.... TopicId 0..1 Identifier Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/TopicIdExtension
.... QueueNo 0..* string Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/QueueNoExtension
.... TicketNo 0..* string Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/TicketNoExtension
.... VisibleToCustodian 0..1 string Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/VisibleToCustodianExtension
.... CustomerJourney 0..* (Complex) Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/CustomerJourneyExtension
.... ParentAppointment 0..1 Identifier Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/ParentAppointment
.... SelfServiceExtension 0..1 (Complex) Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/SelfServiceExtension
.... ResourceCalendar 0..* (Complex) Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/ResourceCalendarIdExtension
.... ReferralId 0..* string Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/ReferralIdExtension
.... RequestedService 0..1 (Complex) Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/RequestedServiceExtension
.... MiscAppointmentData 0..1 string Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/MiscAppointmentDataExtension
.... PractitionerGender 0..1 Coding Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/PractitionerGenderExtension
.... NotificationMedium 0..* Coding Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/NotificationMediumExtension
.... CareGuarantee 0..1 string Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/CareGuaranteeExtension
.... AdditionalInformationURL 0..* url Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/AdditionalInformationURLExtension
.... CarePlan 0..* Identifier Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/CareplanIdentifierExtension
.... AppointmentMutability 0..1 (Complex) Extension
URL: https://hl7.fi/fhir/finnish-scheduling/StructureDefinition/AppointmentMutabilityExtension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..* Identifier External Ids for this item
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!Σ 1..1 code suunniteltu | tilattu | varattu | peruttu | siirretty | alkanut | toteutunut | ehdotettu | saapumatta
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 THL - Palvelutapahtuman peruuntumisen tai siirtymisen syy
Fixed Value: urn:oid:1.2.246.537.6.126.2008
..... 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
... serviceCategory Σ 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
.... 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 AR/YDIN - Palvelutapahtumaluokitus
Fixed Value: urn:oid:1.2.246.537.6.88.2008
..... 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
... serviceType Σ 1..* 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
.... 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 THL - Sosiaali- ja terveysalan palvelunimikkeistö
Fixed Value: urn:oid:1.2.246.537.6.49.201501
..... 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 hl7fi: asiointitapa
Fixed Value: 1.2.246.537.6.884.2015
..... 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
...... 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
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
.... 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
..... 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 hl7fi: asiakkaalle tai ajanvarauksen katselijalle tarkoitettu vapaamuotoinen lisätieto
... patientInstruction 0..1 string hl7fi: vapaamuotoisena tekstinä ilmaistu potilasohje
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Extension
Slice: Unordered, Open by value: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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Appointment.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Appointment.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Appointment.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Appointment.statusrequiredAppointmentStatus
http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1
from the FHIR Standard
Appointment.cancelationReasonexampleAppointmentCancellationReason
http://hl7.org/fhir/ValueSet/appointment-cancellation-reason
from the FHIR Standard
Appointment.serviceCategoryexampleServiceCategory
http://hl7.org/fhir/ValueSet/service-category
from the FHIR Standard
Appointment.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
from the FHIR Standard
Appointment.specialtypreferredPracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
from the FHIR Standard
Appointment.appointmentTypepreferredHl7VSAppointmentReasonCodes
http://terminology.hl7.org/ValueSet/v2-0276
Appointment.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
from the FHIR Standard
Appointment.reasonCode:sliceSisaltotarkennepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
from the FHIR Standard
Appointment.reasonCode:slicePalvelutarvepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
from the FHIR Standard
Appointment.reasonReference.typeextensibleFixed Value: Condition
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
Appointment.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
from the FHIR Standard
Appointment.participant.requiredrequiredParticipantRequired
http://hl7.org/fhir/ValueSet/participantrequired|4.0.1
from the FHIR Standard
Appointment.participant.statusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
app-1errorAppointment.participantEither the type or actor on the participant SHALL be specified
: type.exists() or actor.exists()
app-2errorAppointmentEither start and end are specified, or neither
: start.exists() = end.exists()
app-3errorAppointmentOnly proposed or cancelled appointments can be missing start/end dates
: (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4errorAppointmentCancelation 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-2errorAppointmentIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAppointmentIf 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-4errorAppointmentIf 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-5errorAppointmentIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAppointmentA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Appointment

Summary

Mandatory: 3 elements(2 nested mandatory elements)
Fixed: 5 elements
Prohibited: 4 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel, Schematron