Finnish Scheduling
0.2.0 - draft
Finnish Scheduling
0.2.0 - draft
This page is part of the Finnish Scheduling (v0.2.0: STU 1 Draft) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.fi/fhir/StructureDefinition/FinnishSchedulingAppointment | Version: 0.2.0 | |||
| Draft as of 2024-08-12 | Computable Name: FinnishSchedulingAppointment | |||
Profile for appointment (ajanvaraus) in Finnish Scheduling environment. The contents is based on the scheduling appointment spefication.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
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 | |
   ServiceEvent |
0..1 | Identifier | Extension URL: http://hl7.fi/fhir/StructureDefinition/ServiceEventExt | |
| TopicId |
0..1 | Identifier | Extension URL: http://hl7.fi/fhir/StructureDefinition/TopicIdExt | |
| QueueNo |
0..* | string | Extension URL: http://hl7.fi/fhir/StructureDefinition/QueueNoExt | |
| TicketNo |
0..* | string | Extension URL: http://hl7.fi/fhir/StructureDefinition/TicketNoExt | |
| VisibleToCustodian |
0..1 | string | Extension URL: http://hl7.fi/fhir/StructureDefinition/VisibleToCustodian | |
| CustomerJourney |
0..* | (Complex) | Extension URL: http://hl7.fi/fhir/StructureDefinition/CustomerJourneyExtension | |
| ParentAppointment |
0..1 | Identifier | Extension URL: http://hl7.fi/fhir/StructureDefinition/ParentAppointment | |
| SelfServiceExtension |
0..1 | (Complex) | Extension URL: http://hl7.fi/fhir/StructureDefinition/SelfServiceExtension | |
| ResourceCalendar |
0..* | (Complex) | Extension URL: http://hl7.fi/fhir/StructureDefinition/ResourceCalendarIdExtension | |
| ReferralId |
0..* | string | Extension URL: http://hl7.fi/fhir/StructureDefinition/ReferralIdExtension | |
| RequestedService |
0..1 | (Complex) | Extension URL: http://hl7.fi/fhir/StructureDefinition/RequestedServiceExtension | |
| MiscAppointmentData |
0..1 | string | Extension URL: http://hl7.fi/fhir/StructureDefinition/MiscAppointmentDataExtension | |
| PractitionerGender |
0..1 | Coding | Extension URL: http://hl7.fi/fhir/StructureDefinition/PractitionerGenderExtension | |
| NotificationMedium |
0..* | Coding | Extension URL: http://hl7.fi/fhir/StructureDefinition/NotificationMediumExtension | |
| CareGuarantee |
0..1 | string | Extension URL: http://hl7.fi/fhir/StructureDefinition/CareGuaranteeExtension | |
| AdditionalInformationURL |
0..* | url | Extension URL: http://hl7.fi/fhir/StructureDefinition/AdditionalInformationURLExtension | |
| CarePlan |
0..* | Identifier | Extension URL: http://hl7.fi/fhir/StructureDefinition/CareplanIdentifierExtension | |
 AppointmentMutability |
0..1 | (Complex) | Extension URL: http://hl7.fi/fhir/StructureDefinition/AppointmentMutabilityExtension | |
 identifier |
1..1 | Identifier | External Ids for this item | |
 use |
0..0 | |||
| type |
0..0 | |||
| value |
1..1 | string | The value that is unique | |
| period |
0..0 | |||
 assigner |
0..0 | |||
| status |
1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist | |
| cancelationReason |
0..1 | CodeableConcept | The coded reason for the appointment being cancelled | |
 coding |
||||
 system |
0..1 | uri | THL - Palvelutapahtuman peruuntumisen tai siirtymisen syy Fixed Value: urn:oid:1.2.246.537.6.126.2008 | |
| serviceCategory |
0..1 | 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..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 | |
| specialty |
0..0 | |||
| 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 | |
| identifier |
0..0 | |||
| display |
0..0 | |||
| priority |
0..0 | |||
| description |
0..0 | |||
| supportingInformation |
0..0 | |||
| start |
0..1 | instant | When appointment is to take place | |
| end |
0..1 | instant | When appointment is to conclude | |
| minutesDuration |
0..0 | |||
| 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 | |
| basedOn |
0..0 | |||
| requestedPeriod |
0..1 | Period | Potential date/time interval(s) requested to allocate the appointment within | |
| 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 |
 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 | Identifier | Extension URL: http://hl7.fi/fhir/StructureDefinition/ServiceEventExt | |
