Extensions for Using Data Elements from FHIR R5 in FHIR STU3
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R5 in FHIR STU3 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R5_Slot_R3 - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the profile-Slot resource profile.

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

0. Slot
Definition

A slot of time on a schedule that may be available for booking appointments.

ShortA slot of time on a schedule that may be available for booking appointments
Control0..*
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
2. Slot.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.

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.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

Control0..1
Typeuri
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
4. Slot.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. Usually modifier elements provide negation or qualification. In order 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.

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 No Modifier Reason provideed in previous versions of FHIR
Alternate Namesextensions, user content
6. Slot.schedule
Definition

The schedule resource that this slot defines an interval of status information.

ShortThe schedule resource that this slot defines an interval of status information
Control1..1
TypeReference(Schedule)
Summarytrue
8. Slot.schedule.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the element. In order 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.

ShortExtensionAdditional Content defined by implementations
Comments

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

Control0..*
TypeExtension
Alternate Namesextensions, user content
SlicingThis element introduces a set of slices on Slot.schedule.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 10. Slot.schedule.extension:schedule
    Slice Nameschedule
    Definition

    R5: Slot.schedule additional types from child elements (display, identifier, reference, type)

    ShortR5: schedule additional types
    Comments

    Element Slot.schedule is mapped to FHIR STU3 element Slot.schedule as SourceIsBroaderThanTarget. The mappings for Slot.schedule do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element Slot.schedule with unmapped reference targets: Schedule.

    Control0..1
    TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
    12. Slot.status
    Definition

    busy | free | busy-unavailable | busy-tentative | entered-in-error.

    Shortbusy | free | busy-unavailable | busy-tentative | entered-in-error
    Control1..1
    BindingThe codes SHALL be taken from SlotStatushttp://hl7.org/fhir/ValueSet/slotstatus|3.0.2
    (required to http://hl7.org/fhir/ValueSet/slotstatus|3.0.2)

    The free/busy status of the slot.

    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    14. Slot.start
    Definition

    Date/Time that the slot is to begin.

    ShortDate/Time that the slot is to begin
    Control1..1
    Typeinstant
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    16. Slot.end
    Definition

    Date/Time that the slot is to conclude.

    ShortDate/Time that the slot is to conclude
    Control1..1
    Typeinstant
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue

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

    0. Slot
    2. Slot.serviceType
    4. Slot.serviceType.extension
    Control0..*
    SlicingThis element introduces a set of slices on Slot.serviceType.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 6. Slot.serviceType.extension:serviceType
      Slice NameserviceType
      Definition

      R5: Slot.serviceType additional types (CodeableReference(http://hl7.org/fhir/StructureDefinition/HealthcareService)) additional types from child elements (reference)

      ShortR5: The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the Schedule resource additional types
      Comments

      Element Slot.serviceType is mapped to FHIR STU3 element Slot.serviceType as SourceIsBroaderThanTarget. The mappings for Slot.serviceType do not cover the following types: CodeableReference. The mappings for Slot.serviceType do not cover the following types based on type expansion: reference.

      Control0..*
      TypeExtension(R5: The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the Schedule resource additional types) (Extension Type: Reference(Cross-version Profile for R5.HealthcareService for use in FHIR STU3, HealthcareService))
      8. Slot.schedule
      10. Slot.schedule.extension
      Control0..*
      SlicingThis element introduces a set of slices on Slot.schedule.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 12. Slot.schedule.extension:schedule
        Slice Nameschedule
        Definition

        R5: Slot.schedule additional types from child elements (display, identifier, reference, type)

        ShortR5: schedule additional types
        Comments

        Element Slot.schedule is mapped to FHIR STU3 element Slot.schedule as SourceIsBroaderThanTarget. The mappings for Slot.schedule do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element Slot.schedule with unmapped reference targets: Schedule.

        Control0..1
        TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)

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

        0. Slot
        Definition

        A slot of time on a schedule that may be available for booking appointments.

        ShortA slot of time on a schedule that may be available for booking appointments
        Control0..*
        Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
        dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
        2. Slot.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
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        4. Slot.meta
        Definition

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

        ShortMetadata about the resource
        Control0..1
        TypeMeta
        Summarytrue
        6. Slot.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.

        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.

        This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

        Control0..1
        Typeuri
        Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        8. Slot.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
        BindingUnless not suitable, these codes SHALL be taken from Common Languages .
        (extensible to http://hl7.org/fhir/ValueSet/languages|3.0.2)

        A human language.

        Additional BindingsPurpose
        All LanguagesMax Binding
        Typecode
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        10. Slot.text
        Definition

        A human-readable narrative that contains a summary of the resource, and may 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 in formation is added later.

        Control0..1
        This element is affected by the following invariants: dom-1
        TypeNarrative
        Alternate Namesnarrative, html, xhtml, display
        12. Slot.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.

        Control0..*
        TypeResource
        Alternate Namesinline resources, anonymous resources, contained resources
        14. Slot.extension
        Definition

        May be used to represent additional information that is not part of the basic definition of the resource. In order 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.

        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
        Alternate Namesextensions, user content
        16. Slot.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. Usually modifier elements provide negation or qualification. In order 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.

        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 No Modifier Reason provideed in previous versions of FHIR
        Alternate Namesextensions, user content
        18. Slot.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
        Summarytrue
        20. Slot.serviceCategory
        Definition

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

        ShortA broad categorisation of the service that is to be performed during this appointment
        Control0..1
        BindingFor example codes, see ServiceCategory
        (example to http://hl7.org/fhir/ValueSet/service-category|3.0.2)
        TypeCodeableConcept
        Summarytrue
        22. Slot.serviceType
        Definition

        The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource.

        ShortThe type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource
        Control0..*
        BindingFor example codes, see ServiceType
        (example to http://hl7.org/fhir/ValueSet/service-type|3.0.2)
        TypeCodeableConcept
        Summarytrue
        24. Slot.serviceType.id
        Definition

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

        Shortxml:id (or equivalent in JSON)
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        26. Slot.serviceType.extension
        Definition

        An Extension

        ShortExtension
        Control0..*
        TypeExtension
        SlicingThis element introduces a set of slices on Slot.serviceType.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 28. Slot.serviceType.extension:serviceType
          Slice NameserviceType
          Definition

          R5: Slot.serviceType additional types (CodeableReference(http://hl7.org/fhir/StructureDefinition/HealthcareService)) additional types from child elements (reference)

          ShortR5: The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the Schedule resource additional types
          Comments

          Element Slot.serviceType is mapped to FHIR STU3 element Slot.serviceType as SourceIsBroaderThanTarget. The mappings for Slot.serviceType do not cover the following types: CodeableReference. The mappings for Slot.serviceType do not cover the following types based on type expansion: reference.

          Control0..*
          TypeExtension(R5: The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the Schedule resource additional types) (Extension Type: Reference(Cross-version Profile for R5.HealthcareService for use in FHIR STU3, HealthcareService))
          30. Slot.serviceType.coding
          Definition

          A reference to a code defined by a terminology system.

          ShortCode defined by a terminology system
          Comments

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

          Control0..*
          TypeCoding
          Summarytrue
          Requirements

          Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

          32. Slot.serviceType.text
          Definition

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

          ShortPlain text representation of the concept
          Comments

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

          Control0..1
          Typestring
          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.

          34. Slot.specialty
          Definition

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

          ShortThe specialty of a practitioner that would be required to perform the service requested in this appointment
          Control0..*
          BindingThe codes SHOULD be taken from Practice Setting Code Value Set
          (preferred to http://hl7.org/fhir/ValueSet/c80-practice-codes|20091109)

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

          TypeCodeableConcept
          Summarytrue
          36. Slot.appointmentType
          Definition

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

          ShortThe style of appointment or patient that may be booked in the slot (not service type)
          Control0..1
          BindingThe codes SHOULD be taken from v2 Appointment reason codes
          (preferred to http://hl7.org/fhir/ValueSet/v2-0276|2.8.2)
          TypeCodeableConcept
          Summarytrue
          38. Slot.schedule
          Definition

          The schedule resource that this slot defines an interval of status information.

          ShortThe schedule resource that this slot defines an interval of status information
          Control1..1
          TypeReference(Schedule)
          Summarytrue
          40. Slot.schedule.id
          Definition

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

          Shortxml:id (or equivalent in JSON)
          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          XML FormatIn the XML format, this property is represented as an attribute.
          42. Slot.schedule.extension
          Definition

          An Extension

          ShortExtension
          Control0..*
          TypeExtension
          SlicingThis element introduces a set of slices on Slot.schedule.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 44. Slot.schedule.extension:schedule
            Slice Nameschedule
            Definition

            R5: Slot.schedule additional types from child elements (display, identifier, reference, type)

            ShortR5: schedule additional types
            Comments

            Element Slot.schedule is mapped to FHIR STU3 element Slot.schedule as SourceIsBroaderThanTarget. The mappings for Slot.schedule do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element Slot.schedule with unmapped reference targets: Schedule.

            Control0..1
            TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
            46. Slot.schedule.reference
            Definition

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

            ShortLiteral reference, Relative, internal or absolute URL
            Comments

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

            Control0..1
            This element is affected by the following invariants: ref-1
            Typestring
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            48. Slot.schedule.identifier
            Definition

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

            ShortLogical reference, when literal reference is not known
            Comments

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

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

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

            NoteThis is a business identifier, not a resource identifier (see discussion)
            Control0..1
            TypeIdentifier
            Summarytrue
            50. Slot.schedule.display
            Definition

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

            ShortText alternative for the resource
            Comments

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

            Control0..1
            Typestring
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            52. Slot.status
            Definition

            busy | free | busy-unavailable | busy-tentative | entered-in-error.

            Shortbusy | free | busy-unavailable | busy-tentative | entered-in-error
            Control1..1
            BindingThe codes SHALL be taken from SlotStatus
            (required to http://hl7.org/fhir/ValueSet/slotstatus|3.0.2)

            The free/busy status of the slot.

            Typecode
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            54. Slot.start
            Definition

            Date/Time that the slot is to begin.

            ShortDate/Time that the slot is to begin
            Control1..1
            Typeinstant
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            56. Slot.end
            Definition

            Date/Time that the slot is to conclude.

            ShortDate/Time that the slot is to conclude
            Control1..1
            Typeinstant
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            58. Slot.overbooked
            Definition

            This slot has already been overbooked, appointments are unlikely to be accepted for this time.

            ShortThis slot has already been overbooked, appointments are unlikely to be accepted for this time
            Control0..1
            Typeboolean
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Meaning if MissingIf overbooked is missing, systems may assume that there are still appointments available
            60. Slot.comment
            Definition

            Comments on the slot to describe any extended information. Such as custom constraints on the slot.

            ShortComments on the slot to describe any extended information. Such as custom constraints on the slot
            Control0..1
            Typestring
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension