ERA FHIR specification
1.0.0 - draft

ERA FHIR specification - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Extension: AppointmentReason

Official URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentReason Version: 1.0.0
Draft as of 2026-10-28 Computable Name: AppointmentReason

The extension indicates the reason for the appointment: information provided by the customer, the main reason for booking, and the professional's assessment of the customer's service need.

Context of Use

    This extension may be used on the following element(s)

Usage info

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Extension Content

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

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Extension 0..* Extension Reason for the appointment booking
Extension.Slices for extension Content/Rules for all slices
Extension.Slices for extension.extension:ReasonText 0..1 Extension Information provided by the customer
Extension.Slices for extension.extension:ReasonText.url 1..1 uri "ReasonText"
Extension.Slices for extension.extension:ReasonText.value[x] 1..1 string Value of extension
Extension.Slices for extension.extension:ReasonCode 0..* Extension Reason for contact
Extension.Slices for extension.extension:ReasonCode.url 1..1 uri "ReasonCode"
Extension.Slices for extension.extension:ReasonCode.value[x] 1..1 Coding Reason for contact
Binding: fipta-vs-contactreason (required)
Extension.Slices for extension.extension:ReasonCode.value[x].system 1..1 uri Identity of the terminology system
Extension.Slices for extension.extension:ReasonCode.value[x].version 0..0 Version of the system - if relevant
Extension.Slices for extension.extension:ReasonCode.value[x].code 1..1 code Reason for contact code value
Extension.Slices for extension.extension:ReasonCode.value[x].display 1..1 string Reason for contact name
Extension.Slices for extension.extension:ReasonCode.value[x].userSelected 0..0 If this coding was chosen directly by the user
Extension.Slices for extension.extension:ServiceNeed 0..1 Extension Service need
Extension.Slices for extension.extension:ServiceNeed.url 1..1 uri "ServiceNeed"
Extension.Slices for extension.extension:ServiceNeed.value[x] 1..1 string Value of extension
Extension.url 1..1 uri "https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentReason"
Extension.value[x] 0..0 Value of extension

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Extension 0..* Extension Reason for the appointment booking
Extension.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Extension.Slices for extension.extension:ReasonText 0..1 Extension Information provided by the customer
Extension.Slices for extension.extension:ReasonText.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:ReasonText.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Extension.Slices for extension.extension:ReasonText.url 1..1 uri "ReasonText"
Extension.Slices for extension.extension:ReasonText.value[x] 1..1 string Value of extension
Extension.Slices for extension.extension:ReasonCode 0..* Extension Reason for contact
Extension.Slices for extension.extension:ReasonCode.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:ReasonCode.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Extension.Slices for extension.extension:ReasonCode.url 1..1 uri "ReasonCode"
Extension.Slices for extension.extension:ReasonCode.value[x] 1..1 Coding Reason for contact
Binding: fipta-vs-contactreason (required)
Extension.Slices for extension.extension:ReasonCode.value[x].id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:ReasonCode.value[x].extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Extension.Slices for extension.extension:ReasonCode.value[x].system This element is included in summaries. 1..1 uri Identity of the terminology system
Extension.Slices for extension.extension:ReasonCode.value[x].code This element is included in summaries. 1..1 code Reason for contact code value
Extension.Slices for extension.extension:ReasonCode.value[x].display This element is included in summaries. 1..1 string Reason for contact name
Extension.Slices for extension.extension:ServiceNeed 0..1 Extension Service need
Extension.Slices for extension.extension:ServiceNeed.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:ServiceNeed.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Extension.Slices for extension.extension:ServiceNeed.url 1..1 uri "ServiceNeed"
Extension.Slices for extension.extension:ServiceNeed.value[x] 1..1 string Value of extension
Extension.url 1..1 uri "https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentReason"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: The extension indicates the reason for the appointment: information provided by the customer, the main reason for booking, and the professional's assessment of the customer's service need.

  • ReasonText: string: Information provided by the customer on the reason for the appointment, as free text.
  • ReasonCode: Coding: Main reason for booking the service using the THL/SNOMED CT Health Problems and Reasons for Contact nomenclature (THL/SNOMED CT - Terveysongelmat ja kontaktien syyt).
  • ServiceNeed: string: Professional's assessment of the customer's service need as free text.

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Extension 0..* Extension Reason for the appointment booking
Extension.Slices for extension Content/Rules for all slices
Extension.Slices for extension.extension:ReasonText 0..1 Extension Information provided by the customer
Extension.Slices for extension.extension:ReasonText.url 1..1 uri "ReasonText"
Extension.Slices for extension.extension:ReasonText.value[x] 1..1 string Value of extension
Extension.Slices for extension.extension:ReasonCode 0..* Extension Reason for contact
Extension.Slices for extension.extension:ReasonCode.url 1..1 uri "ReasonCode"
Extension.Slices for extension.extension:ReasonCode.value[x] 1..1 Coding Reason for contact
Binding: fipta-vs-contactreason (required)
Extension.Slices for extension.extension:ReasonCode.value[x].system 1..1 uri Identity of the terminology system
Extension.Slices for extension.extension:ReasonCode.value[x].version 0..0 Version of the system - if relevant
Extension.Slices for extension.extension:ReasonCode.value[x].code 1..1 code Reason for contact code value
Extension.Slices for extension.extension:ReasonCode.value[x].display 1..1 string Reason for contact name
Extension.Slices for extension.extension:ReasonCode.value[x].userSelected 0..0 If this coding was chosen directly by the user
Extension.Slices for extension.extension:ServiceNeed 0..1 Extension Service need
Extension.Slices for extension.extension:ServiceNeed.url 1..1 uri "ServiceNeed"
Extension.Slices for extension.extension:ServiceNeed.value[x] 1..1 string Value of extension
Extension.url 1..1 uri "https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentReason"
Extension.value[x] 0..0 Value of extension

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Extension 0..* Extension Reason for the appointment booking
Extension.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Extension.Slices for extension.extension:ReasonText 0..1 Extension Information provided by the customer
Extension.Slices for extension.extension:ReasonText.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:ReasonText.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Extension.Slices for extension.extension:ReasonText.url 1..1 uri "ReasonText"
Extension.Slices for extension.extension:ReasonText.value[x] 1..1 string Value of extension
Extension.Slices for extension.extension:ReasonCode 0..* Extension Reason for contact
Extension.Slices for extension.extension:ReasonCode.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:ReasonCode.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Extension.Slices for extension.extension:ReasonCode.url 1..1 uri "ReasonCode"
Extension.Slices for extension.extension:ReasonCode.value[x] 1..1 Coding Reason for contact
Binding: fipta-vs-contactreason (required)
Extension.Slices for extension.extension:ReasonCode.value[x].id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:ReasonCode.value[x].extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Extension.Slices for extension.extension:ReasonCode.value[x].system This element is included in summaries. 1..1 uri Identity of the terminology system
Extension.Slices for extension.extension:ReasonCode.value[x].code This element is included in summaries. 1..1 code Reason for contact code value
Extension.Slices for extension.extension:ReasonCode.value[x].display This element is included in summaries. 1..1 string Reason for contact name
Extension.Slices for extension.extension:ServiceNeed 0..1 Extension Service need
Extension.Slices for extension.extension:ServiceNeed.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:ServiceNeed.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Extension.Slices for extension.extension:ServiceNeed.url 1..1 uri "ServiceNeed"
Extension.Slices for extension.extension:ServiceNeed.value[x] 1..1 string Value of extension
Extension.url 1..1 uri "https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentReason"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: The extension indicates the reason for the appointment: information provided by the customer, the main reason for booking, and the professional's assessment of the customer's service need.

  • ReasonText: string: Information provided by the customer on the reason for the appointment, as free text.
  • ReasonCode: Coding: Main reason for booking the service using the THL/SNOMED CT Health Problems and Reasons for Contact nomenclature (THL/SNOMED CT - Terveysongelmat ja kontaktien syyt).
  • ServiceNeed: string: Professional's assessment of the customer's service need as free text.

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

Path Status Usage ValueSet Version Source
Extension.extension:ReasonCode.​value[x] Base required fipta-vs-contactreason 📦1.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
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()