| TopicId |
0..1 | Identifier | Extension URL: http://hl7.fi/fhir/StructureDefinition/TopicIdExt | |
| QueueNo |
0..* | string | Extension URL: http://hl7.fi/fhir/StructureDefinition/QueueNoExt | |
| TicketNo |
0..* | string | Extension URL: http://hl7.fi/fhir/StructureDefinition/TicketNoExt | |
| VisibleToCustodian |
0..1 | string | Extension URL: http://hl7.fi/fhir/StructureDefinition/VisibleToCustodian | |
| CustomerJourney |
0..* | (Complex) | Extension URL: http://hl7.fi/fhir/StructureDefinition/CustomerJourneyExtension | |
| ParentAppointment |
0..1 | Identifier | Extension URL: http://hl7.fi/fhir/StructureDefinition/ParentAppointment | |
| SelfServiceExtension |
0..1 | (Complex) | Extension URL: http://hl7.fi/fhir/StructureDefinition/SelfServiceExtension | |
| ResourceCalendar |
0..* | (Complex) | Extension URL: http://hl7.fi/fhir/StructureDefinition/ResourceCalendarIdExtension | |
| ReferralId |
0..* | string | Extension URL: http://hl7.fi/fhir/StructureDefinition/ReferralIdExtension | |
| RequestedService |
0..1 | (Complex) | Extension URL: http://hl7.fi/fhir/StructureDefinition/RequestedServiceExtension | |
| MiscAppointmentData |
0..1 | string | Extension URL: http://hl7.fi/fhir/StructureDefinition/MiscAppointmentDataExtension | |
| PractitionerGender |
0..1 | Coding | Extension URL: http://hl7.fi/fhir/StructureDefinition/PractitionerGenderExtension | |
| NotificationMedium |
0..* | Coding | Extension URL: http://hl7.fi/fhir/StructureDefinition/NotificationMediumExtension | |
| CareGuarantee |
0..1 | string | Extension URL: http://hl7.fi/fhir/StructureDefinition/CareGuaranteeExtension | |
| AdditionalInformationURL |
0..* | url | Extension URL: http://hl7.fi/fhir/StructureDefinition/AdditionalInformationURLExtension | |
| CarePlan |
0..* | Identifier | Extension URL: http://hl7.fi/fhir/StructureDefinition/CareplanIdentifierExtension | |
| AppointmentMutability |
0..1 | (Complex) | Extension URL: http://hl7.fi/fhir/StructureDefinition/AppointmentMutabilityExtension | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
 identifier |
