Finnish Scheduling
0.2.0 - draft Finland flag

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

Resource Profile: FiSchedulingAppointment - Detailed Descriptions

Draft as of 2024-08-12

Definitions for the fi-scheduling-appointment resource profile.

Guidance on how to interpret the contents of this table can be found here

0. Appointment
2. Appointment.extension
SlicingThis element introduces a set of slices on Appointment.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 4. Appointment.extension:ServiceEvent
    Slice NameServiceEvent
    Control0..1
    TypeExtension(ServiceEventExtension) (Extension Type: Identifier)
    Requirements

    22 Palvelutapahtuman tunniste

    6. Appointment.extension:TopicId
    Slice NameTopicId
    Control0..1
    TypeExtension(TopicIdExtension) (Extension Type: Identifier)
    Requirements

    23 Asian tunniste

    8. Appointment.extension:QueueNo
    Slice NameQueueNo
    Control0..*
    TypeExtension(QueueNoExtension) (Extension Type: string)
    Requirements

    82 Jonotusnumero

    10. Appointment.extension:TicketNo
    Slice NameTicketNo
    Control0..*
    TypeExtension(TicketNoExtension) (Extension Type: string)
    Requirements

    101 Tikettinumero

    12. Appointment.extension:VisibleToCustodian
    Slice NameVisibleToCustodian
    Control0..1
    TypeExtension(VisibleToCustodianExtension) (Extension Type: string)
    Requirements

    59 Ajanvarauksen tietojen näyttäminen huoltajalle

    14. Appointment.extension:CustomerJourney
    Slice NameCustomerJourney
    Control0..*
    TypeExtension(CustomerJourneyExtension) (Complex Extension)
    Requirements

    20 Asiakaspolun tunniste 20.1 Asiakaspolun nimi

    16. Appointment.extension:ParentAppointment
    Slice NameParentAppointment
    Control0..1
    TypeExtension(ParentAppointment) (Extension Type: Identifier)
    Requirements

    12 Pääajanvaraus

    18. Appointment.extension:SelfServiceExtension
    Slice NameSelfServiceExtension
    Control0..1
    TypeExtension(SelfServiceExtension) (Complex Extension)
    Requirements

    84 AsiointiURL 84.1 Järjestelmä tukee alaikäisen puolesta asiointia 84.2 Järjestelmä tukee puolesta-asiointia valtakirjalla täysi-ikäisen puolesta 84.3 Järjestelmä tukee rekisteripohjaista puolesta-asiointia täysi-ikäisen puolesta

    20. Appointment.extension:ResourceCalendar
    Slice NameResourceCalendar
    Control0..*
    TypeExtension(ResourceCalendarIdExtension) (Complex Extension)
    Requirements

    74 Resurssin kalenteritunniste 75 Resurssin nimi

    22. Appointment.extension:ReferralId
    Slice NameReferralId
    Control0..*
    TypeExtension(ReferralIdExtension) (Extension Type: string)
    Requirements

    24 Ajanvaraukseen liittyvän lähetteen tai pyynnön tunniste

    24. Appointment.extension:RequestedService
    Slice NameRequestedService
    Control0..1
    TypeExtension(RequestedServiceExtension) (Complex Extension)
    Requirements

    73 Varaustuote 73.1 Varaustuotteen nimi

    26. Appointment.extension:MiscAppointmentData
    Slice NameMiscAppointmentData
    Control0..1
    TypeExtension(MiscAppointmentDataExtension) (Extension Type: string)
    Requirements

    91 Muu sisältö

    28. Appointment.extension:PractitionerGender
    Slice NamePractitionerGender
    Control0..1
    TypeExtension(PractitionerGenderExtension) (Extension Type: Coding)
    Requirements

    93 Palvelun toteuttajan sukupuoli

    30. Appointment.extension:NotificationMedium
    Slice NameNotificationMedium
    Control0..*
    TypeExtension(NotificationMediumExtension) (Extension Type: Coding)
    Requirements

    94 Muistutuksen tapa

    32. Appointment.extension:CareGuarantee
    Slice NameCareGuarantee
    Control0..1
    TypeExtension(CareGuaranteeExtension) (Extension Type: string)
    Requirements

    97 Hoitotakuu

    34. Appointment.extension:AdditionalInformationURL
    Slice NameAdditionalInformationURL
    Control0..*
    TypeExtension(AdditionalInformationURLExtension) (Extension Type: url)
    Requirements

    98 Lisätietojen osoite

    36. Appointment.extension:CarePlan
    Slice NameCarePlan
    Control0..*
    TypeExtension(CareplanIdentifierExtension) (Extension Type: Identifier)
    Requirements

    17 Ajanvaraukseen liittyvän suunnitelman tunniste

    38. Appointment.extension:AppointmentMutability
    Slice NameAppointmentMutability
    Control0..1
    TypeExtension(AppointmentMutabilityExtension) (Complex Extension)
    Requirements

    95 Peruttavissa 96 Siirrettävissä 96.1 Peruutuksen tai siirron aikaraja

    40. Appointment.identifier
    Definition

    hl7fi: 18 Ajanvarauksen tunniste - mandatory, not recurring

    This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).

    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control1..?
    42. Appointment.identifier.value
    Control1..?
    44. Appointment.status
    Shortsuunniteltu | tilattu | varattu | peruttu | siirretty | alkanut | toteutunut | ehdotettu | saapumatta
    Comments

    hl7fi: Requires mapping to Ajanvarauksen tila code set (1.2.246.537.6.881.201501). Other mappings ok apart from "siirretty" (rescheduled) ja "suunniteltu".

    If the Appointment's status is "cancelled" then all participants are expected to have their calendars released for the appointment period, and as such any Slots that were marked as BUSY can be re-set to FREE.

    This element is labeled as a modifier because the status contains the code entered-in-error that mark the Appointment as not currently valid.

    Requirements

    19 Ajanvarauksen tila

    46. Appointment.cancelationReason
    Requirements

    19.1 Ajanvarauksen perumisen tai siirtämisen syy

    Mandatory, if cancellation status is equivalent to "Siirretty" or "Peruttu"

    48. Appointment.cancelationReason.coding
    50. Appointment.cancelationReason.coding.system
    ShortTHL - Palvelutapahtuman peruuntumisen tai siirtymisen syy
    Fixed Valueurn:oid:1.2.246.537.6.126.2008
    52. Appointment.serviceCategory
    Requirements

    71.1 Palvelun luokka

    54. Appointment.serviceCategory.coding
    56. Appointment.serviceCategory.coding.system
    Definition

    hl7fi: koodilla ilmaistu tieto palveluluokasta, johon ajanvaraus kohdistuu Huom. Palveluluokka ilmaistaan THL - Sosiaali- ja terveyspalvelujen luokituksen avulla.

    ShortAR/YDIN - Palvelutapahtumaluokitus
    Fixed Valueurn:oid:1.2.246.537.6.88.2008
    58. Appointment.serviceType
    Control1..?
    Requirements

    71 Palvelun nimi

    60. Appointment.serviceType.coding
    62. Appointment.serviceType.coding.system
    ShortTHL - Sosiaali- ja terveysalan palvelunimikkeistö
    Comments

    hl7fi: koodilla ilmaistu tieto palvelusta, johon ajanvaraus kohdistuu Huom. Palvelun nimi ilmaistaan THL - Sosiaali- ja terveysalan palvelunimikkeistön avulla.

    The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

    Requirements

    71 Palvelun nimi

    Fixed Valueurn:oid:1.2.246.537.6.49.201501
    64. Appointment.appointmentType
    Requirements

    72 Asiointitapa

    66. Appointment.appointmentType.coding
    68. Appointment.appointmentType.coding.system
    Definition

    hl7fi: koodilla ilmaistu tieto ammattihenkilön ja asiakkaan välisen asioinnin tavasta

    Shorthl7fi: asiointitapa
    Fixed Value1.2.246.537.6.884.2015
    70. Appointment.reasonCode
    SlicingThis element introduces a set of slices on Appointment.reasonCode. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • exists @ coding
    • 72. Appointment.reasonCode:sliceSisaltotarkenne
      Slice NamesliceSisaltotarkenne
      Definition

      hl7fi: 85 Varauksen sisältötarkenne, koodilla ilmaistu tarkentava tieto palvelun sisällöstä Huom. Tarkenteeksi voi valita useamman kuin yhden koodin, ja koodit voivat kuvata esimerkiksi sitä, mitä kuvantamis- tai laboratoriotutkimuksia tai toimenpiteitä suoritetaan.

      Control0..*
      Requirements

      85 Varauksen sisältötarkenne

      74. Appointment.reasonCode:sliceSisaltotarkenne.coding
      Control1..1
      76. Appointment.reasonCode:sliceSisaltotarkenne.coding.version
      NoteThis is a business version Id, not a resource version Id (see discussion)
      Control0..0
      78. Appointment.reasonCode:sliceSisaltotarkenne.coding.userSelected
      Control0..0
      80. Appointment.reasonCode:sliceSisaltotarkenne.text
      Control0..0
      82. Appointment.reasonCode:slicePalvelutarve
      Slice NameslicePalvelutarve
      Definition

      hl7fi: 76 Palvelutarve vapaamuotoisena tekstinä ilmaistu tieto asiakkaan palvelutarpeesta Huom. Palvelutarve kuvataan tasolla, jolla henkilön palveluiden tarve voidaan kuvata yhteisellä termillä, esim. raskausajan seuranta ja tuki.

      Control0..1
      Requirements

      76 Palvelutarve

      84. Appointment.reasonCode:slicePalvelutarve.coding
      Control0..0
      86. Appointment.reasonCode:slicePalvelutarve.text
      Control1..?
      88. Appointment.reasonReference
      TypeReference(Condition)contained
      Requirements

      56 kuvaus oireista/vaivasta ja 57 riskitiedot (Condition/Note)

      90. Appointment.reasonReference.type
      Fixed ValueCondition
      92. Appointment.start
      Requirements

      86 Aikaväli

      94. Appointment.end
      Requirements

      86 Aikaväli

      96. Appointment.created
      Requirements

      38 Merkinnän kirjausaika

      98. Appointment.comment
      Definition

      hl7fi: asiakkaalle tai ajanvarauksen katselijalle tarkoitettu vapaamuotoinen lisätieto

      Shorthl7fi: asiakkaalle tai ajanvarauksen katselijalle tarkoitettu vapaamuotoinen lisätieto
      Requirements

      99 Huomautukset

      100. Appointment.patientInstruction
      Definition

      hl7fi: vapaamuotoisena tekstinä ilmaistu potilasohje, joka tarjoaa asiakkaalle tietoa esimerkiksi sairaudesta, tutkimuksista, hoidoista, toimenpiteisiin valmistautumisesta, jälkihoidosta, itsehoidosta, toipumisesta, sairauden kulusta ja sairauden ennusteesta Huom. Potilasohje voi olla esim. Käypä hoito -suositus tai yleinen sairaalan antama ohje, joka voi olla myös yksikkökohtainen.

      Shorthl7fi: vapaamuotoisena tekstinä ilmaistu potilasohje
      Requirements

      100 Potilasohje

      102. Appointment.patientInstruction.extension
      SlicingThis element introduces a set of slices on Appointment.patientInstruction.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 104. Appointment.requestedPeriod
        Requirements

        35 Ajankohta, jolloin ajanvaraus ohjeistettu tehtäväksi

        Guidance on how to interpret the contents of this table can be found here

        0. Appointment
        Definition

        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).

        ShortA 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)
        Control0..*
        Is Modifierfalse
        Summaryfalse
        Invariantsapp-2: Either start and end are specified, or neither (start.exists() = end.exists())
        app-3: Only proposed or cancelled appointments can be missing start/end dates ((start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist')))
        app-4: 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: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
        dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
        dom-6: A resource should have narrative for robust management (text.`div`.exists())
        app-2: Either start and end are specified, or neither (start.exists() = end.exists())
        app-3: Only proposed or cancelled appointments can be missing start/end dates ((start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist')))
        app-4: 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'))
        2. Appointment.implicitRules
        Definition

        A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

        ShortA set of rules under which this content was created
        Comments

        Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

        Control0..1
        Typeuri
        Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        4. Appointment.extension
        Definition

        An Extension


        May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        ShortExtensionAdditional content defined by implementations
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        SlicingThis element introduces a set of slices on Appointment.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 6. Appointment.extension:ServiceEvent
          Slice NameServiceEvent
          Definition

          Extension for service event id (palvelutapahtuman tunniste). 22 Palvelutapahtuman tunniste

          ShortExtension
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(ServiceEventExtension) (Extension Type: Identifier)
          Is Modifierfalse
          Requirements

          22 Palvelutapahtuman tunniste

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          8. Appointment.extension:TopicId
          Slice NameTopicId
          Definition

          Social care topic (asia) id. 23 Asian tunniste

          ShortExtension
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(TopicIdExtension) (Extension Type: Identifier)
          Is Modifierfalse
          Requirements

          23 Asian tunniste

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          10. Appointment.extension:QueueNo
          Slice NameQueueNo
          Definition

          An extension for queue number (in string format). 82 Jonotusnumero

          ShortExtension
          Control0..*
          This element is affected by the following invariants: ele-1
          TypeExtension(QueueNoExtension) (Extension Type: string)
          Is Modifierfalse
          Requirements

          82 Jonotusnumero

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          12. Appointment.extension:TicketNo
          Slice NameTicketNo
          Definition

          Ticket number to be included in the appointment. 101 Tiketti

          ShortExtension
          Control0..*
          This element is affected by the following invariants: ele-1
          TypeExtension(TicketNoExtension) (Extension Type: string)
          Is Modifierfalse
          Requirements

          101 Tikettinumero

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          14. Appointment.extension:VisibleToCustodian
          Slice NameVisibleToCustodian
          Definition

          59 Ajanvarauksen tietojen näyttäminen huoltajalle

          1=Ajanvarauksen tiedot saa näyttää huoltajalle,2=Ajanvarauksen tietoja ei saa näyttää huoltajalle

          ShortExtension
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(VisibleToCustodianExtension) (Extension Type: string)
          Is Modifierfalse
          Requirements

          59 Ajanvarauksen tietojen näyttäminen huoltajalle

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          16. Appointment.extension:CustomerJourney
          Slice NameCustomerJourney
          Definition

          Identifier for the customer journey (hoitopolku) 20 Asiakaspolun tunniste 20.1 Asiakaspolun nimi

          ShortExtension
          Comments

          20 Asiakaspolun tunniste 20.1 Asiakaspolun nimi

          Control0..*
          This element is affected by the following invariants: ele-1
          TypeExtension(CustomerJourneyExtension) (Complex Extension)
          Is Modifierfalse
          Requirements

          20 Asiakaspolun tunniste 20.1 Asiakaspolun nimi

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          18. Appointment.extension:ParentAppointment
          Slice NameParentAppointment
          Definition

          Master appointment reference using identifier type Pääajanvarauksen tunniste

          ShortExtension
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(ParentAppointment) (Extension Type: Identifier)
          Is Modifierfalse
          Requirements

          12 Pääajanvaraus

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          20. Appointment.extension:SelfServiceExtension
          Slice NameSelfServiceExtension
          Definition

          Extension for Finnish Scheduling appointment, that notifies whether there is a self service for managing appointment (provides URL and information whether management can be made by proxy). 84 AsiointiURL 84.1 Järjestelmä tukee alaikäisen puolesta asiointia 84.2 Järjestelmä tukee puolesta-asiointia valtakirjalla täysi-ikäisen puolesta 84.3 Järjestelmä tukee rekisteripohjaista puolesta-asiointia täysi-ikäisen puolesta

          ShortExtension
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(SelfServiceExtension) (Complex Extension)
          Is Modifierfalse
          Requirements

          84 AsiointiURL 84.1 Järjestelmä tukee alaikäisen puolesta asiointia 84.2 Järjestelmä tukee puolesta-asiointia valtakirjalla täysi-ikäisen puolesta 84.3 Järjestelmä tukee rekisteripohjaista puolesta-asiointia täysi-ikäisen puolesta

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          22. Appointment.extension:ResourceCalendar
          Slice NameResourceCalendar
          Definition

          Extension for resource calendar id and resource name. 74 Resurssin kalenteritunniste. 75 Resurssin nimi

          ShortExtension
          Control0..*
          This element is affected by the following invariants: ele-1
          TypeExtension(ResourceCalendarIdExtension) (Complex Extension)
          Is Modifierfalse
          Requirements

          74 Resurssin kalenteritunniste 75 Resurssin nimi

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          24. Appointment.extension:ReferralId
          Slice NameReferralId
          Definition

          Referral id extension for appointment (string). 24 Ajanvaraukseen liittyvän lähetteen tai pyynnön tunniste

          ShortExtension
          Control0..*
          This element is affected by the following invariants: ele-1
          TypeExtension(ReferralIdExtension) (Extension Type: string)
          Is Modifierfalse
          Requirements

          24 Ajanvaraukseen liittyvän lähetteen tai pyynnön tunniste

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          26. Appointment.extension:RequestedService
          Slice NameRequestedService
          Definition

          Extension for providing additional information for appointment service: reserved product/service. 73 Varaustuote 73.1 Varaustuotteen nimi

          ShortExtension
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(RequestedServiceExtension) (Complex Extension)
          Is Modifierfalse
          Requirements

          73 Varaustuote 73.1 Varaustuotteen nimi

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          28. Appointment.extension:MiscAppointmentData
          Slice NameMiscAppointmentData
          Definition

          Other details regarding appointment. 91 Muu sisältö

          ShortExtension
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(MiscAppointmentDataExtension) (Extension Type: string)
          Is Modifierfalse
          Requirements

          91 Muu sisältö

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          30. Appointment.extension:PractitionerGender
          Slice NamePractitionerGender
          Definition

          Extension for practitioner gender for appointment. 93 Palvelun toteuttajan sukupuoli

          ShortExtension
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(PractitionerGenderExtension) (Extension Type: Coding)
          Is Modifierfalse
          Requirements

          93 Palvelun toteuttajan sukupuoli

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          32. Appointment.extension:NotificationMedium
          Slice NameNotificationMedium
          Definition

          Information on notification medium, based on THL - Viestintäkanava codesystem 94 Muistutuksen tapa

          ShortExtension
          Control0..*
          This element is affected by the following invariants: ele-1
          TypeExtension(NotificationMediumExtension) (Extension Type: Coding)
          Is Modifierfalse
          Requirements

          94 Muistutuksen tapa

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          34. Appointment.extension:CareGuarantee
          Slice NameCareGuarantee
          Definition

          An extension for including care guarantee (hoitotakuu) details in appointment.

          ShortExtension
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(CareGuaranteeExtension) (Extension Type: string)
          Is Modifierfalse
          Requirements

          97 Hoitotakuu

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          36. Appointment.extension:AdditionalInformationURL
          Slice NameAdditionalInformationURL
          Definition

          URL for additional information regarding appointment 98 Lisätietojen osoite

          ShortExtension
          Control0..*
          This element is affected by the following invariants: ele-1
          TypeExtension(AdditionalInformationURLExtension) (Extension Type: url)
          Is Modifierfalse
          Requirements

          98 Lisätietojen osoite

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          38. Appointment.extension:CarePlan
          Slice NameCarePlan
          Definition

          Identifier for the care plan, if provided.

          ShortExtension
          Control0..*
          This element is affected by the following invariants: ele-1
          TypeExtension(CareplanIdentifierExtension) (Extension Type: Identifier)
          Is Modifierfalse
          Requirements

          17 Ajanvaraukseen liittyvän suunnitelman tunniste

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          40. Appointment.extension:AppointmentMutability
          Slice NameAppointmentMutability
          Definition

          Extension for FinnishAppointment specifying whether appointment can be changed and when.

          ShortExtension
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(AppointmentMutabilityExtension) (Complex Extension)
          Is Modifierfalse
          Requirements

          95 Peruttavissa 96 Siirrettävissä 96.1 Peruutuksen tai siirron aikaraja

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          42. Appointment.modifierExtension
          Definition

          May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

          Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

          ShortExtensions that cannot be ignored
          Comments

          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

          Control0..*
          TypeExtension
          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
          Summaryfalse
          Requirements

          Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

          Alternate Namesextensions, user content
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          44. Appointment.identifier
          Definition

          hl7fi: 18 Ajanvarauksen tunniste - mandatory, not recurring

          This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).


          This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).

          ShortExternal Ids for this item
          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control10..*
          TypeIdentifier
          Is Modifierfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          46. Appointment.identifier.use
          Definition

          The purpose of this identifier.

          Shortusual | official | temp | secondary | old (If known)
          Comments

          Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

          Control0..1
          BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
          (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

          Identifies the purpose for this identifier, if known .

          Typecode
          Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

          Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          48. Appointment.identifier.value
          Definition

          The portion of the identifier typically relevant to the user and which is unique within the context of the system.

          ShortThe value that is unique
          Comments

          If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

          Control10..1
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Example<br/><b>General</b>:123456
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          50. Appointment.status
          Definition

          The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.

          Shortsuunniteltu | tilattu | varattu | peruttu | siirretty | alkanut | toteutunut | ehdotettu | saapumattaproposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
          Comments

          hl7fi: Requires mapping to Ajanvarauksen tila code set (1.2.246.537.6.881.201501). Other mappings ok apart from "siirretty" (rescheduled) ja "suunniteltu".

          If the Appointment's status is "cancelled" then all participants are expected to have their calendars released for the appointment period, and as such any Slots that were marked as BUSY can be re-set to FREE.

          This element is labeled as a modifier because the status contains the code entered-in-error that mark the Appointment as not currently valid.


          If the Appointment's status is "cancelled" then all participants are expected to have their calendars released for the appointment period, and as such any Slots that were marked as BUSY can be re-set to FREE.

          This element is labeled as a modifier because the status contains the code entered-in-error that mark the Appointment as not currently valid.

          Control1..1
          BindingThe codes SHALL be taken from AppointmentStatushttp://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1
          (required to http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1)

          The free/busy status of an appointment.

          Typecode
          Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

          19 Ajanvarauksen tila

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          52. Appointment.cancelationReason
          Definition

          The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply.

          ShortThe coded reason for the appointment being cancelled
          Control0..1
          BindingFor example codes, see AppointmentCancellationReasonhttp://hl7.org/fhir/ValueSet/appointment-cancellation-reason
          (example to http://hl7.org/fhir/ValueSet/appointment-cancellation-reason)
          TypeCodeableConcept
          Is Modifierfalse
          Summarytrue
          Requirements

          19.1 Ajanvarauksen perumisen tai siirtämisen syy

          Mandatory, if cancellation status is equivalent to "Siirretty" or "Peruttu"

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          54. Appointment.serviceCategory
          Definition

          A broad categorization of the service that is to be performed during this appointment.

          ShortA broad categorization of the service that is to be performed during this appointment
          Control0..*
          BindingFor example codes, see ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-category
          (example to http://hl7.org/fhir/ValueSet/service-category)
          TypeCodeableConcept
          Is Modifierfalse
          Summarytrue
          Requirements

          71.1 Palvelun luokka

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          56. Appointment.serviceType
          Definition

          The specific service that is to be performed during this appointment.

          ShortThe specific service that is to be performed during this appointment
          Comments

          For a provider to provider appointment the code "FOLLOWUP" may be appropriate, as this is expected to be discussing some patient that was seen in the past.

          Control10..*
          BindingFor example codes, see ServiceTypehttp://hl7.org/fhir/ValueSet/service-type
          (example to http://hl7.org/fhir/ValueSet/service-type)
          TypeCodeableConcept
          Is Modifierfalse
          Summarytrue
          Requirements

          71 Palvelun nimi

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          58. Appointment.appointmentType
          Definition

          The style of appointment or patient that has been booked in the slot (not service type).

          ShortThe style of appointment or patient that has been booked in the slot (not service type)
          Control0..1
          BindingThe codes SHOULD be taken from hl7VS-appointmentReasonCodeshttp://terminology.hl7.org/ValueSet/v2-0276
          (preferred to http://terminology.hl7.org/ValueSet/v2-0276)
          TypeCodeableConcept
          Is Modifierfalse
          Summarytrue
          Requirements

          72 Asiointitapa

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          60. Appointment.reasonCode
          Definition

          The coded reason that this appointment is being scheduled. This is more clinical than administrative.

          ShortCoded reason this appointment is scheduled
          Control0..*
          BindingThe codes SHOULD be taken from EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason
          (preferred to http://hl7.org/fhir/ValueSet/encounter-reason)

          The Reason for the appointment to take place.

          TypeCodeableConcept
          Is Modifierfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          SlicingThis element introduces a set of slices on Appointment.reasonCode. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • exists @ coding
          • 62. Appointment.reasonCode:sliceSisaltotarkenne
            Slice NamesliceSisaltotarkenne
            Definition

            hl7fi: 85 Varauksen sisältötarkenne, koodilla ilmaistu tarkentava tieto palvelun sisällöstä Huom. Tarkenteeksi voi valita useamman kuin yhden koodin, ja koodit voivat kuvata esimerkiksi sitä, mitä kuvantamis- tai laboratoriotutkimuksia tai toimenpiteitä suoritetaan.


            The coded reason that this appointment is being scheduled. This is more clinical than administrative.

            ShortCoded reason this appointment is scheduled
            Control0..*
            BindingThe codes SHOULD be taken from EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason
            (preferred to http://hl7.org/fhir/ValueSet/encounter-reason)

            The Reason for the appointment to take place.

            TypeCodeableConcept
            Is Modifierfalse
            Summarytrue
            Requirements

            85 Varauksen sisältötarkenne

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            64. Appointment.reasonCode:sliceSisaltotarkenne.coding
            Definition

            A reference to a code defined by a terminology system.

            ShortCode defined by a terminology system
            Comments

            Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

            Control10..1*
            TypeCoding
            Is Modifierfalse
            Summarytrue
            Requirements

            Allows for alternative encodings within a code system, and translations to other code systems.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            66. Appointment.reasonCode:sliceSisaltotarkenne.coding.version
            Definition

            The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

            ShortVersion of the system - if relevant
            Comments

            Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

            NoteThis is a business version Id, not a resource version Id (see discussion)
            Control0..01
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            68. Appointment.reasonCode:sliceSisaltotarkenne.coding.userSelected
            Definition

            Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

            ShortIf this coding was chosen directly by the user
            Comments

            Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

            Control0..01
            Typeboolean
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            70. Appointment.reasonCode:sliceSisaltotarkenne.text
            Definition

            A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

            ShortPlain text representation of the concept
            Comments

            Very often the text is the same as a displayName of one of the codings.

            Control0..01
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            72. Appointment.reasonCode:slicePalvelutarve
            Slice NameslicePalvelutarve
            Definition

            hl7fi: 76 Palvelutarve vapaamuotoisena tekstinä ilmaistu tieto asiakkaan palvelutarpeesta Huom. Palvelutarve kuvataan tasolla, jolla henkilön palveluiden tarve voidaan kuvata yhteisellä termillä, esim. raskausajan seuranta ja tuki.


            The coded reason that this appointment is being scheduled. This is more clinical than administrative.

            ShortCoded reason this appointment is scheduled
            Control0..1*
            BindingThe codes SHOULD be taken from EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason
            (preferred to http://hl7.org/fhir/ValueSet/encounter-reason)

            The Reason for the appointment to take place.

            TypeCodeableConcept
            Is Modifierfalse
            Summarytrue
            Requirements

            76 Palvelutarve

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            74. Appointment.reasonCode:slicePalvelutarve.coding
            Definition

            A reference to a code defined by a terminology system.

            ShortCode defined by a terminology system
            Comments

            Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

            Control0..0*
            TypeCoding
            Is Modifierfalse
            Summarytrue
            Requirements

            Allows for alternative encodings within a code system, and translations to other code systems.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            76. Appointment.reasonCode:slicePalvelutarve.text
            Definition

            A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

            ShortPlain text representation of the concept
            Comments

            Very often the text is the same as a displayName of one of the codings.

            Control10..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            78. Appointment.reasonReference
            Definition

            Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.

            ShortReason the appointment is to take place (resource)
            Control0..*
            TypeReference(Condition, Procedure, Observation, ImmunizationRecommendation)contained
            Is Modifierfalse
            Summaryfalse
            Requirements

            56 kuvaus oireista/vaivasta ja 57 riskitiedot (Condition/Note)

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            80. Appointment.reasonReference.type
            Definition

            The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

            The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

            ShortType the reference refers to (e.g. "Patient")
            Comments

            This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

            Control0..1
            BindingUnless not suitable, these codes SHALL be taken from ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types
            (extensible to http://hl7.org/fhir/ValueSet/resource-types)

            Aa resource (or, for logical models, the URI of the logical model).

            Typeuri
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Fixed ValueCondition
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            82. Appointment.start
            Definition

            Date/Time that the appointment is to take place.

            ShortWhen appointment is to take place
            Control0..1
            Typeinstant
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            86 Aikaväli

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            84. Appointment.end
            Definition

            Date/Time that the appointment is to conclude.

            ShortWhen appointment is to conclude
            Control0..1
            Typeinstant
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            86 Aikaväli

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            86. Appointment.created
            Definition

            The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.

            ShortThe date that this appointment was initially created
            Comments

            This property is required for many use cases where the age of an appointment is considered in processing workflows for scheduling and billing of appointments.

            Control0..1
            TypedateTime
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Requirements

            38 Merkinnän kirjausaika

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            88. Appointment.comment
            Definition

            hl7fi: asiakkaalle tai ajanvarauksen katselijalle tarkoitettu vapaamuotoinen lisätieto


            Additional comments about the appointment.

            Shorthl7fi: asiakkaalle tai ajanvarauksen katselijalle tarkoitettu vapaamuotoinen lisätietoAdditional comments
            Comments

            Additional text to aid in facilitating the appointment. For instance, a comment might be, "patient should proceed immediately to infusion room upon arrival"

            Where this is a planned appointment and the start/end dates are not set then this field can be used to provide additional guidance on the details of the appointment request, including any restrictions on when to book it.

            Control0..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Requirements

            99 Huomautukset

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            90. Appointment.patientInstruction
            Definition

            hl7fi: vapaamuotoisena tekstinä ilmaistu potilasohje, joka tarjoaa asiakkaalle tietoa esimerkiksi sairaudesta, tutkimuksista, hoidoista, toimenpiteisiin valmistautumisesta, jälkihoidosta, itsehoidosta, toipumisesta, sairauden kulusta ja sairauden ennusteesta Huom. Potilasohje voi olla esim. Käypä hoito -suositus tai yleinen sairaalan antama ohje, joka voi olla myös yksikkökohtainen.


            While Appointment.comment contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before).

            Shorthl7fi: vapaamuotoisena tekstinä ilmaistu potilasohjeDetailed information and instructions for the patient
            Control0..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Requirements

            100 Potilasohje

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            92. Appointment.patientInstruction.extension
            Definition

            An Extension


            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

            ShortExtensionAdditional content defined by implementations
            Comments

            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

            Control0..*
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Alternate Namesextensions, user content
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            SlicingThis element introduces a set of slices on Appointment.patientInstruction.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 94. Appointment.participant
              Definition

              List of participants involved in the appointment.

              ShortParticipants involved in appointment
              Control1..*
              TypeBackboneElement
              Is Modifierfalse
              Summaryfalse
              Invariantsapp-1: Either the type or actor on the participant SHALL be specified (type.exists() or actor.exists())
              ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              app-1: Either the type or actor on the participant SHALL be specified (type.exists() or actor.exists())
              96. Appointment.participant.modifierExtension
              Definition

              May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

              Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

              ShortExtensions that cannot be ignored even if unrecognized
              Comments

              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

              Control0..*
              TypeExtension
              Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
              Summarytrue
              Requirements

              Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

              Alternate Namesextensions, user content, modifiers
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              98. Appointment.participant.status
              Definition

              Participation status of the actor.

              Shortaccepted | declined | tentative | needs-action
              Control1..1
              BindingThe codes SHALL be taken from ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1
              (required to http://hl7.org/fhir/ValueSet/participationstatus|4.0.1)

              The Participation status of an appointment.

              Typecode
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              100. Appointment.requestedPeriod
              Definition

              A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within.

              The duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system.

              ShortPotential date/time interval(s) requested to allocate the appointment within
              Comments

              This does not introduce a capacity for recurring appointments.

              Control0..*
              TypePeriod
              Is Modifierfalse
              Summaryfalse
              Requirements

              35 Ajankohta, jolloin ajanvaraus ohjeistettu tehtäväksi

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

              Guidance on how to interpret the contents of this table can be found here

              0. Appointment
              Definition

              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).

              ShortA 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)
              Control0..*
              Is Modifierfalse
              Summaryfalse
              Invariantsapp-2: Either start and end are specified, or neither (start.exists() = end.exists())
              app-3: Only proposed or cancelled appointments can be missing start/end dates ((start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist')))
              app-4: 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: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
              dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
              dom-6: A resource should have narrative for robust management (text.`div`.exists())
              2. Appointment.id
              Definition

              The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

              ShortLogical id of this artifact
              Comments

              The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

              Control0..1
              Typeid
              Is Modifierfalse
              Summarytrue
              4. Appointment.meta
              Definition

              The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

              ShortMetadata about the resource
              Control0..1
              TypeMeta
              Is Modifierfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              6. Appointment.implicitRules
              Definition

              A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

              ShortA set of rules under which this content was created
              Comments

              Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

              Control0..1
              Typeuri
              Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              8. Appointment.language
              Definition

              The base language in which the resource is written.

              ShortLanguage of the resource content
              Comments

              Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

              Control0..1
              BindingThe codes SHOULD be taken from CommonLanguages
              (preferred to http://hl7.org/fhir/ValueSet/languages)

              A human language.

              Additional BindingsPurpose
              AllLanguagesMax Binding
              Typecode
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              10. Appointment.text
              Definition

              A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

              ShortText summary of the resource, for human interpretation
              Comments

              Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

              Control0..1
              TypeNarrative
              Is Modifierfalse
              Summaryfalse
              Alternate Namesnarrative, html, xhtml, display
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              12. Appointment.contained
              Definition

              These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

              ShortContained, inline Resources
              Comments

              This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

              Control0..*
              TypeResource
              Is Modifierfalse
              Summaryfalse
              Alternate Namesinline resources, anonymous resources, contained resources
              14. Appointment.extension
              Definition

              An Extension

              ShortExtension
              Control0..*
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              SlicingThis element introduces a set of slices on Appointment.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 16. Appointment.extension:ServiceEvent
                Slice NameServiceEvent
                Definition

                Extension for service event id (palvelutapahtuman tunniste). 22 Palvelutapahtuman tunniste

                ShortExtension
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(ServiceEventExtension) (Extension Type: Identifier)
                Is Modifierfalse
                Requirements

                22 Palvelutapahtuman tunniste

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                18. Appointment.extension:TopicId
                Slice NameTopicId
                Definition

                Social care topic (asia) id. 23 Asian tunniste

                ShortExtension
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(TopicIdExtension) (Extension Type: Identifier)
                Is Modifierfalse
                Requirements

                23 Asian tunniste

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                20. Appointment.extension:QueueNo
                Slice NameQueueNo
                Definition

                An extension for queue number (in string format). 82 Jonotusnumero

                ShortExtension
                Control0..*
                This element is affected by the following invariants: ele-1
                TypeExtension(QueueNoExtension) (Extension Type: string)
                Is Modifierfalse
                Requirements

                82 Jonotusnumero

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                22. Appointment.extension:TicketNo
                Slice NameTicketNo
                Definition

                Ticket number to be included in the appointment. 101 Tiketti

                ShortExtension
                Control0..*
                This element is affected by the following invariants: ele-1
                TypeExtension(TicketNoExtension) (Extension Type: string)
                Is Modifierfalse
                Requirements

                101 Tikettinumero

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                24. Appointment.extension:VisibleToCustodian
                Slice NameVisibleToCustodian
                Definition

                59 Ajanvarauksen tietojen näyttäminen huoltajalle

                1=Ajanvarauksen tiedot saa näyttää huoltajalle,2=Ajanvarauksen tietoja ei saa näyttää huoltajalle

                ShortExtension
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(VisibleToCustodianExtension) (Extension Type: string)
                Is Modifierfalse
                Requirements

                59 Ajanvarauksen tietojen näyttäminen huoltajalle

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                26. Appointment.extension:CustomerJourney
                Slice NameCustomerJourney
                Definition

                Identifier for the customer journey (hoitopolku) 20 Asiakaspolun tunniste 20.1 Asiakaspolun nimi

                ShortExtension
                Comments

                20 Asiakaspolun tunniste 20.1 Asiakaspolun nimi

                Control0..*
                This element is affected by the following invariants: ele-1
                TypeExtension(CustomerJourneyExtension) (Complex Extension)
                Is Modifierfalse
                Requirements

                20 Asiakaspolun tunniste 20.1 Asiakaspolun nimi

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                28. Appointment.extension:ParentAppointment
                Slice NameParentAppointment
                Definition

                Master appointment reference using identifier type Pääajanvarauksen tunniste

                ShortExtension
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(ParentAppointment) (Extension Type: Identifier)
                Is Modifierfalse
                Requirements

                12 Pääajanvaraus

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                30. Appointment.extension:SelfServiceExtension
                Slice NameSelfServiceExtension
                Definition

                Extension for Finnish Scheduling appointment, that notifies whether there is a self service for managing appointment (provides URL and information whether management can be made by proxy). 84 AsiointiURL 84.1 Järjestelmä tukee alaikäisen puolesta asiointia 84.2 Järjestelmä tukee puolesta-asiointia valtakirjalla täysi-ikäisen puolesta 84.3 Järjestelmä tukee rekisteripohjaista puolesta-asiointia täysi-ikäisen puolesta

                ShortExtension
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(SelfServiceExtension) (Complex Extension)
                Is Modifierfalse
                Requirements

                84 AsiointiURL 84.1 Järjestelmä tukee alaikäisen puolesta asiointia 84.2 Järjestelmä tukee puolesta-asiointia valtakirjalla täysi-ikäisen puolesta 84.3 Järjestelmä tukee rekisteripohjaista puolesta-asiointia täysi-ikäisen puolesta

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                32. Appointment.extension:ResourceCalendar
                Slice NameResourceCalendar
                Definition

                Extension for resource calendar id and resource name. 74 Resurssin kalenteritunniste. 75 Resurssin nimi

                ShortExtension
                Control0..*
                This element is affected by the following invariants: ele-1
                TypeExtension(ResourceCalendarIdExtension) (Complex Extension)
                Is Modifierfalse
                Requirements

                74 Resurssin kalenteritunniste 75 Resurssin nimi

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                34. Appointment.extension:ReferralId
                Slice NameReferralId
                Definition

                Referral id extension for appointment (string). 24 Ajanvaraukseen liittyvän lähetteen tai pyynnön tunniste

                ShortExtension
                Control0..*
                This element is affected by the following invariants: ele-1
                TypeExtension(ReferralIdExtension) (Extension Type: string)
                Is Modifierfalse
                Requirements

                24 Ajanvaraukseen liittyvän lähetteen tai pyynnön tunniste

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                36. Appointment.extension:RequestedService
                Slice NameRequestedService
                Definition

                Extension for providing additional information for appointment service: reserved product/service. 73 Varaustuote 73.1 Varaustuotteen nimi

                ShortExtension
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(RequestedServiceExtension) (Complex Extension)
                Is Modifierfalse
                Requirements

                73 Varaustuote 73.1 Varaustuotteen nimi

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                38. Appointment.extension:MiscAppointmentData
                Slice NameMiscAppointmentData
                Definition

                Other details regarding appointment. 91 Muu sisältö

                ShortExtension
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(MiscAppointmentDataExtension) (Extension Type: string)
                Is Modifierfalse
                Requirements

                91 Muu sisältö

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                40. Appointment.extension:PractitionerGender
                Slice NamePractitionerGender
                Definition

                Extension for practitioner gender for appointment. 93 Palvelun toteuttajan sukupuoli

                ShortExtension
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(PractitionerGenderExtension) (Extension Type: Coding)
                Is Modifierfalse
                Requirements

                93 Palvelun toteuttajan sukupuoli

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                42. Appointment.extension:NotificationMedium
                Slice NameNotificationMedium
                Definition

                Information on notification medium, based on THL - Viestintäkanava codesystem 94 Muistutuksen tapa

                ShortExtension
                Control0..*
                This element is affected by the following invariants: ele-1
                TypeExtension(NotificationMediumExtension) (Extension Type: Coding)
                Is Modifierfalse
                Requirements

                94 Muistutuksen tapa

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                44. Appointment.extension:CareGuarantee
                Slice NameCareGuarantee
                Definition

                An extension for including care guarantee (hoitotakuu) details in appointment.

                ShortExtension
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(CareGuaranteeExtension) (Extension Type: string)
                Is Modifierfalse
                Requirements

                97 Hoitotakuu

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                46. Appointment.extension:AdditionalInformationURL
                Slice NameAdditionalInformationURL
                Definition

                URL for additional information regarding appointment 98 Lisätietojen osoite

                ShortExtension
                Control0..*
                This element is affected by the following invariants: ele-1
                TypeExtension(AdditionalInformationURLExtension) (Extension Type: url)
                Is Modifierfalse
                Requirements

                98 Lisätietojen osoite

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                48. Appointment.extension:CarePlan
                Slice NameCarePlan
                Definition

                Identifier for the care plan, if provided.

                ShortExtension
                Control0..*
                This element is affected by the following invariants: ele-1
                TypeExtension(CareplanIdentifierExtension) (Extension Type: Identifier)
                Is Modifierfalse
                Requirements

                17 Ajanvaraukseen liittyvän suunnitelman tunniste

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                50. Appointment.extension:AppointmentMutability
                Slice NameAppointmentMutability
                Definition

                Extension for FinnishAppointment specifying whether appointment can be changed and when.

                ShortExtension
                Control0..1
                This element is affected by the following invariants: ele-1
                TypeExtension(AppointmentMutabilityExtension) (Complex Extension)
                Is Modifierfalse
                Requirements

                95 Peruttavissa 96 Siirrettävissä 96.1 Peruutuksen tai siirron aikaraja

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                52. Appointment.modifierExtension
                Definition

                May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                ShortExtensions that cannot be ignored
                Comments

                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                Control0..*
                TypeExtension
                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                Summaryfalse
                Requirements

                Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                Alternate Namesextensions, user content
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                54. Appointment.identifier
                Definition

                hl7fi: 18 Ajanvarauksen tunniste - mandatory, not recurring

                This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).

                ShortExternal Ids for this item
                NoteThis is a business identifier, not a resource identifier (see discussion)
                Control1..*
                TypeIdentifier
                Is Modifierfalse
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                56. Appointment.identifier.id
                Definition

                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                ShortUnique id for inter-element referencing
                Control0..1
                Typestring
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                58. Appointment.identifier.extension
                Definition

                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                ShortAdditional content defined by implementations
                Comments

                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                Control0..*
                TypeExtension
                Is Modifierfalse
                Summaryfalse
                Alternate Namesextensions, user content
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                SlicingThis element introduces a set of slices on Appointment.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 60. Appointment.identifier.use
                  Definition

                  The purpose of this identifier.

                  Shortusual | official | temp | secondary | old (If known)
                  Comments

                  Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                  Control0..1
                  BindingThe codes SHALL be taken from IdentifierUse
                  (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                  Identifies the purpose for this identifier, if known .

                  Typecode
                  Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

                  Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  62. Appointment.identifier.type
                  Definition

                  A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                  ShortDescription of identifier
                  Comments

                  This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                  Control0..1
                  BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                  (extensible to http://hl7.org/fhir/ValueSet/identifier-type)

                  A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

                  TypeCodeableConcept
                  Is Modifierfalse
                  Summarytrue
                  Requirements

                  Allows users to make use of identifiers when the identifier system is not known.

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  64. Appointment.identifier.system
                  Definition

                  Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                  ShortThe namespace for the identifier value
                  Comments

                  Identifier.system is always case sensitive.

                  Control0..1
                  Typeuri
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

                  There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                  Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  66. Appointment.identifier.value
                  Definition

                  The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                  ShortThe value that is unique
                  Comments

                  If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                  Control1..1
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Example<br/><b>General</b>:123456
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  68. Appointment.identifier.period
                  Definition

                  Time period during which identifier is/was valid for use.

                  ShortTime period when id is/was valid for use
                  Control0..1
                  TypePeriod
                  Is Modifierfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  70. Appointment.identifier.assigner
                  Definition

                  Organization that issued/manages the identifier.

                  ShortOrganization that issued id (may be just text)
                  Comments

                  The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                  Control0..1
                  TypeReference(Organization)
                  Is Modifierfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  72. Appointment.status
                  Definition

                  The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.

                  Shortsuunniteltu | tilattu | varattu | peruttu | siirretty | alkanut | toteutunut | ehdotettu | saapumatta
                  Comments

                  hl7fi: Requires mapping to Ajanvarauksen tila code set (1.2.246.537.6.881.201501). Other mappings ok apart from "siirretty" (rescheduled) ja "suunniteltu".

                  If the Appointment's status is "cancelled" then all participants are expected to have their calendars released for the appointment period, and as such any Slots that were marked as BUSY can be re-set to FREE.

                  This element is labeled as a modifier because the status contains the code entered-in-error that mark the Appointment as not currently valid.

                  Control1..1
                  BindingThe codes SHALL be taken from AppointmentStatus
                  (required to http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1)

                  The free/busy status of an appointment.

                  Typecode
                  Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

                  19 Ajanvarauksen tila

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  74. Appointment.cancelationReason
                  Definition

                  The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply.

                  ShortThe coded reason for the appointment being cancelled
                  Control0..1
                  BindingFor example codes, see AppointmentCancellationReason
                  (example to http://hl7.org/fhir/ValueSet/appointment-cancellation-reason)
                  TypeCodeableConcept
                  Is Modifierfalse
                  Summarytrue
                  Requirements

                  19.1 Ajanvarauksen perumisen tai siirtämisen syy

                  Mandatory, if cancellation status is equivalent to "Siirretty" or "Peruttu"

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  76. Appointment.cancelationReason.id
                  Definition

                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                  ShortUnique id for inter-element referencing
                  Control0..1
                  Typestring
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  78. Appointment.cancelationReason.extension
                  Definition

                  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                  ShortAdditional content defined by implementations
                  Comments

                  There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                  Control0..*
                  TypeExtension
                  Is Modifierfalse
                  Summaryfalse
                  Alternate Namesextensions, user content
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  SlicingThis element introduces a set of slices on Appointment.cancelationReason.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 80. Appointment.cancelationReason.coding
                    Definition

                    A reference to a code defined by a terminology system.

                    ShortCode defined by a terminology system
                    Comments

                    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                    Control0..*
                    TypeCoding
                    Is Modifierfalse
                    Summarytrue
                    Requirements

                    Allows for alternative encodings within a code system, and translations to other code systems.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    82. Appointment.cancelationReason.coding.id
                    Definition

                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                    ShortUnique id for inter-element referencing
                    Control0..1
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    84. Appointment.cancelationReason.coding.extension
                    Definition

                    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                    ShortAdditional content defined by implementations
                    Comments

                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                    Control0..*
                    TypeExtension
                    Is Modifierfalse
                    Summaryfalse
                    Alternate Namesextensions, user content
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    SlicingThis element introduces a set of slices on Appointment.cancelationReason.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 86. Appointment.cancelationReason.coding.system
                      Definition

                      The identification of the code system that defines the meaning of the symbol in the code.

                      ShortTHL - Palvelutapahtuman peruuntumisen tai siirtymisen syy
                      Comments

                      The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                      Control0..1
                      Typeuri
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      Need to be unambiguous about the source of the definition of the symbol.

                      Fixed Valueurn:oid:1.2.246.537.6.126.2008
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      88. Appointment.cancelationReason.coding.version
                      Definition

                      The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                      ShortVersion of the system - if relevant
                      Comments

                      Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                      NoteThis is a business version Id, not a resource version Id (see discussion)
                      Control0..1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      90. Appointment.cancelationReason.coding.code
                      Definition

                      A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                      ShortSymbol in syntax defined by the system
                      Control0..1
                      Typecode
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      Need to refer to a particular code in the system.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      92. Appointment.cancelationReason.coding.display
                      Definition

                      A representation of the meaning of the code in the system, following the rules of the system.

                      ShortRepresentation defined by the system
                      Control0..1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      94. Appointment.cancelationReason.coding.userSelected
                      Definition

                      Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                      ShortIf this coding was chosen directly by the user
                      Comments

                      Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                      Control0..1
                      Typeboolean
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      96. Appointment.cancelationReason.text
                      Definition

                      A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                      ShortPlain text representation of the concept
                      Comments

                      Very often the text is the same as a displayName of one of the codings.

                      Control0..1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      98. Appointment.serviceCategory
                      Definition

                      A broad categorization of the service that is to be performed during this appointment.

                      ShortA broad categorization of the service that is to be performed during this appointment
                      Control0..*
                      BindingFor example codes, see ServiceCategory
                      (example to http://hl7.org/fhir/ValueSet/service-category)
                      TypeCodeableConcept
                      Is Modifierfalse
                      Summarytrue
                      Requirements

                      71.1 Palvelun luokka

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      100. Appointment.serviceCategory.id
                      Definition

                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                      ShortUnique id for inter-element referencing
                      Control0..1
                      Typestring
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      102. Appointment.serviceCategory.extension
                      Definition

                      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                      ShortAdditional content defined by implementations
                      Comments

                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                      Control0..*
                      TypeExtension
                      Is Modifierfalse
                      Summaryfalse
                      Alternate Namesextensions, user content
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      SlicingThis element introduces a set of slices on Appointment.serviceCategory.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 104. Appointment.serviceCategory.coding
                        Definition

                        A reference to a code defined by a terminology system.

                        ShortCode defined by a terminology system
                        Comments

                        Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                        Control0..*
                        TypeCoding
                        Is Modifierfalse
                        Summarytrue
                        Requirements

                        Allows for alternative encodings within a code system, and translations to other code systems.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        106. Appointment.serviceCategory.coding.id
                        Definition

                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                        ShortUnique id for inter-element referencing
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        108. Appointment.serviceCategory.coding.extension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                        ShortAdditional content defined by implementations
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                        Control0..*
                        TypeExtension
                        Is Modifierfalse
                        Summaryfalse
                        Alternate Namesextensions, user content
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        SlicingThis element introduces a set of slices on Appointment.serviceCategory.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 110. Appointment.serviceCategory.coding.system
                          Definition

                          hl7fi: koodilla ilmaistu tieto palveluluokasta, johon ajanvaraus kohdistuu Huom. Palveluluokka ilmaistaan THL - Sosiaali- ja terveyspalvelujen luokituksen avulla.

                          ShortAR/YDIN - Palvelutapahtumaluokitus
                          Comments

                          The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                          Control0..1
                          Typeuri
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Requirements

                          Need to be unambiguous about the source of the definition of the symbol.

                          Fixed Valueurn:oid:1.2.246.537.6.88.2008
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          112. Appointment.serviceCategory.coding.version
                          Definition

                          The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                          ShortVersion of the system - if relevant
                          Comments

                          Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                          NoteThis is a business version Id, not a resource version Id (see discussion)
                          Control0..1
                          Typestring
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          114. Appointment.serviceCategory.coding.code
                          Definition

                          A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                          ShortSymbol in syntax defined by the system
                          Control0..1
                          Typecode
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Requirements

                          Need to refer to a particular code in the system.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          116. Appointment.serviceCategory.coding.display
                          Definition

                          A representation of the meaning of the code in the system, following the rules of the system.

                          ShortRepresentation defined by the system
                          Control0..1
                          Typestring
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Requirements

                          Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          118. Appointment.serviceCategory.coding.userSelected
                          Definition

                          Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                          ShortIf this coding was chosen directly by the user
                          Comments

                          Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                          Control0..1
                          Typeboolean
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Requirements

                          This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          120. Appointment.serviceCategory.text
                          Definition

                          A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                          ShortPlain text representation of the concept
                          Comments

                          Very often the text is the same as a displayName of one of the codings.

                          Control0..1
                          Typestring
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Requirements

                          The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          122. Appointment.serviceType
                          Definition

                          The specific service that is to be performed during this appointment.

                          ShortThe specific service that is to be performed during this appointment
                          Comments

                          For a provider to provider appointment the code "FOLLOWUP" may be appropriate, as this is expected to be discussing some patient that was seen in the past.

                          Control1..*
                          BindingFor example codes, see ServiceType
                          (example to http://hl7.org/fhir/ValueSet/service-type)
                          TypeCodeableConcept
                          Is Modifierfalse
                          Summarytrue
                          Requirements

                          71 Palvelun nimi

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          124. Appointment.serviceType.id
                          Definition

                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                          ShortUnique id for inter-element referencing
                          Control0..1
                          Typestring
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          126. Appointment.serviceType.extension
                          Definition

                          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                          ShortAdditional content defined by implementations
                          Comments

                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                          Control0..*
                          TypeExtension
                          Is Modifierfalse
                          Summaryfalse
                          Alternate Namesextensions, user content
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          SlicingThis element introduces a set of slices on Appointment.serviceType.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 128. Appointment.serviceType.coding
                            Definition

                            A reference to a code defined by a terminology system.

                            ShortCode defined by a terminology system
                            Comments

                            Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                            Control0..*
                            TypeCoding
                            Is Modifierfalse
                            Summarytrue
                            Requirements

                            Allows for alternative encodings within a code system, and translations to other code systems.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            130. Appointment.serviceType.coding.id
                            Definition

                            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                            ShortUnique id for inter-element referencing
                            Control0..1
                            Typestring
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            132. Appointment.serviceType.coding.extension
                            Definition

                            May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                            ShortAdditional content defined by implementations
                            Comments

                            There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                            Control0..*
                            TypeExtension
                            Is Modifierfalse
                            Summaryfalse
                            Alternate Namesextensions, user content
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            SlicingThis element introduces a set of slices on Appointment.serviceType.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 134. Appointment.serviceType.coding.system
                              Definition

                              The identification of the code system that defines the meaning of the symbol in the code.

                              ShortTHL - Sosiaali- ja terveysalan palvelunimikkeistö
                              Comments

                              hl7fi: koodilla ilmaistu tieto palvelusta, johon ajanvaraus kohdistuu Huom. Palvelun nimi ilmaistaan THL - Sosiaali- ja terveysalan palvelunimikkeistön avulla.

                              The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                              Control0..1
                              Typeuri
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Requirements

                              71 Palvelun nimi

                              Fixed Valueurn:oid:1.2.246.537.6.49.201501
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              136. Appointment.serviceType.coding.version
                              Definition

                              The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                              ShortVersion of the system - if relevant
                              Comments

                              Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                              NoteThis is a business version Id, not a resource version Id (see discussion)
                              Control0..1
                              Typestring
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              138. Appointment.serviceType.coding.code
                              Definition

                              A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                              ShortSymbol in syntax defined by the system
                              Control0..1
                              Typecode
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Requirements

                              Need to refer to a particular code in the system.

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              140. Appointment.serviceType.coding.display
                              Definition

                              A representation of the meaning of the code in the system, following the rules of the system.

                              ShortRepresentation defined by the system
                              Control0..1
                              Typestring
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Requirements

                              Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              142. Appointment.serviceType.coding.userSelected
                              Definition

                              Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                              ShortIf this coding was chosen directly by the user
                              Comments

                              Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                              Control0..1
                              Typeboolean
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Requirements

                              This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              144. Appointment.serviceType.text
                              Definition

                              A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                              ShortPlain text representation of the concept
                              Comments

                              Very often the text is the same as a displayName of one of the codings.

                              Control0..1
                              Typestring
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Requirements

                              The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              146. Appointment.specialty
                              Definition

                              The specialty of a practitioner that would be required to perform the service requested in this appointment.

                              ShortThe specialty of a practitioner that would be required to perform the service requested in this appointment
                              Control0..*
                              BindingThe codes SHOULD be taken from PracticeSettingCodeValueSet
                              (preferred to http://hl7.org/fhir/ValueSet/c80-practice-codes)
                              TypeCodeableConcept
                              Is Modifierfalse
                              Summarytrue
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              148. Appointment.appointmentType
                              Definition

                              The style of appointment or patient that has been booked in the slot (not service type).

                              ShortThe style of appointment or patient that has been booked in the slot (not service type)
                              Control0..1
                              BindingThe codes SHOULD be taken from hl7VS-appointmentReasonCodes
                              (preferred to http://terminology.hl7.org/ValueSet/v2-0276)
                              TypeCodeableConcept
                              Is Modifierfalse
                              Summarytrue
                              Requirements

                              72 Asiointitapa

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              150. Appointment.appointmentType.id
                              Definition

                              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                              ShortUnique id for inter-element referencing
                              Control0..1
                              Typestring
                              Is Modifierfalse
                              XML FormatIn the XML format, this property is represented as an attribute.
                              Summaryfalse
                              152. Appointment.appointmentType.extension
                              Definition

                              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                              ShortAdditional content defined by implementations
                              Comments

                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                              Control0..*
                              TypeExtension
                              Is Modifierfalse
                              Summaryfalse
                              Alternate Namesextensions, user content
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                              SlicingThis element introduces a set of slices on Appointment.appointmentType.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 154. Appointment.appointmentType.coding
                                Definition

                                A reference to a code defined by a terminology system.

                                ShortCode defined by a terminology system
                                Comments

                                Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                Control0..*
                                TypeCoding
                                Is Modifierfalse
                                Summarytrue
                                Requirements

                                Allows for alternative encodings within a code system, and translations to other code systems.

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                156. Appointment.appointmentType.coding.id
                                Definition

                                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                ShortUnique id for inter-element referencing
                                Control0..1
                                Typestring
                                Is Modifierfalse
                                XML FormatIn the XML format, this property is represented as an attribute.
                                Summaryfalse
                                158. Appointment.appointmentType.coding.extension
                                Definition

                                May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                ShortAdditional content defined by implementations
                                Comments

                                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                Control0..*
                                TypeExtension
                                Is Modifierfalse
                                Summaryfalse
                                Alternate Namesextensions, user content
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                SlicingThis element introduces a set of slices on Appointment.appointmentType.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • value @ url
                                • 160. Appointment.appointmentType.coding.system
                                  Definition

                                  hl7fi: koodilla ilmaistu tieto ammattihenkilön ja asiakkaan välisen asioinnin tavasta

                                  Shorthl7fi: asiointitapa
                                  Comments

                                  The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                  Control0..1
                                  Typeuri
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Requirements

                                  Need to be unambiguous about the source of the definition of the symbol.

                                  Fixed Value1.2.246.537.6.884.2015
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  162. Appointment.appointmentType.coding.version
                                  Definition

                                  The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                  ShortVersion of the system - if relevant
                                  Comments

                                  Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                  NoteThis is a business version Id, not a resource version Id (see discussion)
                                  Control0..1
                                  Typestring
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  164. Appointment.appointmentType.coding.code
                                  Definition

                                  A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                  ShortSymbol in syntax defined by the system
                                  Control0..1
                                  Typecode
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Requirements

                                  Need to refer to a particular code in the system.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  166. Appointment.appointmentType.coding.display
                                  Definition

                                  A representation of the meaning of the code in the system, following the rules of the system.

                                  ShortRepresentation defined by the system
                                  Control0..1
                                  Typestring
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Requirements

                                  Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  168. Appointment.appointmentType.coding.userSelected
                                  Definition

                                  Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                  ShortIf this coding was chosen directly by the user
                                  Comments

                                  Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                  Control0..1
                                  Typeboolean
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Requirements

                                  This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  170. Appointment.appointmentType.text
                                  Definition

                                  A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                  ShortPlain text representation of the concept
                                  Comments

                                  Very often the text is the same as a displayName of one of the codings.

                                  Control0..1
                                  Typestring
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Requirements

                                  The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  172. Appointment.reasonCode
                                  Definition

                                  The coded reason that this appointment is being scheduled. This is more clinical than administrative.

                                  ShortCoded reason this appointment is scheduled
                                  Control0..*
                                  BindingThe codes SHOULD be taken from EncounterReasonCodes
                                  (preferred to http://hl7.org/fhir/ValueSet/encounter-reason)

                                  The Reason for the appointment to take place.

                                  TypeCodeableConcept
                                  Is Modifierfalse
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  SlicingThis element introduces a set of slices on Appointment.reasonCode. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                  • exists @ coding
                                  • 174. Appointment.reasonCode:sliceSisaltotarkenne
                                    Slice NamesliceSisaltotarkenne
                                    Definition

                                    hl7fi: 85 Varauksen sisältötarkenne, koodilla ilmaistu tarkentava tieto palvelun sisällöstä Huom. Tarkenteeksi voi valita useamman kuin yhden koodin, ja koodit voivat kuvata esimerkiksi sitä, mitä kuvantamis- tai laboratoriotutkimuksia tai toimenpiteitä suoritetaan.

                                    ShortCoded reason this appointment is scheduled
                                    Control0..*
                                    BindingThe codes SHOULD be taken from EncounterReasonCodes
                                    (preferred to http://hl7.org/fhir/ValueSet/encounter-reason)

                                    The Reason for the appointment to take place.

                                    TypeCodeableConcept
                                    Is Modifierfalse
                                    Summarytrue
                                    Requirements

                                    85 Varauksen sisältötarkenne

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    176. Appointment.reasonCode:sliceSisaltotarkenne.id
                                    Definition

                                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                    ShortUnique id for inter-element referencing
                                    Control0..1
                                    Typestring
                                    Is Modifierfalse
                                    XML FormatIn the XML format, this property is represented as an attribute.
                                    Summaryfalse
                                    178. Appointment.reasonCode:sliceSisaltotarkenne.extension
                                    Definition

                                    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                    ShortAdditional content defined by implementations
                                    Comments

                                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                    Control0..*
                                    TypeExtension
                                    Is Modifierfalse
                                    Summaryfalse
                                    Alternate Namesextensions, user content
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                    SlicingThis element introduces a set of slices on Appointment.reasonCode.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                    • value @ url
                                    • 180. Appointment.reasonCode:sliceSisaltotarkenne.coding
                                      Definition

                                      A reference to a code defined by a terminology system.

                                      ShortCode defined by a terminology system
                                      Comments

                                      Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                      Control1..1
                                      TypeCoding
                                      Is Modifierfalse
                                      Summarytrue
                                      Requirements

                                      Allows for alternative encodings within a code system, and translations to other code systems.

                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      182. Appointment.reasonCode:sliceSisaltotarkenne.coding.id
                                      Definition

                                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                      ShortUnique id for inter-element referencing
                                      Control0..1
                                      Typestring
                                      Is Modifierfalse
                                      XML FormatIn the XML format, this property is represented as an attribute.
                                      Summaryfalse
                                      184. Appointment.reasonCode:sliceSisaltotarkenne.coding.extension
                                      Definition

                                      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                      ShortAdditional content defined by implementations
                                      Comments

                                      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                      Control0..*
                                      TypeExtension
                                      Is Modifierfalse
                                      Summaryfalse
                                      Alternate Namesextensions, user content
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                      SlicingThis element introduces a set of slices on Appointment.reasonCode.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                      • value @ url
                                      • 186. Appointment.reasonCode:sliceSisaltotarkenne.coding.system
                                        Definition

                                        The identification of the code system that defines the meaning of the symbol in the code.

                                        ShortIdentity of the terminology system
                                        Comments

                                        The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

                                        Control0..1
                                        Typeuri
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summarytrue
                                        Requirements

                                        Need to be unambiguous about the source of the definition of the symbol.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        188. Appointment.reasonCode:sliceSisaltotarkenne.coding.version
                                        Definition

                                        The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                        ShortVersion of the system - if relevant
                                        Comments

                                        Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                        NoteThis is a business version Id, not a resource version Id (see discussion)
                                        Control0..0
                                        Typestring
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summarytrue
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        190. Appointment.reasonCode:sliceSisaltotarkenne.coding.code
                                        Definition

                                        A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                        ShortSymbol in syntax defined by the system
                                        Control0..1
                                        Typecode
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summarytrue
                                        Requirements

                                        Need to refer to a particular code in the system.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        192. Appointment.reasonCode:sliceSisaltotarkenne.coding.display
                                        Definition

                                        A representation of the meaning of the code in the system, following the rules of the system.

                                        ShortRepresentation defined by the system
                                        Control0..1
                                        Typestring
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summarytrue
                                        Requirements

                                        Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        194. Appointment.reasonCode:sliceSisaltotarkenne.coding.userSelected
                                        Definition

                                        Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

                                        ShortIf this coding was chosen directly by the user
                                        Comments

                                        Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                                        Control0..0
                                        Typeboolean
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summarytrue
                                        Requirements

                                        This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        196. Appointment.reasonCode:sliceSisaltotarkenne.text
                                        Definition

                                        A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                        ShortPlain text representation of the concept
                                        Comments

                                        Very often the text is the same as a displayName of one of the codings.

                                        Control0..0
                                        Typestring
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summarytrue
                                        Requirements

                                        The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        198. Appointment.reasonCode:slicePalvelutarve
                                        Slice NameslicePalvelutarve
                                        Definition

                                        hl7fi: 76 Palvelutarve vapaamuotoisena tekstinä ilmaistu tieto asiakkaan palvelutarpeesta Huom. Palvelutarve kuvataan tasolla, jolla henkilön palveluiden tarve voidaan kuvata yhteisellä termillä, esim. raskausajan seuranta ja tuki.

                                        ShortCoded reason this appointment is scheduled
                                        Control0..1
                                        BindingThe codes SHOULD be taken from EncounterReasonCodes
                                        (preferred to http://hl7.org/fhir/ValueSet/encounter-reason)

                                        The Reason for the appointment to take place.

                                        TypeCodeableConcept
                                        Is Modifierfalse
                                        Summarytrue
                                        Requirements

                                        76 Palvelutarve

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        200. Appointment.reasonCode:slicePalvelutarve.id
                                        Definition

                                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                        ShortUnique id for inter-element referencing
                                        Control0..1
                                        Typestring
                                        Is Modifierfalse
                                        XML FormatIn the XML format, this property is represented as an attribute.
                                        Summaryfalse
                                        202. Appointment.reasonCode:slicePalvelutarve.extension
                                        Definition

                                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                        ShortAdditional content defined by implementations
                                        Comments

                                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                        Control0..*
                                        TypeExtension
                                        Is Modifierfalse
                                        Summaryfalse
                                        Alternate Namesextensions, user content
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                        SlicingThis element introduces a set of slices on Appointment.reasonCode.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                        • value @ url
                                        • 204. Appointment.reasonCode:slicePalvelutarve.coding
                                          Definition

                                          A reference to a code defined by a terminology system.

                                          ShortCode defined by a terminology system
                                          Comments

                                          Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                                          Control0..0
                                          TypeCoding
                                          Is Modifierfalse
                                          Summarytrue
                                          Requirements

                                          Allows for alternative encodings within a code system, and translations to other code systems.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          206. Appointment.reasonCode:slicePalvelutarve.text
                                          Definition

                                          A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                                          ShortPlain text representation of the concept
                                          Comments

                                          Very often the text is the same as a displayName of one of the codings.

                                          Control1..1
                                          Typestring
                                          Is Modifierfalse
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Summarytrue
                                          Requirements

                                          The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          208. Appointment.reasonReference
                                          Definition

                                          Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.

                                          ShortReason the appointment is to take place (resource)
                                          Control0..*
                                          TypeReference(Condition)contained
                                          Is Modifierfalse
                                          Summaryfalse
                                          Requirements

                                          56 kuvaus oireista/vaivasta ja 57 riskitiedot (Condition/Note)

                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          210. Appointment.reasonReference.id
                                          Definition

                                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                          ShortUnique id for inter-element referencing
                                          Control0..1
                                          Typestring
                                          Is Modifierfalse
                                          XML FormatIn the XML format, this property is represented as an attribute.
                                          Summaryfalse
                                          212. Appointment.reasonReference.extension
                                          Definition

                                          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                          ShortAdditional content defined by implementations
                                          Comments

                                          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                          Control0..*
                                          TypeExtension
                                          Is Modifierfalse
                                          Summaryfalse
                                          Alternate Namesextensions, user content
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                          SlicingThis element introduces a set of slices on Appointment.reasonReference.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                          • value @ url
                                          • 214. Appointment.reasonReference.reference
                                            Definition

                                            A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                            ShortLiteral reference, Relative, internal or absolute URL
                                            Comments

                                            Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                            Control0..1
                                            This element is affected by the following invariants: ref-1
                                            Typestring
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summarytrue
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            216. Appointment.reasonReference.type
                                            Definition

                                            The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                            The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                            ShortType the reference refers to (e.g. "Patient")
                                            Comments

                                            This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

                                            Control0..1
                                            BindingUnless not suitable, these codes SHALL be taken from ResourceType
                                            (extensible to http://hl7.org/fhir/ValueSet/resource-types)

                                            Aa resource (or, for logical models, the URI of the logical model).

                                            Typeuri
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summarytrue
                                            Fixed ValueCondition
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            218. Appointment.reasonReference.identifier
                                            Definition

                                            An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                            ShortLogical reference, when literal reference is not known
                                            Comments

                                            When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                            When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                            Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                            Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                            NoteThis is a business identifier, not a resource identifier (see discussion)
                                            Control0..1
                                            TypeIdentifier
                                            Is Modifierfalse
                                            Summarytrue
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            220. Appointment.reasonReference.display
                                            Definition

                                            Plain text narrative that identifies the resource in addition to the resource reference.

                                            ShortText alternative for the resource
                                            Comments

                                            This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                            Control0..1
                                            Typestring
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summarytrue
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            222. Appointment.priority
                                            Definition

                                            The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).

                                            ShortUsed to make informed decisions if needing to re-prioritize
                                            Comments

                                            Seeking implementer feedback on this property and how interoperable it is.

                                            Using an extension to record a CodeableConcept for named values may be tested at a future connectathon.

                                            Control0..1
                                            TypeunsignedInt
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summaryfalse
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            224. Appointment.description
                                            Definition

                                            The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.

                                            ShortShown on a subject line in a meeting request, or appointment list
                                            Control0..1
                                            Typestring
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summaryfalse
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            226. Appointment.supportingInformation
                                            Definition

                                            Additional information to support the appointment provided when making the appointment.

                                            ShortAdditional information to support the appointment
                                            Control0..*
                                            TypeReference(Resource)
                                            Is Modifierfalse
                                            Summaryfalse
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            228. Appointment.start
                                            Definition

                                            Date/Time that the appointment is to take place.

                                            ShortWhen appointment is to take place
                                            Control0..1
                                            Typeinstant
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summarytrue
                                            Requirements

                                            86 Aikaväli

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            230. Appointment.end
                                            Definition

                                            Date/Time that the appointment is to conclude.

                                            ShortWhen appointment is to conclude
                                            Control0..1
                                            Typeinstant
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summarytrue
                                            Requirements

                                            86 Aikaväli

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            232. Appointment.minutesDuration
                                            Definition

                                            Number of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.

                                            ShortCan be less than start/end (e.g. estimate)
                                            Control0..1
                                            TypepositiveInt
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summaryfalse
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            234. Appointment.slot
                                            Definition

                                            The slots from the participants' schedules that will be filled by the appointment.

                                            ShortThe slots that this appointment is filling
                                            Control0..*
                                            TypeReference(Slot)
                                            Is Modifierfalse
                                            Summaryfalse
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            236. Appointment.created
                                            Definition

                                            The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.

                                            ShortThe date that this appointment was initially created
                                            Comments

                                            This property is required for many use cases where the age of an appointment is considered in processing workflows for scheduling and billing of appointments.

                                            Control0..1
                                            TypedateTime
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summaryfalse
                                            Requirements

                                            38 Merkinnän kirjausaika

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            238. Appointment.comment
                                            Definition

                                            hl7fi: asiakkaalle tai ajanvarauksen katselijalle tarkoitettu vapaamuotoinen lisätieto

                                            Shorthl7fi: asiakkaalle tai ajanvarauksen katselijalle tarkoitettu vapaamuotoinen lisätieto
                                            Comments

                                            Additional text to aid in facilitating the appointment. For instance, a comment might be, "patient should proceed immediately to infusion room upon arrival"

                                            Where this is a planned appointment and the start/end dates are not set then this field can be used to provide additional guidance on the details of the appointment request, including any restrictions on when to book it.

                                            Control0..1
                                            Typestring
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summaryfalse
                                            Requirements

                                            99 Huomautukset

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            240. Appointment.patientInstruction
                                            Definition

                                            hl7fi: vapaamuotoisena tekstinä ilmaistu potilasohje, joka tarjoaa asiakkaalle tietoa esimerkiksi sairaudesta, tutkimuksista, hoidoista, toimenpiteisiin valmistautumisesta, jälkihoidosta, itsehoidosta, toipumisesta, sairauden kulusta ja sairauden ennusteesta Huom. Potilasohje voi olla esim. Käypä hoito -suositus tai yleinen sairaalan antama ohje, joka voi olla myös yksikkökohtainen.

                                            Shorthl7fi: vapaamuotoisena tekstinä ilmaistu potilasohje
                                            Control0..1
                                            Typestring
                                            Is Modifierfalse
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summaryfalse
                                            Requirements

                                            100 Potilasohje

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            242. Appointment.patientInstruction.id
                                            Definition

                                            unique id for the element within a resource (for internal references)

                                            Shortxml:id (or equivalent in JSON)
                                            Control0..1
                                            Typestring
                                            Is Modifierfalse
                                            XML FormatIn the XML format, this property is represented as an attribute.
                                            Summaryfalse
                                            244. Appointment.patientInstruction.extension
                                            Definition

                                            An Extension

                                            ShortExtension
                                            Control0..*
                                            TypeExtension
                                            Is Modifierfalse
                                            Summaryfalse
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                            SlicingThis element introduces a set of slices on Appointment.patientInstruction.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                            • value @ url
                                            • 246. Appointment.patientInstruction.value
                                              Definition

                                              The actual value

                                              ShortPrimitive value for string
                                              Control0..1
                                              Typestring
                                              Is Modifierfalse
                                              XML FormatIn the XML format, this property is represented as an attribute.
                                              Summaryfalse
                                              Max Length:1048576
                                              248. Appointment.basedOn
                                              Definition

                                              The service request this appointment is allocated to assess (e.g. incoming referral or procedure request).

                                              ShortThe service request this appointment is allocated to assess
                                              Control0..*
                                              TypeReference(ServiceRequest)
                                              Is Modifierfalse
                                              Summaryfalse
                                              Alternate NamesincomingReferral
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              250. Appointment.participant
                                              Definition

                                              List of participants involved in the appointment.

                                              ShortParticipants involved in appointment
                                              Control1..*
                                              TypeBackboneElement
                                              Is Modifierfalse
                                              Summaryfalse
                                              Invariantsapp-1: Either the type or actor on the participant SHALL be specified (type.exists() or actor.exists())
                                              ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              252. Appointment.participant.id
                                              Definition

                                              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                                              ShortUnique id for inter-element referencing
                                              Control0..1
                                              Typestring
                                              Is Modifierfalse
                                              XML FormatIn the XML format, this property is represented as an attribute.
                                              Summaryfalse
                                              254. Appointment.participant.extension
                                              Definition

                                              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                                              ShortAdditional content defined by implementations
                                              Comments

                                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                              Control0..*
                                              TypeExtension
                                              Is Modifierfalse
                                              Summaryfalse
                                              Alternate Namesextensions, user content
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                              256. Appointment.participant.modifierExtension
                                              Definition

                                              May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                                              Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                              ShortExtensions that cannot be ignored even if unrecognized
                                              Comments

                                              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                                              Control0..*
                                              TypeExtension
                                              Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                              Summarytrue
                                              Requirements

                                              Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                              Alternate Namesextensions, user content, modifiers
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                              258. Appointment.participant.type
                                              Definition

                                              Role of participant in the appointment.

                                              ShortRole of participant in the appointment
                                              Comments

                                              The role of the participant can be used to declare what the actor will be doing in the scope of this appointment.

                                              If the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning.

                                              This value SHALL be the same when creating an AppointmentResponse so that they can be matched, and subsequently update the Appointment.

                                              Control0..*
                                              BindingUnless not suitable, these codes SHALL be taken from ParticipantType
                                              (extensible to http://hl7.org/fhir/ValueSet/encounter-participant-type)

                                              Role of participant in encounter.

                                              TypeCodeableConcept
                                              Is Modifierfalse
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              260. Appointment.participant.actor
                                              Definition

                                              A Person, Location/HealthcareService or Device that is participating in the appointment.

                                              ShortPerson, Location/HealthcareService or Device
                                              Control0..1
                                              TypeReference(Patient, Practitioner, PractitionerRole, RelatedPerson, Device, HealthcareService, Location)
                                              Is Modifierfalse
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              262. Appointment.participant.required
                                              Definition

                                              Whether this participant is required to be present at the meeting. This covers a use-case where two doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present.

                                              Shortrequired | optional | information-only
                                              Control0..1
                                              BindingThe codes SHALL be taken from ParticipantRequired
                                              (required to http://hl7.org/fhir/ValueSet/participantrequired|4.0.1)

                                              Is the Participant required to attend the appointment.

                                              Typecode
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              264. Appointment.participant.status
                                              Definition

                                              Participation status of the actor.

                                              Shortaccepted | declined | tentative | needs-action
                                              Control1..1
                                              BindingThe codes SHALL be taken from ParticipationStatus
                                              (required to http://hl7.org/fhir/ValueSet/participationstatus|4.0.1)

                                              The Participation status of an appointment.

                                              Typecode
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              266. Appointment.participant.period
                                              Definition

                                              Participation period of the actor.

                                              ShortParticipation period of the actor
                                              Control0..1
                                              TypePeriod
                                              Is Modifierfalse
                                              Summaryfalse
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              268. Appointment.requestedPeriod
                                              Definition

                                              A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within.

                                              The duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system.

                                              ShortPotential date/time interval(s) requested to allocate the appointment within
                                              Comments

                                              This does not introduce a capacity for recurring appointments.

                                              Control0..*
                                              TypePeriod
                                              Is Modifierfalse
                                              Summaryfalse
                                              Requirements

                                              35 Ajankohta, jolloin ajanvaraus ohjeistettu tehtäväksi

                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))