ITB - Online appointment booking service
1.0.0 - Initial Release

ITB - Online appointment booking service, published by Service Well AB. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/servicewell/servicewell.fhir.wof-portal/ and changes regularly. See the Directory of published versions

Resource Profile: PortalAvailableAppointment - Detailed Descriptions

Active as of 2026-04-20

Definitions for the portal-available-appointment resource profile.

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

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
Must Supportfalse
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.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()))
4. Appointment.meta.versionId
Definition

The technical resource version supplied by the server for change tracking of this specific PortalAvailableAppointment instance.


The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

ShortServer-managed resource versionVersion specific identifier
Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

Control0..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Obligations
    ObligationsActorSource
    SHALL:populatehttps://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-serverfrom Wof Base Appointment
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    6. Appointment.meta.profile
    Definition

    Identifies that the resource conforms to PortalAvailableAppointment so clients can safely process it as the WOF Portal service concept profile.


    A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

    ShortProfile declaration for this portal resourceProfiles this resource claims to conform to
    Comments

    It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

    Control10..*
    Typecanonical(StructureDefinition)
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Obligations
      ObligationsActorSource
      SHALL:populatehttps://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-serverfrom Wof Base Appointment
      Summarytrue
      Pattern Valuehttps://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/portal-available-appointment
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      8. 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..01
      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()))
      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..01
      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..0*
      TypeResource
      Is Modifierfalse
      Summaryfalse
      Alternate Namesinline resources, anonymous resources, contained resources
      14. 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.

      Control10..*
      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
      • 16. Appointment.extension:status-reason-extension
        Slice Namestatus-reason-extension
        Definition

        Captures the reason for the current state of the Appointment.

        ShortReason For Current Status
        Comments

        This is generally only used for "exception" statuses such as not-done, suspended or cancelled. The reason for performing the event at all is captured in the reason element, not here.

        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(Reason For Current Status) (Extension Type: CodeableConcept)
        Is Modifierfalse
        Must Supporttrue
        Alternate NamesSuspended Reason, Cancelled Reason
        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())
        18. Appointment.extension:activityDefinitionReference
        Slice NameactivityDefinitionReference
        Definition

        A reference to an ActivityDefinition that describes the type of activity or service associated with an Appointment.
        This extension allows linking an Appointment to a formal definition of the activity being performed, enabling structured representation of the intended service or procedure.

        ShortActivityDefinitionReference
        Control1..1
        TypeExtension(ActivityDefinitionReference) (Extension Type: Reference(ActivityDefinitionPortal))
        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())
        20. Appointment.modifierExtension
        Definition

        An Extension


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

        ShortExtensionExtensions 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..0*
        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())
        22. Appointment.identifier
        Definition

        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)
        Control20..*
        TypeIdentifier
        Is Modifierfalse
        Must Supporttrue
        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.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ type.text
        • 24. 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()))
          26. 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 Codeshttp://hl7.org/fhir/ValueSet/identifier-type|4.0.1
          (extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)

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

          TypeCodeableConcept
          Is Modifierfalse
          Obligations
            ObligationsActor
            SHOULD:ignorehttps://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client
            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()))
            28. Appointment.identifier:sourceSystemIdentifier
            Slice NamesourceSystemIdentifier
            Definition

            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..1*
            TypeIdentifier
            Is Modifierfalse
            Must Supporttrue
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            30. Appointment.identifier:sourceSystemIdentifier.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()))
            32. Appointment.identifier:sourceSystemIdentifier.system
            Definition

            See EndpointIdentifierSystemForAppointment for expected identifier.system values.


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

            ShortIdentifier-based reference to the Appointment concept in the source system.The namespace for the identifier value
            Comments

            Identifier.system is always case sensitive.

            Control10..1
            Typeuri
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            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.

            ExampleGeneral: http://www.acme.com/identifiers/patient
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            34. Appointment.identifier:sourceSystemIdentifier.value
            Definition

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

            ShortSource systems identifier for the appointmentThe 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
            Must Supporttrue
            Summarytrue
            ExampleGeneral: 123456
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            36. Appointment.identifier:slot-id
            Slice Nameslot-id
            Definition

            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..1*
            TypeIdentifier
            Is Modifierfalse
            Must Supporttrue
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            38. Appointment.identifier:slot-id.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()))
            40. Appointment.identifier:slot-id.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.

            Pattern Valuehttp://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/slot-id
            ExampleGeneral: http://www.acme.com/identifiers/patient
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            42. Appointment.identifier:slot-id.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
            Must Supporttrue
            Summarytrue
            ExampleGeneral: 123456
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            44. 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.

            Shortproposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
            Comments

            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
            Must Supporttrue
            Summarytrue
            Pattern Valueproposed
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            46. 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..01
            BindingFor example codes, see AppointmentCancellationReasonhttp://hl7.org/fhir/ValueSet/appointment-cancellation-reason|4.0.1
            (example to http://hl7.org/fhir/ValueSet/appointment-cancellation-reason)
            TypeCodeableConcept
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            48. 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..0*
            BindingFor example codes, see ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-category|4.0.1
            (example to http://hl7.org/fhir/ValueSet/service-category)
            TypeCodeableConcept
            Is Modifierfalse
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            50. 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..*
            BindingUnless not suitable, these codes SHALL be taken from For example codes, see IHE ITI Scheduling Snomed CT Serviceshttp://hl7.org/fhir/ValueSet/service-type|4.0.1
            (extensible to https://profiles.ihe.net/ITI/Scheduling/ValueSet/sct-services)
            TypeCodeableConcept
            Is Modifierfalse
            Must Supporttrue
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            52. 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.

            Control10..*
            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()))
            54. Appointment.serviceType.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.

            Control10..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()))
            56. 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
            Control10..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()))
            58. 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..0*
            BindingUnless not suitable, these codes SHALL be taken from The codes SHOULD be taken from IHE ITI Scheduling Specialtieshttp://hl7.org/fhir/ValueSet/c80-practice-codes|4.0.1
            (extensible to https://profiles.ihe.net/ITI/Scheduling/ValueSet/specialty)
            TypeCodeableConcept
            Is Modifierfalse
            Must Supporttrue
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            60. 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..01
            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
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            62. 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..0*
            BindingThe codes SHOULD be taken from EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason|4.0.1
            (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()))
            64. 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..0*
            TypeReference(Condition, Procedure, Observation, ImmunizationRecommendation, Condition, Procedure, Observation, ImmunizationRecommendation)
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            66. 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..01
            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()))
            68. 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..01
            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()))
            70. Appointment.supportingInformation
            Definition

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

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

            Date/Time that the appointment is to take place.

            ShortWhen appointment is to take place
            Control10..1
            Typeinstant
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            74. Appointment.end
            Definition

            Date/Time that the appointment is to conclude.

            ShortWhen appointment is to conclude
            Control10..1
            Typeinstant
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            76. 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..01
            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()))
            78. Appointment.slot
            Definition

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

            ShortThe slots that this appointment is filling
            Control0..0*
            TypeReference(Slot, Slot)
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            80. 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..01
            TypedateTime
            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()))
            82. Appointment.comment
            Definition

            Additional comments about the appointment.

            ShortAdditional 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..01
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            84. Appointment.patientInstruction
            Definition

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

            ShortDetailed information and instructions for the patient
            Control0..01
            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()))
            86. 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..0*
            TypeReference(ServiceRequest, ServiceRequest)
            Is Modifierfalse
            Summaryfalse
            Alternate NamesincomingReferral
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            88. 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())
            SlicingThis element introduces a set of slices on Appointment.participant. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • type @ actor
            • 90. 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())
              92. Appointment.participant.actor
              Definition

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

              ShortPerson, Location/HealthcareService or Device
              Control10..1
              TypeReference(Location, Patient, Practitioner, PractitionerRole, HealthcareService, Patient, Practitioner, PractitionerRole, RelatedPerson, Device, HealthcareService, Location)
              Is Modifierfalse
              Must Supporttrue
              Must Support TypesNo must-support rules about the choice of types/profiles
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              94. 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
              Must Supporttrue
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              96. Appointment.participant:healthcareService
              Slice NamehealthcareService
              Definition

              List of participants involved in the appointment.

              ShortParticipants involved in appointment
              Control01..1*
              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())
              98. Appointment.participant:healthcareService.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())
              100. Appointment.participant:healthcareService.actor
              Definition

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

              ShortPerson, Location/HealthcareService or Device
              Control10..1
              TypeReference(HealthcareServicePortal, Patient, Practitioner, PractitionerRole, RelatedPerson, Device, HealthcareService, Location)
              Is Modifierfalse
              Must Supporttrue
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              102. Appointment.participant:healthcareService.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
              Must Supporttrue
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              104. Appointment.participant:practitionerRole
              Slice NamepractitionerRole
              Definition

              List of participants involved in the appointment.

              ShortParticipants involved in appointment
              Control01..1*
              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())
              106. Appointment.participant:practitionerRole.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())
              108. Appointment.participant:practitionerRole.actor
              Definition

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

              ShortPerson, Location/HealthcareService or Device
              Control10..1
              TypeReference(PractitionerRolePortal, Patient, Practitioner, PractitionerRole, RelatedPerson, Device, HealthcareService, Location)
              Is Modifierfalse
              Must Supporttrue
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              110. Appointment.participant:practitionerRole.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
              Must Supporttrue
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              112. 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.

              Control10..1*
              TypePeriod
              Is Modifierfalse
              Must Supporttrue
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              114. Appointment.requestedPeriod.start
              Definition

              The start of the period. The boundary is inclusive.

              ShortStarting time with inclusive boundary
              Comments

              If the low element is missing, the meaning is that the low boundary is not known.

              Control10..1
              This element is affected by the following invariants: per-1
              TypedateTime
              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()))
              116. Appointment.requestedPeriod.end
              Definition

              The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

              ShortEnd time with inclusive boundary, if not ongoing
              Comments

              The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

              Control10..1
              This element is affected by the following invariants: per-1
              TypedateTime
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
              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 foundhere

              0. Appointment
              2. Appointment.meta
              4. Appointment.meta.versionId
              Definition

              The technical resource version supplied by the server for change tracking of this specific PortalAvailableAppointment instance.

              6. Appointment.meta.profile
              Definition

              Identifies that the resource conforms to PortalAvailableAppointment so clients can safely process it as the WOF Portal service concept profile.

              Pattern Valuehttps://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/portal-available-appointment
              8. Appointment.extension
              Control1..?
              10. Appointment.extension:activityDefinitionReference
              Slice NameactivityDefinitionReference
              Control1..1
              TypeExtension(ActivityDefinitionReference) (Extension Type: Reference(ActivityDefinitionPortal))
              12. Appointment.identifier
              NoteThis is a business identifier, not a resource identifier (see discussion)
              Control2..?
              SlicingThis element introduces a set of slices on Appointment.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ type.text
              • 14. Appointment.identifier.type
                Obligations
                  ObligationsActor
                  SHOULD:ignorehttps://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client
                  16. Appointment.identifier:sourceSystemIdentifier
                  Slice NamesourceSystemIdentifier
                  NoteThis is a business identifier, not a resource identifier (see discussion)
                  Control1..1
                  18. Appointment.identifier:sourceSystemIdentifier.type
                  20. Appointment.identifier:sourceSystemIdentifier.type.text
                  Control1..?
                  Pattern Valuesource systems appointment concept
                  22. Appointment.identifier:sourceSystemIdentifier.system
                  Definition

                  See EndpointIdentifierSystemForAppointment for expected identifier.system values.

                  ShortIdentifier-based reference to the Appointment concept in the source system.
                  Control1..?
                  Must Supporttrue
                  24. Appointment.identifier:sourceSystemIdentifier.value
                  ShortSource systems identifier for the appointment
                  Control1..?
                  Must Supporttrue
                  26. Appointment.identifier:slot-id
                  Slice Nameslot-id
                  NoteThis is a business identifier, not a resource identifier (see discussion)
                  Control1..1
                  Must Supporttrue
                  28. Appointment.identifier:slot-id.type
                  30. Appointment.identifier:slot-id.type.text
                  Control1..?
                  Pattern Valueid for the available slot
                  32. Appointment.identifier:slot-id.system
                  Pattern Valuehttp://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/slot-id
                  34. Appointment.identifier:slot-id.value
                  Control1..?
                  Must Supporttrue
                  36. Appointment.status
                  Pattern Valueproposed
                  38. Appointment.serviceCategory
                  Control0..0
                  40. Appointment.serviceType
                  Control1..?
                  42. Appointment.serviceType.coding
                  Control1..?
                  44. Appointment.serviceType.coding.system
                  Control1..?
                  46. Appointment.serviceType.coding.code
                  Control1..?
                  48. Appointment.reasonCode
                  Control0..0
                  50. Appointment.comment
                  Control0..0
                  52. Appointment.participant
                  SlicingThis element introduces a set of slices on Appointment.participant. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • type @ actor
                  • 54. Appointment.participant:healthcareService
                    Slice NamehealthcareService
                    Control0..1
                    56. Appointment.participant:healthcareService.actor
                    TypeReference(HealthcareServicePortal)
                    58. Appointment.participant:practitionerRole
                    Slice NamepractitionerRole
                    Control0..1
                    60. Appointment.participant:practitionerRole.actor
                    TypeReference(PractitionerRolePortal)
                    62. Appointment.requestedPeriod
                    64. Appointment.requestedPeriod.start
                    Control1..?
                    66. Appointment.requestedPeriod.end
                    Control1..?

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

                    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
                    Must Supportfalse
                    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.meta.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
                    8. Appointment.meta.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.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 10. Appointment.meta.versionId
                      Definition

                      The technical resource version supplied by the server for change tracking of this specific PortalAvailableAppointment instance.

                      ShortServer-managed resource version
                      Comments

                      The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

                      Control0..1
                      Typeid
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Must Supporttrue
                      Obligations
                        ObligationsActorSource
                        SHALL:populatehttps://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-serverfrom Wof Base Appointment
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        12. Appointment.meta.lastUpdated
                        Definition

                        When the resource last changed - e.g. when the version changed.

                        ShortWhen the resource version last changed
                        Comments

                        This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

                        Control0..1
                        Typeinstant
                        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()))
                        14. Appointment.meta.source
                        Definition

                        A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

                        ShortIdentifies where the resource comes from
                        Comments

                        In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

                        This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

                        Control0..1
                        Typeuri
                        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()))
                        16. Appointment.meta.profile
                        Definition

                        Identifies that the resource conforms to PortalAvailableAppointment so clients can safely process it as the WOF Portal service concept profile.

                        ShortProfile declaration for this portal resource
                        Comments

                        It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

                        Control1..*
                        Typecanonical(StructureDefinition)
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supporttrue
                        Obligations
                          ObligationsActorSource
                          SHALL:populatehttps://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-serverfrom Wof Base Appointment
                          Summarytrue
                          Pattern Valuehttps://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/portal-available-appointment
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          18. Appointment.meta.security
                          Definition

                          Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

                          ShortSecurity Labels applied to this resource
                          Comments

                          The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

                          Control0..*
                          BindingUnless not suitable, these codes SHALL be taken from All Security Labels
                          (extensible to http://hl7.org/fhir/ValueSet/security-labels|4.0.1)

                          Security Labels from the Healthcare Privacy and Security Classification System.

                          TypeCoding
                          Is Modifierfalse
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          20. Appointment.meta.tag
                          Definition

                          Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

                          ShortTags applied to this resource
                          Comments

                          The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

                          Control0..*
                          BindingFor example codes, see CommonTags
                          (example to http://hl7.org/fhir/ValueSet/common-tags|4.0.1)

                          Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

                          TypeCoding
                          Is Modifierfalse
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          22. 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..0
                          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()))
                          24. 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()))
                          26. 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..0
                          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()))
                          28. 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..0
                          TypeResource
                          Is Modifierfalse
                          Summaryfalse
                          Alternate Namesinline resources, anonymous resources, contained resources
                          30. Appointment.extension
                          Definition

                          An Extension

                          ShortExtension
                          Control1..*
                          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
                          • 32. Appointment.extension:status-reason-extension
                            Slice Namestatus-reason-extension
                            Definition

                            Captures the reason for the current state of the Appointment.

                            ShortReason For Current Status
                            Comments

                            This is generally only used for "exception" statuses such as not-done, suspended or cancelled. The reason for performing the event at all is captured in the reason element, not here.

                            Control0..1
                            This element is affected by the following invariants: ele-1
                            TypeExtension(Reason For Current Status) (Extension Type: CodeableConcept)
                            Is Modifierfalse
                            Must Supporttrue
                            Alternate NamesSuspended Reason, Cancelled Reason
                            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:activityDefinitionReference
                            Slice NameactivityDefinitionReference
                            Definition

                            A reference to an ActivityDefinition that describes the type of activity or service associated with an Appointment.
                            This extension allows linking an Appointment to a formal definition of the activity being performed, enabling structured representation of the intended service or procedure.

                            ShortActivityDefinitionReference
                            Control1..1
                            TypeExtension(ActivityDefinitionReference) (Extension Type: Reference(ActivityDefinitionPortal))
                            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())
                            36. Appointment.modifierExtension
                            Definition

                            An Extension

                            ShortExtension
                            Control0..0
                            TypeExtension
                            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                            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())
                            38. Appointment.identifier
                            Definition

                            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)
                            Control2..*
                            TypeIdentifier
                            Is Modifierfalse
                            Must Supporttrue
                            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.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ type.text
                            • 40. 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
                              42. 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
                              • 44. 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()))
                                46. 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|4.0.1)

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

                                TypeCodeableConcept
                                Is Modifierfalse
                                Obligations
                                  ObligationsActor
                                  SHOULD:ignorehttps://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client
                                  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()))
                                  48. 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.

                                  ExampleGeneral: http://www.acme.com/identifiers/patient
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  50. 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.

                                  Control0..1
                                  Typestring
                                  Is Modifierfalse
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  ExampleGeneral: 123456
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  52. 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()))
                                  54. 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()))
                                  56. Appointment.identifier:sourceSystemIdentifier
                                  Slice NamesourceSystemIdentifier
                                  Definition

                                  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..1
                                  TypeIdentifier
                                  Is Modifierfalse
                                  Must Supporttrue
                                  Summarytrue
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  58. Appointment.identifier:sourceSystemIdentifier.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
                                  60. Appointment.identifier:sourceSystemIdentifier.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
                                  • 62. Appointment.identifier:sourceSystemIdentifier.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()))
                                    64. Appointment.identifier:sourceSystemIdentifier.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|4.0.1)

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

                                    TypeCodeableConcept
                                    Is Modifierfalse
                                    Obligations
                                      ObligationsActor
                                      SHOULD:ignorehttps://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client
                                      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()))
                                      66. Appointment.identifier:sourceSystemIdentifier.type.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
                                      68. Appointment.identifier:sourceSystemIdentifier.type.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.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                      • value @ url
                                      • 70. Appointment.identifier:sourceSystemIdentifier.type.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()))
                                        72. Appointment.identifier:sourceSystemIdentifier.type.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.

                                        Pattern Valuesource systems appointment concept
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        74. Appointment.identifier:sourceSystemIdentifier.system
                                        Definition

                                        See EndpointIdentifierSystemForAppointment for expected identifier.system values.

                                        ShortIdentifier-based reference to the Appointment concept in the source system.
                                        Comments

                                        Identifier.system is always case sensitive.

                                        Control1..1
                                        Typeuri
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Must Supporttrue
                                        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.

                                        ExampleGeneral: http://www.acme.com/identifiers/patient
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        76. Appointment.identifier:sourceSystemIdentifier.value
                                        Definition

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

                                        ShortSource systems identifier for the appointment
                                        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
                                        Must Supporttrue
                                        Summarytrue
                                        ExampleGeneral: 123456
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        78. Appointment.identifier:sourceSystemIdentifier.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()))
                                        80. Appointment.identifier:sourceSystemIdentifier.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()))
                                        82. Appointment.identifier:slot-id
                                        Slice Nameslot-id
                                        Definition

                                        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..1
                                        TypeIdentifier
                                        Is Modifierfalse
                                        Must Supporttrue
                                        Summarytrue
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        84. Appointment.identifier:slot-id.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
                                        86. Appointment.identifier:slot-id.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
                                        • 88. Appointment.identifier:slot-id.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()))
                                          90. Appointment.identifier:slot-id.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|4.0.1)

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

                                          TypeCodeableConcept
                                          Is Modifierfalse
                                          Obligations
                                            ObligationsActor
                                            SHOULD:ignorehttps://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-client
                                            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()))
                                            92. Appointment.identifier:slot-id.type.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
                                            94. Appointment.identifier:slot-id.type.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.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                            • value @ url
                                            • 96. Appointment.identifier:slot-id.type.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()))
                                              98. Appointment.identifier:slot-id.type.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.

                                              Pattern Valueid for the available slot
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              100. Appointment.identifier:slot-id.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.

                                              Pattern Valuehttp://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/slot-id
                                              ExampleGeneral: http://www.acme.com/identifiers/patient
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              102. Appointment.identifier:slot-id.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
                                              Must Supporttrue
                                              Summarytrue
                                              ExampleGeneral: 123456
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              104. Appointment.identifier:slot-id.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()))
                                              106. Appointment.identifier:slot-id.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()))
                                              108. 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.

                                              Shortproposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
                                              Comments

                                              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
                                              Must Supporttrue
                                              Summarytrue
                                              Pattern Valueproposed
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              110. 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..0
                                              BindingFor example codes, see AppointmentCancellationReason
                                              (example to http://hl7.org/fhir/ValueSet/appointment-cancellation-reason)
                                              TypeCodeableConcept
                                              Is Modifierfalse
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              112. 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..0
                                              BindingFor example codes, see ServiceCategory
                                              (example to http://hl7.org/fhir/ValueSet/service-category)
                                              TypeCodeableConcept
                                              Is Modifierfalse
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              114. 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..*
                                              BindingUnless not suitable, these codes SHALL be taken from IHE ITI Scheduling Snomed CT Services
                                              (extensible to https://profiles.ihe.net/ITI/Scheduling/ValueSet/sct-services)
                                              TypeCodeableConcept
                                              Is Modifierfalse
                                              Must Supporttrue
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              116. 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
                                              118. 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
                                              • 120. 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.

                                                Control1..*
                                                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()))
                                                122. 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
                                                124. 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
                                                • 126. Appointment.serviceType.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.

                                                  Control1..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()))
                                                  128. 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()))
                                                  130. 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
                                                  Control1..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()))
                                                  132. 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()))
                                                  134. 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()))
                                                  136. 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()))
                                                  138. 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..0
                                                  BindingUnless not suitable, these codes SHALL be taken from IHE ITI Scheduling Specialties
                                                  (extensible to https://profiles.ihe.net/ITI/Scheduling/ValueSet/specialty)
                                                  TypeCodeableConcept
                                                  Is Modifierfalse
                                                  Must Supporttrue
                                                  Summarytrue
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  140. 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..0
                                                  BindingThe codes SHOULD be taken from hl7VS-appointmentReasonCodes
                                                  (preferred to http://terminology.hl7.org/ValueSet/v2-0276)
                                                  TypeCodeableConcept
                                                  Is Modifierfalse
                                                  Summarytrue
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  142. 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..0
                                                  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()))
                                                  144. 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..0
                                                  TypeReference(Condition, Procedure, Observation, ImmunizationRecommendation)
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  146. 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..0
                                                  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()))
                                                  148. 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..0
                                                  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()))
                                                  150. Appointment.supportingInformation
                                                  Definition

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

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

                                                  Date/Time that the appointment is to take place.

                                                  ShortWhen appointment is to take place
                                                  Control1..1
                                                  Typeinstant
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Must Supporttrue
                                                  Summarytrue
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  154. Appointment.end
                                                  Definition

                                                  Date/Time that the appointment is to conclude.

                                                  ShortWhen appointment is to conclude
                                                  Control1..1
                                                  Typeinstant
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Must Supporttrue
                                                  Summarytrue
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  156. 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..0
                                                  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()))
                                                  158. Appointment.slot
                                                  Definition

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

                                                  ShortThe slots that this appointment is filling
                                                  Control0..0
                                                  TypeReference(Slot)
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  160. 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..0
                                                  TypedateTime
                                                  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()))
                                                  162. Appointment.comment
                                                  Definition

                                                  Additional comments about the appointment.

                                                  ShortAdditional 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..0
                                                  Typestring
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Must Supporttrue
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  164. Appointment.patientInstruction
                                                  Definition

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

                                                  ShortDetailed information and instructions for the patient
                                                  Control0..0
                                                  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()))
                                                  166. 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..0
                                                  TypeReference(ServiceRequest)
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Alternate NamesincomingReferral
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  168. 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()))
                                                  SlicingThis element introduces a set of slices on Appointment.participant. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                  • type @ actor
                                                  • 170. 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
                                                    172. 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())
                                                    174. 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())
                                                    176. 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()))
                                                    178. Appointment.participant.actor
                                                    Definition

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

                                                    ShortPerson, Location/HealthcareService or Device
                                                    Control1..1
                                                    TypeReference(Location, Patient, Practitioner, PractitionerRole, HealthcareService)
                                                    Is Modifierfalse
                                                    Must Supporttrue
                                                    Must Support TypesNo must-support rules about the choice of types/profiles
                                                    Summarytrue
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    180. 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()))
                                                    182. 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
                                                    Must Supporttrue
                                                    Summarytrue
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    184. 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()))
                                                    186. Appointment.participant:healthcareService
                                                    Slice NamehealthcareService
                                                    Definition

                                                    List of participants involved in the appointment.

                                                    ShortParticipants involved in appointment
                                                    Control0..1
                                                    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()))
                                                    188. Appointment.participant:healthcareService.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
                                                    190. Appointment.participant:healthcareService.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())
                                                    192. Appointment.participant:healthcareService.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())
                                                    194. Appointment.participant:healthcareService.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()))
                                                    196. Appointment.participant:healthcareService.actor
                                                    Definition

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

                                                    ShortPerson, Location/HealthcareService or Device
                                                    Control1..1
                                                    TypeReference(HealthcareServicePortal)
                                                    Is Modifierfalse
                                                    Must Supporttrue
                                                    Summarytrue
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    198. Appointment.participant:healthcareService.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()))
                                                    200. Appointment.participant:healthcareService.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
                                                    Must Supporttrue
                                                    Summarytrue
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    202. Appointment.participant:healthcareService.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()))
                                                    204. Appointment.participant:practitionerRole
                                                    Slice NamepractitionerRole
                                                    Definition

                                                    List of participants involved in the appointment.

                                                    ShortParticipants involved in appointment
                                                    Control0..1
                                                    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()))
                                                    206. Appointment.participant:practitionerRole.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
                                                    208. Appointment.participant:practitionerRole.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())
                                                    210. Appointment.participant:practitionerRole.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())
                                                    212. Appointment.participant:practitionerRole.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()))
                                                    214. Appointment.participant:practitionerRole.actor
                                                    Definition

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

                                                    ShortPerson, Location/HealthcareService or Device
                                                    Control1..1
                                                    TypeReference(PractitionerRolePortal)
                                                    Is Modifierfalse
                                                    Must Supporttrue
                                                    Summarytrue
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    216. Appointment.participant:practitionerRole.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()))
                                                    218. Appointment.participant:practitionerRole.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
                                                    Must Supporttrue
                                                    Summarytrue
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    220. Appointment.participant:practitionerRole.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()))
                                                    222. 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.

                                                    Control1..1
                                                    TypePeriod
                                                    Is Modifierfalse
                                                    Must Supporttrue
                                                    Summaryfalse
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    224. Appointment.requestedPeriod.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
                                                    226. Appointment.requestedPeriod.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.requestedPeriod.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                    • value @ url
                                                    • 228. Appointment.requestedPeriod.start
                                                      Definition

                                                      The start of the period. The boundary is inclusive.

                                                      ShortStarting time with inclusive boundary
                                                      Comments

                                                      If the low element is missing, the meaning is that the low boundary is not known.

                                                      Control1..1
                                                      This element is affected by the following invariants: per-1
                                                      TypedateTime
                                                      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()))
                                                      230. Appointment.requestedPeriod.end
                                                      Definition

                                                      The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

                                                      ShortEnd time with inclusive boundary, if not ongoing
                                                      Comments

                                                      The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

                                                      Control1..1
                                                      This element is affected by the following invariants: per-1
                                                      TypedateTime
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Summarytrue
                                                      Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))