Σ | 1..1 | Identifier | External Ids for this item |
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
| 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) |
| serviceCategory |
Σ | 0..1 | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) |
| serviceType |
Σ | 1..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..1 | Period | Potential date/time interval(s) requested to allocate the appointment within | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Appointment.status | required | AppointmentStatushttp://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1from the FHIR Standard | |
| Appointment.cancelationReason | example | AppointmentCancellationReasonhttp://hl7.org/fhir/ValueSet/appointment-cancellation-reasonfrom the FHIR Standard | |
| Appointment.serviceCategory | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-categoryfrom the FHIR Standard | |
| Appointment.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-typefrom the FHIR Standard | |
| Appointment.appointmentType | preferred | Hl7VSAppointmentReasonCodeshttp://terminology.hl7.org/ValueSet/v2-0276 | |
| Appointment.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reasonfrom the FHIR Standard | |
| Appointment.reasonCode:sliceSisaltotarkenne | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reasonfrom the FHIR Standard | |
| Appointment.reasonCode:slicePalvelutarve | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reasonfrom the FHIR Standard | |
| Appointment.reasonReference.type | extensible | Fixed Value: Conditionhttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| Appointment.participant.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1from the FHIR Standard |
| 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() |
| 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.
| |||||
| 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 | Identifier | Extension URL: http://hl7.fi/fhir/StructureDefinition/ServiceEventExt | |||||
| TopicId |
0..1 | Identifier | Extension URL: http://hl7.fi/fhir/StructureDefinition/TopicIdExt | |||||
| QueueNo |
0..* | string | Extension URL: http://hl7.fi/fhir/StructureDefinition/QueueNoExt | |||||
| TicketNo |
0..* | string | Extension URL: http://hl7.fi/fhir/StructureDefinition/TicketNoExt | |||||
| VisibleToCustodian |
0..1 | string | Extension URL: http://hl7.fi/fhir/StructureDefinition/VisibleToCustodian | |||||
| CustomerJourney |
0..* | (Complex) | Extension URL: http://hl7.fi/fhir/StructureDefinition/CustomerJourneyExtension | |||||
| ParentAppointment |
0..1 | Identifier | Extension URL: http://hl7.fi/fhir/StructureDefinition/ParentAppointment | |||||
| SelfServiceExtension |
0..1 | (Complex) | Extension URL: http://hl7.fi/fhir/StructureDefinition/SelfServiceExtension | |||||
| ResourceCalendar |
0..* | (Complex) | Extension URL: http://hl7.fi/fhir/StructureDefinition/ResourceCalendarIdExtension | |||||
| ReferralId |
0..* | string | Extension URL: http://hl7.fi/fhir/StructureDefinition/ReferralIdExtension | |||||
| RequestedService |
0..1 | (Complex) | Extension URL: http://hl7.fi/fhir/StructureDefinition/RequestedServiceExtension | |||||
| MiscAppointmentData |
0..1 | string | Extension URL: http://hl7.fi/fhir/StructureDefinition/MiscAppointmentDataExtension | |||||
| PractitionerGender |
0..1 | Coding | Extension URL: http://hl7.fi/fhir/StructureDefinition/PractitionerGenderExtension | |||||
| NotificationMedium |
0..* | Coding | Extension URL: http://hl7.fi/fhir/StructureDefinition/NotificationMediumExtension | |||||
| CareGuarantee |
0..1 | string | Extension URL: http://hl7.fi/fhir/StructureDefinition/CareGuaranteeExtension | |||||
| AdditionalInformationURL |
0..* | url | Extension URL: http://hl7.fi/fhir/StructureDefinition/AdditionalInformationURLExtension | |||||
| CarePlan |
0..* | Identifier | Extension URL: http://hl7.fi/fhir/StructureDefinition/CareplanIdentifierExtension | |||||
| AppointmentMutability |
0..1 | (Complex) | Extension URL: http://hl7.fi/fhir/StructureDefinition/AppointmentMutabilityExtension | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 1..1 | Identifier | External Ids for this item | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| 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 | ||||
| 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 | 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..1 | 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..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 | ||||
| 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 | ||||
| start |
Σ | 0..1 | instant | When appointment is to take place | ||||
| end |
Σ | 0..1 | instant | When appointment is to conclude | ||||
| 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 | |||||
| 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..1 | Period | Potential date/time interval(s) requested to allocate the appointment within | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Appointment.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Appointment.status | required | AppointmentStatushttp://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1from the FHIR Standard | ||||
| Appointment.cancelationReason | example | AppointmentCancellationReasonhttp://hl7.org/fhir/ValueSet/appointment-cancellation-reasonfrom the FHIR Standard | ||||
| Appointment.serviceCategory | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-categoryfrom the FHIR Standard | ||||
| Appointment.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-typefrom the FHIR Standard | ||||
| Appointment.appointmentType | preferred | Hl7VSAppointmentReasonCodeshttp://terminology.hl7.org/ValueSet/v2-0276 | ||||
| Appointment.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reasonfrom the FHIR Standard | ||||
| Appointment.reasonCode:sliceSisaltotarkenne | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reasonfrom the FHIR Standard | ||||
| Appointment.reasonCode:slicePalvelutarve | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reasonfrom the FHIR Standard | ||||
| Appointment.reasonReference.type | extensible | Fixed Value: Conditionhttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| Appointment.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-typefrom the FHIR Standard | ||||
| Appointment.participant.required | required | ParticipantRequiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1from the FHIR Standard | ||||
| Appointment.participant.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1from the FHIR Standard |
| 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: 3 elements(2 nested mandatory elements)
Fixed: 5 elements
Prohibited: 16 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
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 | |
| ServiceEvent |
0..1 | Identifier | Extension URL: http://hl7.fi/fhir/StructureDefinition/ServiceEventExt | |
| TopicId |
0..1 | Identifier | Extension URL: http://hl7.fi/fhir/StructureDefinition/TopicIdExt | |
| QueueNo |
0..* | string | Extension URL: http://hl7.fi/fhir/StructureDefinition/QueueNoExt | |
| TicketNo |
0..* | string | Extension URL: http://hl7.fi/fhir/StructureDefinition/TicketNoExt | |
| VisibleToCustodian |
0..1 | string | Extension URL: http://hl7.fi/fhir/StructureDefinition/VisibleToCustodian | |
| CustomerJourney |
0..* | (Complex) | Extension URL: http://hl7.fi/fhir/StructureDefinition/CustomerJourneyExtension | |
| ParentAppointment |
0..1 | Identifier | Extension URL: http://hl7.fi/fhir/StructureDefinition/ParentAppointment | |
| SelfServiceExtension |
0..1 | (Complex) | Extension URL: http://hl7.fi/fhir/StructureDefinition/SelfServiceExtension | |
| ResourceCalendar |
0..* | (Complex) | Extension URL: http://hl7.fi/fhir/StructureDefinition/ResourceCalendarIdExtension | |
| ReferralId |
0..* | string | Extension URL: http://hl7.fi/fhir/StructureDefinition/ReferralIdExtension | |
| RequestedService |
0..1 | (Complex) | Extension URL: http://hl7.fi/fhir/StructureDefinition/RequestedServiceExtension | |
| MiscAppointmentData |
0..1 | string | Extension URL: http://hl7.fi/fhir/StructureDefinition/MiscAppointmentDataExtension | |
| PractitionerGender |
0..1 | Coding | Extension URL: http://hl7.fi/fhir/StructureDefinition/PractitionerGenderExtension | |
| NotificationMedium |
0..* | Coding | Extension URL: http://hl7.fi/fhir/StructureDefinition/NotificationMediumExtension | |
| CareGuarantee |
0..1 | string | Extension URL: http://hl7.fi/fhir/StructureDefinition/CareGuaranteeExtension | |
| AdditionalInformationURL |
0..* | url | Extension URL: http://hl7.fi/fhir/StructureDefinition/AdditionalInformationURLExtension | |
| CarePlan |
0..* | Identifier | Extension URL: http://hl7.fi/fhir/StructureDefinition/CareplanIdentifierExtension | |
| AppointmentMutability |
0..1 | (Complex) | Extension URL: http://hl7.fi/fhir/StructureDefinition/AppointmentMutabilityExtension | |
| identifier |
1..1 | Identifier | External Ids for this item | |
| use |
0..0 | |||
| type |
0..0 | |||
| value |
1..1 | string | The value that is unique | |
| period |
0..0 | |||
| assigner |
0..0 | |||
| status |
1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist | |
| cancelationReason |
0..1 | CodeableConcept | The coded reason for the appointment being cancelled | |
| coding |
||||
| system |
0..1 | uri | THL - Palvelutapahtuman peruuntumisen tai siirtymisen syy Fixed Value: urn:oid:1.2.246.537.6.126.2008 | |
| serviceCategory |
0..1 | 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..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 | |
| specialty |
0..0 | |||
| 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 | |
| identifier |
0..0 | |||
| display |
0..0 | |||
| priority |
0..0 | |||
| description |
0..0 | |||
| supportingInformation |
0..0 | |||
| start |
0..1 | instant | When appointment is to take place | |
| end |
0..1 | instant | When appointment is to conclude | |
| minutesDuration |
0..0 | |||
| 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 | |
| basedOn |
0..0 | |||
| requestedPeriod |
0..1 | Period | Potential date/time interval(s) requested to allocate the appointment within | |
| Documentation for this format | ||||
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 |
| 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 | Identifier | Extension URL: http://hl7.fi/fhir/StructureDefinition/ServiceEventExt | |
| TopicId |
0..1 | Identifier | Extension URL: http://hl7.fi/fhir/StructureDefinition/TopicIdExt | |
| QueueNo |
0..* | string | Extension URL: http://hl7.fi/fhir/StructureDefinition/QueueNoExt | |
| TicketNo |
0..* | string | Extension URL: http://hl7.fi/fhir/StructureDefinition/TicketNoExt | |
| VisibleToCustodian |
0..1 | string | Extension URL: http://hl7.fi/fhir/StructureDefinition/VisibleToCustodian | |
| CustomerJourney |
0..* | (Complex) | Extension URL: http://hl7.fi/fhir/StructureDefinition/CustomerJourneyExtension | |
| ParentAppointment |
0..1 | Identifier | Extension URL: http://hl7.fi/fhir/StructureDefinition/ParentAppointment | |
| SelfServiceExtension |
0..1 | (Complex) | Extension URL: http://hl7.fi/fhir/StructureDefinition/SelfServiceExtension | |
| ResourceCalendar |
0..* | (Complex) | Extension URL: http://hl7.fi/fhir/StructureDefinition/ResourceCalendarIdExtension | |
| ReferralId |
0..* | string | Extension URL: http://hl7.fi/fhir/StructureDefinition/ReferralIdExtension | |
| RequestedService |
0..1 | (Complex) | Extension URL: http://hl7.fi/fhir/StructureDefinition/RequestedServiceExtension | |
| MiscAppointmentData |
0..1 | string | Extension URL: http://hl7.fi/fhir/StructureDefinition/MiscAppointmentDataExtension | |
| PractitionerGender |
0..1 | Coding | Extension URL: http://hl7.fi/fhir/StructureDefinition/PractitionerGenderExtension | |
| NotificationMedium |
0..* | Coding | Extension URL: http://hl7.fi/fhir/StructureDefinition/NotificationMediumExtension | |
| CareGuarantee |
0..1 | string | Extension URL: http://hl7.fi/fhir/StructureDefinition/CareGuaranteeExtension | |
| AdditionalInformationURL |
0..* | url | Extension URL: http://hl7.fi/fhir/StructureDefinition/AdditionalInformationURLExtension | |
| CarePlan |
0..* | Identifier | Extension URL: http://hl7.fi/fhir/StructureDefinition/CareplanIdentifierExtension | |
| AppointmentMutability |
0..1 | (Complex) | Extension URL: http://hl7.fi/fhir/StructureDefinition/AppointmentMutabilityExtension | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
Σ | 1..1 | Identifier | External Ids for this item |
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
| 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) |
| serviceCategory |
Σ | 0..1 | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) |
| serviceType |
Σ | 1..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..1 | Period | Potential date/time interval(s) requested to allocate the appointment within | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Appointment.status | required | AppointmentStatushttp://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1from the FHIR Standard | |
| Appointment.cancelationReason | example | AppointmentCancellationReasonhttp://hl7.org/fhir/ValueSet/appointment-cancellation-reasonfrom the FHIR Standard | |
| Appointment.serviceCategory | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-categoryfrom the FHIR Standard | |
| Appointment.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-typefrom the FHIR Standard | |
| Appointment.appointmentType | preferred | Hl7VSAppointmentReasonCodeshttp://terminology.hl7.org/ValueSet/v2-0276 | |
| Appointment.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reasonfrom the FHIR Standard | |
| Appointment.reasonCode:sliceSisaltotarkenne | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reasonfrom the FHIR Standard | |
| Appointment.reasonCode:slicePalvelutarve | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reasonfrom the FHIR Standard | |
| Appointment.reasonReference.type | extensible | Fixed Value: Conditionhttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| Appointment.participant.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1from the FHIR Standard |
| 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() |
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.
| |||||
| 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 | Identifier | Extension URL: http://hl7.fi/fhir/StructureDefinition/ServiceEventExt | |||||
| TopicId |
0..1 | Identifier | Extension URL: http://hl7.fi/fhir/StructureDefinition/TopicIdExt | |||||
| QueueNo |
0..* | string | Extension URL: http://hl7.fi/fhir/StructureDefinition/QueueNoExt | |||||
| TicketNo |
0..* | string | Extension URL: http://hl7.fi/fhir/StructureDefinition/TicketNoExt | |||||
| VisibleToCustodian |
0..1 | string | Extension URL: http://hl7.fi/fhir/StructureDefinition/VisibleToCustodian | |||||
| CustomerJourney |
0..* | (Complex) | Extension URL: http://hl7.fi/fhir/StructureDefinition/CustomerJourneyExtension | |||||
| ParentAppointment |
0..1 | Identifier | Extension URL: http://hl7.fi/fhir/StructureDefinition/ParentAppointment | |||||
| SelfServiceExtension |
0..1 | (Complex) | Extension URL: http://hl7.fi/fhir/StructureDefinition/SelfServiceExtension | |||||
| ResourceCalendar |
0..* | (Complex) | Extension URL: http://hl7.fi/fhir/StructureDefinition/ResourceCalendarIdExtension | |||||
| ReferralId |
0..* | string | Extension URL: http://hl7.fi/fhir/StructureDefinition/ReferralIdExtension | |||||
| RequestedService |
0..1 | (Complex) | Extension URL: http://hl7.fi/fhir/StructureDefinition/RequestedServiceExtension | |||||
| MiscAppointmentData |
0..1 | string | Extension URL: http://hl7.fi/fhir/StructureDefinition/MiscAppointmentDataExtension | |||||
| PractitionerGender |
0..1 | Coding | Extension URL: http://hl7.fi/fhir/StructureDefinition/PractitionerGenderExtension | |||||
| NotificationMedium |
0..* | Coding | Extension URL: http://hl7.fi/fhir/StructureDefinition/NotificationMediumExtension | |||||
| CareGuarantee |
0..1 | string | Extension URL: http://hl7.fi/fhir/StructureDefinition/CareGuaranteeExtension | |||||
| AdditionalInformationURL |
0..* | url | Extension URL: http://hl7.fi/fhir/StructureDefinition/AdditionalInformationURLExtension | |||||
| CarePlan |
0..* | Identifier | Extension URL: http://hl7.fi/fhir/StructureDefinition/CareplanIdentifierExtension | |||||
| AppointmentMutability |
0..1 | (Complex) | Extension URL: http://hl7.fi/fhir/StructureDefinition/AppointmentMutabilityExtension | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 1..1 | Identifier | External Ids for this item | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| 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 | ||||
| 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 | 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..1 | 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..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 | ||||
| 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 | ||||
| start |
Σ | 0..1 | instant | When appointment is to take place | ||||
| end |
Σ | 0..1 | instant | When appointment is to conclude | ||||
| 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 | |||||
| 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..1 | Period | Potential date/time interval(s) requested to allocate the appointment within | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Appointment.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Appointment.status | required | AppointmentStatushttp://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1from the FHIR Standard | ||||
| Appointment.cancelationReason | example | AppointmentCancellationReasonhttp://hl7.org/fhir/ValueSet/appointment-cancellation-reasonfrom the FHIR Standard | ||||
| Appointment.serviceCategory | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-categoryfrom the FHIR Standard | ||||
| Appointment.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-typefrom the FHIR Standard | ||||
| Appointment.appointmentType | preferred | Hl7VSAppointmentReasonCodeshttp://terminology.hl7.org/ValueSet/v2-0276 | ||||
| Appointment.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reasonfrom the FHIR Standard | ||||
| Appointment.reasonCode:sliceSisaltotarkenne | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reasonfrom the FHIR Standard | ||||
| Appointment.reasonCode:slicePalvelutarve | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reasonfrom the FHIR Standard | ||||
| Appointment.reasonReference.type | extensible | Fixed Value: Conditionhttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| Appointment.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-typefrom the FHIR Standard | ||||
| Appointment.participant.required | required | ParticipantRequiredhttp://hl7.org/fhir/ValueSet/participantrequired|4.0.1from the FHIR Standard | ||||
| Appointment.participant.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1from the FHIR Standard |
| 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: 3 elements(2 nested mandatory elements)
Fixed: 5 elements
Prohibited: 16 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2023+ HL7 Finland. Package hl7.fhir.fi.scheduling#0.2.0 based on FHIR 4.0.1. Generated 2024-08-12
Links: Table of Contents
| QA Report| Version History
| 
| Source
| Propose a change