0.1.0 - ci-build

WOFConnect, published by Service Well AB. This guide is not an authorized publication; it is the continuous build for version 0.1.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-connect/ and changes regularly. See the Directory of published versions

Resource Profile: WofConnectSchedule - Detailed Descriptions

Active as of 2025-11-27

Definitions for the wof-connect-schedule resource profile.

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

0. Schedule
Definition

A container for slots of time that may be available for booking appointments.

ShortA container for slots of time that may be available for booking appointments
Control0..*
Is Modifierfalse
Summaryfalse
Alternate NamesAvailability
Invariantsdom-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. Schedule.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
Control10..1
TypeMeta
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Schedule.meta.profile
Definition

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


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

ShortProfiles 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
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Schedule.implicitRules
Definition

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

ShortA set of rules under which this content was created
Comments

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

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

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

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

ShortExtensions that cannot be ignored
Comments

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

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

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

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

Whether this schedule record is in active use or should not be used (such as was entered in error).

ShortWhether this schedule is in active use
Comments

This element is labeled as a modifier because it may be used to mark that the resource was created in error.

Control0..1
Typeboolean
Is Modifiertrue because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Schedule.serviceType
Definition

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

ShortKind of treatment/serviceSpecific service
Control10..*
BindingFor example codes, see ServiceTypehttp://hl7.org/fhir/ValueSet/service-type|4.0.1
(example to http://hl7.org/fhir/ValueSet/service-type|4.0.1)
TypeCodeableConcept
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 Schedule.serviceType. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ coding.system
  • 14. Schedule.serviceType:service-type-id
    Slice Nameservice-type-id
    Definition

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

    ShortService Type Identifier Code and Endpoint Id CodeSpecific service
    Control10..1*
    BindingFor example codes, see ServiceTypehttp://hl7.org/fhir/ValueSet/service-type|4.0.1
    (example to http://hl7.org/fhir/ValueSet/service-type|4.0.1)
    TypeCodeableConcept
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    16. Schedule.serviceType:service-type-id.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.

    Control20..2*
    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()))
    SlicingThis element introduces a set of slices on Schedule.serviceType.coding. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ system
    • 18. Schedule.serviceType:service-type-id.coding:st-id
      Slice Namest-id
      Definition

      A reference to a code defined by a terminology system.

      ShortService Type Identifier Code, e.g., Treatment.Id, ActivityDefinition.Id, used when calling the Appintment APICode defined by a terminology system
      Comments

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

      Control10..1*
      TypeCoding
      Is Modifierfalse
      Must Supporttrue
      Obligations
        ObligationsActor
        ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/frenda-pms
        ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/wof-client
        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()))
        20. Schedule.serviceType:service-type-id.coding:st-id.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
        Must Supporttrue
        Summarytrue
        Requirements

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

        Pattern Valuehttp://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/service-type-id
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        22. Schedule.serviceType:service-type-id.coding:st-id.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
        Must Supporttrue
        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()))
        24. Schedule.serviceType:service-type-id.coding:ep-id
        Slice Nameep-id
        Definition

        A reference to a code defined by a terminology system.

        ShortEndpoint Identifier Code, e.g., this Endpoint.Id to make sure the service-type-id is unique per endpointCode defined by a terminology system
        Comments

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

        Control10..1*
        TypeCoding
        Is Modifierfalse
        Must Supporttrue
        Obligations
          ObligationsActor
          ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/frenda-pms
          ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/wof-client
          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()))
          26. Schedule.serviceType:service-type-id.coding:ep-id.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
          Must Supporttrue
          Summarytrue
          Requirements

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

          Pattern Valuehttp://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/endpoint-id
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          28. Schedule.serviceType:service-type-id.coding:ep-id.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
          Must Supporttrue
          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()))
          30. Schedule.actor
          Definition

          Slots that reference this schedule resource provide the availability details to these referenced resource(s).

          ShortClinic and provider actors in scope for this scheduleResource(s) that availability information is being provided for
          Comments

          The capacity to support multiple referenced resource types should be used in cases where the specific resources themselves cannot be scheduled without the other, and thus only make sense to the system exposing them as a group. Common examples of this are where the combination of a practitioner and a room (Location) are always required by a system.

          Control1..*
          TypeReference(Wof Connect HealthcareService, Wof Connect Practitioner, Wof Connect PractitionerRole, 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()))
          SlicingThis element introduces a set of slices on Schedule.actor. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • type @ $this
          • 32. Schedule.actor:healthcareService
            Slice NamehealthcareService
            Definition

            Slots that reference this schedule resource provide the availability details to these referenced resource(s).

            ShortThe HealthcareService that hosts the schedule if applicableResource(s) that availability information is being provided for
            Comments

            The capacity to support multiple referenced resource types should be used in cases where the specific resources themselves cannot be scheduled without the other, and thus only make sense to the system exposing them as a group. Common examples of this are where the combination of a practitioner and a room (Location) are always required by a system.

            Control01..*
            TypeReference(Wof Connect HealthcareService, Patient, Practitioner, PractitionerRole, RelatedPerson, Device, HealthcareService, Location)
            Is Modifierfalse
            Must Supporttrue
            Obligations
              ObligationsActor
              ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/frenda-pms
              ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/wof-client
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              34. Schedule.actor:practitioner
              Slice Namepractitioner
              Definition

              Slots that reference this schedule resource provide the availability details to these referenced resource(s).

              ShortThe practitioner who performs the serviceResource(s) that availability information is being provided for
              Comments

              The capacity to support multiple referenced resource types should be used in cases where the specific resources themselves cannot be scheduled without the other, and thus only make sense to the system exposing them as a group. Common examples of this are where the combination of a practitioner and a room (Location) are always required by a system.

              Control01..*
              TypeReference(Wof Connect Practitioner, Patient, Practitioner, PractitionerRole, RelatedPerson, Device, HealthcareService, Location)
              Is Modifierfalse
              Must Supporttrue
              Obligations
                ObligationsActor
                ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/frenda-pms
                ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/wof-client
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                36. Schedule.actor:practitionerRole
                Slice NamepractitionerRole
                Definition

                Slots that reference this schedule resource provide the availability details to these referenced resource(s).

                ShortThe practionerRole who performs the serviceResource(s) that availability information is being provided for
                Comments

                The capacity to support multiple referenced resource types should be used in cases where the specific resources themselves cannot be scheduled without the other, and thus only make sense to the system exposing them as a group. Common examples of this are where the combination of a practitioner and a room (Location) are always required by a system.

                Control1..1*
                TypeReference(Wof Connect PractitionerRole, Patient, Practitioner, PractitionerRole, RelatedPerson, Device, HealthcareService, Location)
                Is Modifierfalse
                Must Supporttrue
                Obligations
                  ObligationsActor
                  ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/frenda-pms
                  ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/wof-client
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  38. Schedule.planningHorizon
                  Definition

                  The period of time that the slots that reference this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a "template" for planning outside these dates.

                  ShortInterval for which this schedule is validPeriod of time covered by schedule
                  Control10..1
                  TypePeriod
                  Is Modifierfalse
                  Must Supporttrue
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  inv-schedule-planning: planningHorizon.start must be on or before planningHorizon.end (start <= end)
                  40. Schedule.planningHorizon.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
                  Must Supporttrue
                  Obligations
                    ObligationsActor
                    ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/frenda-pms
                    ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/wof-client
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    42. Schedule.planningHorizon.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
                    Must Supporttrue
                    Obligations
                      ObligationsActor
                      ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/frenda-pms
                      ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/wof-client
                      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. Schedule
                      2. Schedule.meta
                      Control1..?
                      4. Schedule.meta.profile
                      Control1..?
                      6. Schedule.serviceType
                      ShortKind of treatment/service
                      Control1..?
                      Must Supporttrue
                      SlicingThis element introduces a set of slices on Schedule.serviceType. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ coding.system
                      • 8. Schedule.serviceType:service-type-id
                        Slice Nameservice-type-id
                        ShortService Type Identifier Code and Endpoint Id Code
                        Control1..1
                        Must Supporttrue
                        10. Schedule.serviceType:service-type-id.coding
                        Control2..2
                        SlicingThis element introduces a set of slices on Schedule.serviceType.coding. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ system
                        • 12. Schedule.serviceType:service-type-id.coding:st-id
                          Slice Namest-id
                          ShortService Type Identifier Code, e.g., Treatment.Id, ActivityDefinition.Id, used when calling the Appintment API
                          Control1..1
                          Must Supporttrue
                          Obligations
                            ObligationsActor
                            ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/frenda-pms
                            ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/wof-client
                            14. Schedule.serviceType:service-type-id.coding:st-id.system
                            Control1..?
                            Must Supporttrue
                            Pattern Valuehttp://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/service-type-id
                            16. Schedule.serviceType:service-type-id.coding:st-id.code
                            Control1..?
                            Must Supporttrue
                            18. Schedule.serviceType:service-type-id.coding:ep-id
                            Slice Nameep-id
                            ShortEndpoint Identifier Code, e.g., this Endpoint.Id to make sure the service-type-id is unique per endpoint
                            Control1..1
                            Must Supporttrue
                            Obligations
                              ObligationsActor
                              ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/frenda-pms
                              ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/wof-client
                              20. Schedule.serviceType:service-type-id.coding:ep-id.system
                              Control1..?
                              Must Supporttrue
                              Pattern Valuehttp://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/endpoint-id
                              22. Schedule.serviceType:service-type-id.coding:ep-id.code
                              Control1..?
                              Must Supporttrue
                              24. Schedule.actor
                              ShortClinic and provider actors in scope for this schedule
                              TypeReference(Wof Connect HealthcareService, Wof Connect Practitioner, Wof Connect PractitionerRole)
                              Must Supporttrue
                              Must Support TypesNo must-support rules about the choice of types/profiles
                              SlicingThis element introduces a set of slices on Schedule.actor. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • type @ $this
                              • 26. Schedule.actor:healthcareService
                                Slice NamehealthcareService
                                ShortThe HealthcareService that hosts the schedule if applicable
                                Control0..*
                                TypeReference(Wof Connect HealthcareService)
                                Must Supporttrue
                                Obligations
                                  ObligationsActor
                                  ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/frenda-pms
                                  ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/wof-client
                                  28. Schedule.actor:practitioner
                                  Slice Namepractitioner
                                  ShortThe practitioner who performs the service
                                  Control0..*
                                  TypeReference(Wof Connect Practitioner)
                                  Must Supporttrue
                                  Obligations
                                    ObligationsActor
                                    ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/frenda-pms
                                    ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/wof-client
                                    30. Schedule.actor:practitionerRole
                                    Slice NamepractitionerRole
                                    ShortThe practionerRole who performs the service
                                    Control1..1
                                    TypeReference(Wof Connect PractitionerRole)
                                    Must Supporttrue
                                    Obligations
                                      ObligationsActor
                                      ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/frenda-pms
                                      ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/wof-client
                                      32. Schedule.planningHorizon
                                      ShortInterval for which this schedule is valid
                                      Control1..?
                                      Must Supporttrue
                                      Invariantsinv-schedule-planning: planningHorizon.start must be on or before planningHorizon.end (start <= end)
                                      34. Schedule.planningHorizon.start
                                      Control1..?
                                      Must Supporttrue
                                      Obligations
                                        ObligationsActor
                                        ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/frenda-pms
                                        ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/wof-client
                                        36. Schedule.planningHorizon.end
                                        Control1..?
                                        Must Supporttrue
                                        Obligations
                                          ObligationsActor
                                          ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/frenda-pms
                                          ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/wof-client

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

                                          0. Schedule
                                          Definition

                                          A container for slots of time that may be available for booking appointments.

                                          ShortA container for slots of time that may be available for booking appointments
                                          Control0..*
                                          Is Modifierfalse
                                          Summaryfalse
                                          Alternate NamesAvailability
                                          Invariantsdom-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. Schedule.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. Schedule.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
                                          Control1..1
                                          TypeMeta
                                          Is Modifierfalse
                                          Summarytrue
                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                          6. Schedule.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. Schedule.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 Schedule.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                          • value @ url
                                          • 10. Schedule.meta.versionId
                                            Definition

                                            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.

                                            ShortVersion 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
                                            Summarytrue
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            12. Schedule.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. Schedule.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. Schedule.meta.profile
                                            Definition

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

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

                                            Control1..*
                                            Typecanonical(StructureDefinition)
                                            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()))
                                            18. Schedule.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. Schedule.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. Schedule.implicitRules
                                            Definition

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

                                            ShortA set of rules under which this content was created
                                            Comments

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

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

                                            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. Schedule.text
                                            Definition

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

                                            ShortText summary of the resource, for human interpretation
                                            Comments

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

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

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

                                            ShortContained, inline Resources
                                            Comments

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

                                            Control0..*
                                            TypeResource
                                            Is Modifierfalse
                                            Summaryfalse
                                            Alternate Namesinline resources, anonymous resources, contained resources
                                            30. Schedule.extension
                                            Definition

                                            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.

                                            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())
                                            32. Schedule.modifierExtension
                                            Definition

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

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

                                            ShortExtensions that cannot be ignored
                                            Comments

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

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

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

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

                                            External Ids for this item.

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

                                            Whether this schedule record is in active use or should not be used (such as was entered in error).

                                            ShortWhether this schedule is in active use
                                            Comments

                                            This element is labeled as a modifier because it may be used to mark that the resource was created in error.

                                            Control0..1
                                            Typeboolean
                                            Is Modifiertrue because This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                            Summarytrue
                                            Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            38. Schedule.serviceCategory
                                            Definition

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

                                            ShortHigh-level category
                                            Control0..*
                                            BindingFor example codes, see ServiceCategory
                                            (example to http://hl7.org/fhir/ValueSet/service-category|4.0.1)
                                            TypeCodeableConcept
                                            Is Modifierfalse
                                            Summarytrue
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            40. Schedule.serviceType
                                            Definition

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

                                            ShortKind of treatment/service
                                            Control1..*
                                            BindingFor example codes, see ServiceType
                                            (example to http://hl7.org/fhir/ValueSet/service-type|4.0.1)
                                            TypeCodeableConcept
                                            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 Schedule.serviceType. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                            • value @ coding.system
                                            • 42. Schedule.serviceType:service-type-id
                                              Slice Nameservice-type-id
                                              Definition

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

                                              ShortService Type Identifier Code and Endpoint Id Code
                                              Control1..1
                                              BindingFor example codes, see ServiceType
                                              (example to http://hl7.org/fhir/ValueSet/service-type|4.0.1)
                                              TypeCodeableConcept
                                              Is Modifierfalse
                                              Must Supporttrue
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              44. Schedule.serviceType:service-type-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
                                              46. Schedule.serviceType:service-type-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 Schedule.serviceType.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                              • value @ url
                                              • 48. Schedule.serviceType:service-type-id.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.

                                                Control2..2
                                                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()))
                                                SlicingThis element introduces a set of slices on Schedule.serviceType.coding. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                • value @ system
                                                • 50. Schedule.serviceType:service-type-id.coding:st-id
                                                  Slice Namest-id
                                                  Definition

                                                  A reference to a code defined by a terminology system.

                                                  ShortService Type Identifier Code, e.g., Treatment.Id, ActivityDefinition.Id, used when calling the Appintment API
                                                  Comments

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

                                                  Control1..1
                                                  TypeCoding
                                                  Is Modifierfalse
                                                  Must Supporttrue
                                                  Obligations
                                                    ObligationsActor
                                                    ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/frenda-pms
                                                    ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/wof-client
                                                    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()))
                                                    52. Schedule.serviceType:service-type-id.coding:st-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
                                                    54. Schedule.serviceType:service-type-id.coding:st-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 Schedule.serviceType.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                    • value @ url
                                                    • 56. Schedule.serviceType:service-type-id.coding:st-id.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
                                                      Must Supporttrue
                                                      Summarytrue
                                                      Requirements

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

                                                      Pattern Valuehttp://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/service-type-id
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      58. Schedule.serviceType:service-type-id.coding:st-id.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()))
                                                      60. Schedule.serviceType:service-type-id.coding:st-id.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
                                                      Must Supporttrue
                                                      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()))
                                                      62. Schedule.serviceType:service-type-id.coding:st-id.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()))
                                                      64. Schedule.serviceType:service-type-id.coding:st-id.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()))
                                                      66. Schedule.serviceType:service-type-id.coding:ep-id
                                                      Slice Nameep-id
                                                      Definition

                                                      A reference to a code defined by a terminology system.

                                                      ShortEndpoint Identifier Code, e.g., this Endpoint.Id to make sure the service-type-id is unique per endpoint
                                                      Comments

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

                                                      Control1..1
                                                      TypeCoding
                                                      Is Modifierfalse
                                                      Must Supporttrue
                                                      Obligations
                                                        ObligationsActor
                                                        ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/frenda-pms
                                                        ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/wof-client
                                                        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()))
                                                        68. Schedule.serviceType:service-type-id.coding:ep-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
                                                        70. Schedule.serviceType:service-type-id.coding:ep-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 Schedule.serviceType.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                        • value @ url
                                                        • 72. Schedule.serviceType:service-type-id.coding:ep-id.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
                                                          Must Supporttrue
                                                          Summarytrue
                                                          Requirements

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

                                                          Pattern Valuehttp://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/endpoint-id
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          74. Schedule.serviceType:service-type-id.coding:ep-id.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()))
                                                          76. Schedule.serviceType:service-type-id.coding:ep-id.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
                                                          Must Supporttrue
                                                          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()))
                                                          78. Schedule.serviceType:service-type-id.coding:ep-id.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()))
                                                          80. Schedule.serviceType:service-type-id.coding:ep-id.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()))
                                                          82. Schedule.serviceType:service-type-id.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()))
                                                          84. Schedule.specialty
                                                          Definition

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

                                                          ShortType of specialty needed
                                                          Control0..*
                                                          BindingThe codes SHOULD be taken from PracticeSettingCodeValueSet
                                                          (preferred to http://hl7.org/fhir/ValueSet/c80-practice-codes|4.0.1)

                                                          Additional details about where the content was created (e.g. clinical specialty).

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

                                                          Slots that reference this schedule resource provide the availability details to these referenced resource(s).

                                                          ShortClinic and provider actors in scope for this schedule
                                                          Comments

                                                          The capacity to support multiple referenced resource types should be used in cases where the specific resources themselves cannot be scheduled without the other, and thus only make sense to the system exposing them as a group. Common examples of this are where the combination of a practitioner and a room (Location) are always required by a system.

                                                          Control1..*
                                                          TypeReference(Wof Connect HealthcareService, Wof Connect Practitioner, Wof Connect PractitionerRole)
                                                          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()))
                                                          SlicingThis element introduces a set of slices on Schedule.actor. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                          • type @ $this
                                                          • 88. Schedule.actor:healthcareService
                                                            Slice NamehealthcareService
                                                            Definition

                                                            Slots that reference this schedule resource provide the availability details to these referenced resource(s).

                                                            ShortThe HealthcareService that hosts the schedule if applicable
                                                            Comments

                                                            The capacity to support multiple referenced resource types should be used in cases where the specific resources themselves cannot be scheduled without the other, and thus only make sense to the system exposing them as a group. Common examples of this are where the combination of a practitioner and a room (Location) are always required by a system.

                                                            Control0..*
                                                            TypeReference(Wof Connect HealthcareService)
                                                            Is Modifierfalse
                                                            Must Supporttrue
                                                            Obligations
                                                              ObligationsActor
                                                              ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/frenda-pms
                                                              ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/wof-client
                                                              Summarytrue
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              90. Schedule.actor:practitioner
                                                              Slice Namepractitioner
                                                              Definition

                                                              Slots that reference this schedule resource provide the availability details to these referenced resource(s).

                                                              ShortThe practitioner who performs the service
                                                              Comments

                                                              The capacity to support multiple referenced resource types should be used in cases where the specific resources themselves cannot be scheduled without the other, and thus only make sense to the system exposing them as a group. Common examples of this are where the combination of a practitioner and a room (Location) are always required by a system.

                                                              Control0..*
                                                              TypeReference(Wof Connect Practitioner)
                                                              Is Modifierfalse
                                                              Must Supporttrue
                                                              Obligations
                                                                ObligationsActor
                                                                ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/frenda-pms
                                                                ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/wof-client
                                                                Summarytrue
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                92. Schedule.actor:practitionerRole
                                                                Slice NamepractitionerRole
                                                                Definition

                                                                Slots that reference this schedule resource provide the availability details to these referenced resource(s).

                                                                ShortThe practionerRole who performs the service
                                                                Comments

                                                                The capacity to support multiple referenced resource types should be used in cases where the specific resources themselves cannot be scheduled without the other, and thus only make sense to the system exposing them as a group. Common examples of this are where the combination of a practitioner and a room (Location) are always required by a system.

                                                                Control1..1
                                                                TypeReference(Wof Connect PractitionerRole)
                                                                Is Modifierfalse
                                                                Must Supporttrue
                                                                Obligations
                                                                  ObligationsActor
                                                                  ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/frenda-pms
                                                                  ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/wof-client
                                                                  Summarytrue
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  94. Schedule.planningHorizon
                                                                  Definition

                                                                  The period of time that the slots that reference this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a "template" for planning outside these dates.

                                                                  ShortInterval for which this schedule is valid
                                                                  Control1..1
                                                                  TypePeriod
                                                                  Is Modifierfalse
                                                                  Must Supporttrue
                                                                  Summarytrue
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  inv-schedule-planning: planningHorizon.start must be on or before planningHorizon.end (start <= end)
                                                                  96. Schedule.planningHorizon.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
                                                                  98. Schedule.planningHorizon.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 Schedule.planningHorizon.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                  • value @ url
                                                                  • 100. Schedule.planningHorizon.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
                                                                    Must Supporttrue
                                                                    Obligations
                                                                      ObligationsActor
                                                                      ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/frenda-pms
                                                                      ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/wof-client
                                                                      Summarytrue
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      102. Schedule.planningHorizon.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
                                                                      Must Supporttrue
                                                                      Obligations
                                                                        ObligationsActor
                                                                        ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/frenda-pms
                                                                        ??http://canonical.fhir.link/servicewell/wof-connect/ActorDefinition/wof-client
                                                                        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()))
                                                                        104. Schedule.comment
                                                                        Definition

                                                                        Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.

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