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

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

Resource Profile: Profile_R4_HealthcareService_R5 - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the profile-HealthcareService resource profile.

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

0. HealthcareService
Definition

The details of a healthcare service available at a location.

ShortThe details of a healthcare service available at a location
Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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. HealthcareService.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 its 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 its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. HealthcareService.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

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..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
6. HealthcareService.extension
Definition

An Extension


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

ShortExtensionAdditional content defined by implementations
Comments

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

Control0..*
TypeExtension
Is Modifierfalse
Must Supportfalse
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())
ele-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 HealthcareService.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 8. HealthcareService.extension:telecom
    Slice Nametelecom
    Definition

    R4: HealthcareService.telecom (new:ContactPoint)

    ShortR4: Contacts related to the healthcare service (new)
    Comments

    Element HealthcareService.telecom has a context of HealthcareService based on following the parent source element upwards and mapping to HealthcareService. Element HealthcareService.telecom has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). If this is empty, then refer to the location's contacts.

    Control0..*
    TypeExtension(R4: Contacts related to the healthcare service (new)) (Extension Type: ContactPoint)
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-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. HealthcareService.extension:availabilityExceptions
    Slice NameavailabilityExceptions
    Definition

    R4: HealthcareService.availabilityExceptions (new:string)

    ShortR4: Description of availability exceptions (new)
    Comments

    Element HealthcareService.availabilityExceptions has a context of HealthcareService based on following the parent source element upwards and mapping to HealthcareService. Element HealthcareService.availabilityExceptions has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).

    Control0..1
    TypeExtension(R4: Description of availability exceptions (new)) (Extension Type: string)
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-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())
    12. HealthcareService.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 managable, 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
    Must Supportfalse
    Summarytrue
    Requirements

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

    Alternate Namesextensions, user content
    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())
    ele-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())
    14. HealthcareService.active
    Definition

    This flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this.

    ShortWhether this HealthcareService record 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
    Must Supportfalse
    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()))
    ele-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. HealthcareService
    2. HealthcareService.extension
    Control0..*
    SlicingThis element introduces a set of slices on HealthcareService.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 4. HealthcareService.extension:telecom
      Slice Nametelecom
      Definition

      R4: HealthcareService.telecom (new:ContactPoint)

      ShortR4: Contacts related to the healthcare service (new)
      Comments

      Element HealthcareService.telecom has a context of HealthcareService based on following the parent source element upwards and mapping to HealthcareService. Element HealthcareService.telecom has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). If this is empty, then refer to the location's contacts.

      Control0..*
      TypeExtension(R4: Contacts related to the healthcare service (new)) (Extension Type: ContactPoint)
      6. HealthcareService.extension:availabilityExceptions
      Slice NameavailabilityExceptions
      Definition

      R4: HealthcareService.availabilityExceptions (new:string)

      ShortR4: Description of availability exceptions (new)
      Comments

      Element HealthcareService.availabilityExceptions has a context of HealthcareService based on following the parent source element upwards and mapping to HealthcareService. Element HealthcareService.availabilityExceptions has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).

      Control0..1
      TypeExtension(R4: Description of availability exceptions (new)) (Extension Type: string)
      8. HealthcareService.availability
      10. HealthcareService.availability.extension
      Control1..*
      SlicingThis element introduces a set of slices on HealthcareService.availability.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 12. HealthcareService.availability.extension:daysOfWeek
        Slice NamedaysOfWeek
        Definition

        R4: HealthcareService.availableTime.daysOfWeek additional types (code) additional types from child elements (value)

        ShortR4: mon | tue | wed | thu | fri | sat | sun additional types
        Comments

        Element HealthcareService.availableTime.daysOfWeek is mapped to FHIR R5 element HealthcareService.availability as SourceIsBroaderThanTarget. The mappings for HealthcareService.availableTime.daysOfWeek do not cover the following types: code. The mappings for HealthcareService.availableTime.daysOfWeek do not cover the following types based on type expansion: value.

        Control0..*
        TypeExtension(R4: mon | tue | wed | thu | fri | sat | sun additional types) (Extension Type: code)
        14. HealthcareService.availability.extension:allDay
        Slice NameallDay
        Definition

        R4: HealthcareService.availableTime.allDay (new:boolean)

        ShortR4: Always available? e.g. 24 hour service (new)
        Comments

        Element HealthcareService.availableTime.allDay has a context of HealthcareService.availability based on following the parent source element upwards and mapping to HealthcareService. Element HealthcareService.availableTime.allDay has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).

        Control0..1
        TypeExtension(R4: Always available? e.g. 24 hour service (new)) (Extension Type: boolean)
        16. HealthcareService.availability.extension:availableStartTime
        Slice NameavailableStartTime
        Definition

        R4: HealthcareService.availableTime.availableStartTime (new:time)

        ShortR4: Opening time of day (ignored if allDay = true) (new)
        Comments

        Element HealthcareService.availableTime.availableStartTime has a context of HealthcareService.availability based on following the parent source element upwards and mapping to HealthcareService. Element HealthcareService.availableTime.availableStartTime has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). The time zone is expected to be for where this HealthcareService is provided at.

        Control0..1
        TypeExtension(R4: Opening time of day (ignored if allDay = true) (new)) (Extension Type: time)
        18. HealthcareService.availability.extension:availableEndTime
        Slice NameavailableEndTime
        Definition

        R4: HealthcareService.availableTime.availableEndTime (new:time)

        ShortR4: Closing time of day (ignored if allDay = true) (new)
        Comments

        Element HealthcareService.availableTime.availableEndTime has a context of HealthcareService.availability based on following the parent source element upwards and mapping to HealthcareService. Element HealthcareService.availableTime.availableEndTime has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). The time zone is expected to be for where this HealthcareService is provided at.

        Control0..1
        TypeExtension(R4: Closing time of day (ignored if allDay = true) (new)) (Extension Type: time)
        20. HealthcareService.availability.extension:description
        Slice Namedescription
        Definition

        R4: HealthcareService.notAvailable.description additional types (string) additional types from child elements (value)

        ShortR4: Reason presented to the user explaining why time not available additional types
        Comments

        Element HealthcareService.notAvailable.description is mapped to FHIR R5 element HealthcareService.availability as RelatedTo. The mappings for HealthcareService.notAvailable.description do not cover the following types: string. The mappings for HealthcareService.notAvailable.description do not cover the following types based on type expansion: value.

        Control1..1
        TypeExtension(R4: Reason presented to the user explaining why time not available additional types) (Extension Type: string)
        22. HealthcareService.availability.extension:during
        Slice Nameduring
        Definition

        R4: HealthcareService.notAvailable.during (new:Period)

        ShortR4: Service not available from this date (new)
        Comments

        Element HealthcareService.notAvailable.during has a context of HealthcareService.availability based on following the parent source element upwards and mapping to HealthcareService. Element HealthcareService.notAvailable.during has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).

        Control0..1
        TypeExtension(R4: Service not available from this date (new)) (Extension Type: Period)

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

        0. HealthcareService
        Definition

        The details of a healthcare service available at a location.

        ShortThe details of a healthcare service available at a location
        Control0..*
        Is Modifierfalse
        Must Supportfalse
        Summaryfalse
        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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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. HealthcareService.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

        Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

        Control0..1
        Typeid
        Is Modifierfalse
        Must Supportfalse
        Summarytrue
        4. HealthcareService.meta
        Definition

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

        ShortMetadata about the resource
        Control0..1
        TypeMeta
        Is Modifierfalse
        Must Supportfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        6. HealthcareService.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 its 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 its meaning or interpretation
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supportfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        8. HealthcareService.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 SHALL be taken from AllLanguages
        (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)

        IETF language tag for a human language

        Typecode
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supportfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        10. HealthcareService.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 a 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
        This element is affected by the following invariants: dom-6
        TypeNarrative
        Is Modifierfalse
        Must Supportfalse
        Summaryfalse
        Alternate Namesnarrative, html, xhtml, display
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        12. HealthcareService.contained
        Definition

        These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

        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..*
        This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
        TypeResource
        Is Modifierfalse
        Must Supportfalse
        Summaryfalse
        Alternate Namesinline resources, anonymous resources, contained resources
        14. HealthcareService.extension
        Definition

        An Extension

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

          R4: HealthcareService.telecom (new:ContactPoint)

          ShortR4: Contacts related to the healthcare service (new)
          Comments

          Element HealthcareService.telecom has a context of HealthcareService based on following the parent source element upwards and mapping to HealthcareService. Element HealthcareService.telecom has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). If this is empty, then refer to the location's contacts.

          Control0..*
          TypeExtension(R4: Contacts related to the healthcare service (new)) (Extension Type: ContactPoint)
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          18. HealthcareService.extension:availabilityExceptions
          Slice NameavailabilityExceptions
          Definition

          R4: HealthcareService.availabilityExceptions (new:string)

          ShortR4: Description of availability exceptions (new)
          Comments

          Element HealthcareService.availabilityExceptions has a context of HealthcareService based on following the parent source element upwards and mapping to HealthcareService. Element HealthcareService.availabilityExceptions has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).

          Control0..1
          TypeExtension(R4: Description of availability exceptions (new)) (Extension Type: string)
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          20. HealthcareService.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 managable, 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
          Must Supportfalse
          Summarytrue
          Requirements

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

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

          External identifiers for this item.

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

          This flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this.

          ShortWhether this HealthcareService record 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
          Must Supportfalse
          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()))
          26. HealthcareService.providedBy
          Definition

          The organization that provides this healthcare service.

          ShortOrganization that provides this service
          Comments

          This property is recommended to be the same as the Location's managingOrganization, and if not provided should be interpreted as such. If the Location does not have a managing Organization, then this property should be populated.

          Control0..1
          TypeReference(Organization)
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          28. HealthcareService.offeredIn
          Definition

          When the HealthcareService is representing a specific, schedulable service, the availableIn property can refer to a generic service.

          ShortThe service within which this service is offered
          Comments

          For example, if there is a generic Radiology service that offers CT Scans, MRIs, etc. You could have HealthcareService resources for the CT Scans and MRIs, which have an offeredIn reference to the Radiology HealthcareService.

          Control0..*
          TypeReference(HealthcareService)
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          30. HealthcareService.category
          Definition

          Identifies the broad category of service being performed or delivered.

          ShortBroad category of service being performed or delivered
          Comments

          Selecting a Service Category then determines the list of relevant service types that can be selected in the primary service type.

          Control0..*
          BindingFor example codes, see ServiceCategory
          (example to http://hl7.org/fhir/ValueSet/service-category|5.0.0)

          A category of the service(s) that could be provided.

          TypeCodeableConcept
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          Alternate Namesservice category
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          32. HealthcareService.type
          Definition

          The specific type of service that may be delivered or performed.

          ShortType of service that may be delivered or performed
          Control0..*
          BindingFor example codes, see ServiceType
          (example to http://hl7.org/fhir/ValueSet/service-type|5.0.0)

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

          TypeCodeableConcept
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          Alternate Namesservice type
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          34. HealthcareService.specialty
          Definition

          Collection of specialties handled by the Healthcare service. This is more of a medical term.

          ShortSpecialties handled by the HealthcareService
          Control0..*
          BindingThe codes SHOULD be taken from PracticeSettingCodeValueSet
          (preferred to http://hl7.org/fhir/ValueSet/c80-practice-codes|5.0.0)

          A specialty that a healthcare service may provide.

          TypeCodeableConcept
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          36. HealthcareService.location
          Definition

          The location(s) where this healthcare service may be provided.

          ShortLocation(s) where service may be provided
          Control0..*
          TypeReference(Location)
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          38. HealthcareService.name
          Definition

          Further description of the service as it would be presented to a consumer while searching.

          ShortDescription of service as presented to a consumer while searching
          Control0..1
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supportfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          40. HealthcareService.comment
          Definition

          Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName.

          ShortAdditional description and/or any specific issues not covered elsewhere
          Comments

          Would expect that a user would not see this information on a search results, and it would only be available when viewing the complete details of the service.

          Control0..1
          Typemarkdown
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supportfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          42. HealthcareService.extraDetails
          Definition

          Extra details about the service that can't be placed in the other fields.

          ShortExtra details about the service that can't be placed in the other fields
          Control0..1
          Typemarkdown
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supportfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          44. HealthcareService.photo
          Definition

          If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list.

          ShortFacilitates quick identification of the service
          Control0..1
          TypeAttachment
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          46. HealthcareService.contact
          Definition

          The contact details of communication devices available relevant to the specific HealthcareService. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites.

          ShortOfficial contact details for the HealthcareService
          Comments

          The address/telecom use code 'home' are not to be used. Note that these contacts are not the contact details of people who provide the service (that would be through PractitionerRole), these are official contacts for the HealthcareService itself for specific purposes. E.g. Mailing Addresses, Billing Addresses, Contact numbers for Booking or Billing Enquiries, general web address, web address for online bookings etc.

          If this is empty (or the type of interest is empty), refer to the location's contacts.

          Control0..*
          TypeExtendedContactDetail
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Requirements

          Need to keep track of both simple contact details and also assigned contacts within larger organizations.

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

          The location(s) that this service is available to (not where the service is provided).

          ShortLocation(s) service is intended for/available to
          Comments

          The locations referenced by the coverage area can include both specific locations, including areas, and also conceptual domains too (mode = kind), such as a physical area (tri-state area) and some other attribute (covered by Example Care Organization). These types of Locations are often not managed by any specific organization. This could also include generic locations such as "in-home".

          Control0..*
          TypeReference(Location)
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          50. HealthcareService.serviceProvisionCode
          Definition

          The code(s) that detail the conditions under which the healthcare service is available/offered.

          ShortConditions under which service is available/offered
          Comments

          The provision means being commissioned by, contractually obliged or financially sourced. Types of costings that may apply to this healthcare service, such if the service may be available for free, some discounts available, or fees apply.

          Control0..*
          BindingFor example codes, see ServiceProvisionConditions
          (example to http://hl7.org/fhir/ValueSet/service-provision-conditions|5.0.0)

          The code(s) that detail the conditions under which the healthcare service is available/offered.

          TypeCodeableConcept
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          52. HealthcareService.eligibility
          Definition

          Does this service have specific eligibility requirements that need to be met in order to use the service?

          ShortSpecific eligibility requirements required to use the service
          Control0..*
          TypeBackboneElement
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          54. HealthcareService.eligibility.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
          This element is affected by the following invariants: ele-1
          Typestring
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          56. HealthcareService.eligibility.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 managable, 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())
          58. HealthcareService.eligibility.modifierExtension
          Definition

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

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

          ShortExtensions that cannot be ignored even if unrecognized
          Comments

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

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

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

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

          Coded value for the eligibility.

          ShortCoded value for the eligibility
          Control0..1
          Binding

          Coded values underwhich a specific service is made available.

          TypeCodeableConcept
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          62. HealthcareService.eligibility.comment
          Definition

          Describes the eligibility conditions for the service.

          ShortDescribes the eligibility conditions for the service
          Comments

          The description of service eligibility should, in general, not exceed one or two paragraphs. It should be sufficient for a prospective consumer to determine if they are likely to be eligible or not. Where eligibility requirements and conditions are complex, it may simply be noted that an eligibility assessment is required. Where eligibility is determined by an outside source, such as an Act of Parliament, this should be noted, preferably with a reference to a commonly available copy of the source document such as a web page.

          Control0..1
          Typemarkdown
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supportfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          64. HealthcareService.program
          Definition

          Programs that this service is applicable to.

          ShortPrograms that this service is applicable to
          Comments

          Programs are often defined externally to an Organization, commonly by governments; e.g. Home and Community Care Programs, Homeless Program, ….

          Control0..*
          BindingFor example codes, see Program
          (example to http://hl7.org/fhir/ValueSet/program|5.0.0)

          Government or local programs that this service applies to.

          TypeCodeableConcept
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          66. HealthcareService.characteristic
          Definition

          Collection of characteristics (attributes).

          ShortCollection of characteristics (attributes)
          Comments

          These could be such things as is wheelchair accessible.

          Control0..*
          BindingFor example codes, see ServiceMode
          (example to http://hl7.org/fhir/ValueSet/service-mode|5.0.0)

          A custom attribute that could be provided at a service (e.g. Wheelchair accessibility).

          TypeCodeableConcept
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          68. HealthcareService.communication
          Definition

          Some services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used.

          ShortThe language that this service is offered in
          Comments

          When using this property it indicates that the service is available with this language, it is not derived from the practitioners, and not all are required to use this language, just that this language is available while scheduling.

          Control0..*
          BindingThe codes SHALL be taken from AllLanguages
          (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)

          IETF language tag for a human language

          TypeCodeableConcept
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          70. HealthcareService.referralMethod
          Definition

          Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.

          ShortWays that the service accepts referrals
          Control0..*
          BindingFor example codes, see ReferralMethod
          (example to http://hl7.org/fhir/ValueSet/service-referral-method|5.0.0)

          The methods of referral can be used when referring to a specific HealthcareService resource.

          TypeCodeableConcept
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          72. HealthcareService.appointmentRequired
          Definition

          Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this service.

          ShortIf an appointment is required for access to this service
          Control0..1
          Typeboolean
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supportfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          74. HealthcareService.availability
          Definition

          A collection of times that the healthcare service is available.

          ShortTimes the healthcare service is available (including exceptions)
          Comments

          More detailed availability information may be provided in associated Schedule/Slot resources.

          Systems may choose to render availability differently than it is exchanged on the interface. For example, rather than "Mon, Tue, Wed, Thur, Fri from 9am-12am; Mon, Tue, Wed, Thur, Fri from 1pm-5pm" as would be implied by two availableTime repetitions, an application could render this information as "Mon-Fri 9-12am and 1-5pm".

          The NotAvailableTime(s) included indicate the general days/periods where the service is not available (for things such as public holidays).

          Control0..*
          TypeAvailability
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          76. HealthcareService.availability.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
          This element is affected by the following invariants: ele-1
          Typeid
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          78. HealthcareService.availability.extension
          Definition

          An Extension

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

            R4: HealthcareService.availableTime.daysOfWeek additional types (code) additional types from child elements (value)

            ShortR4: mon | tue | wed | thu | fri | sat | sun additional types
            Comments

            Element HealthcareService.availableTime.daysOfWeek is mapped to FHIR R5 element HealthcareService.availability as SourceIsBroaderThanTarget. The mappings for HealthcareService.availableTime.daysOfWeek do not cover the following types: code. The mappings for HealthcareService.availableTime.daysOfWeek do not cover the following types based on type expansion: value.

            Control0..*
            TypeExtension(R4: mon | tue | wed | thu | fri | sat | sun additional types) (Extension Type: code)
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            82. HealthcareService.availability.extension:allDay
            Slice NameallDay
            Definition

            R4: HealthcareService.availableTime.allDay (new:boolean)

            ShortR4: Always available? e.g. 24 hour service (new)
            Comments

            Element HealthcareService.availableTime.allDay has a context of HealthcareService.availability based on following the parent source element upwards and mapping to HealthcareService. Element HealthcareService.availableTime.allDay has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).

            Control0..1
            TypeExtension(R4: Always available? e.g. 24 hour service (new)) (Extension Type: boolean)
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            84. HealthcareService.availability.extension:availableStartTime
            Slice NameavailableStartTime
            Definition

            R4: HealthcareService.availableTime.availableStartTime (new:time)

            ShortR4: Opening time of day (ignored if allDay = true) (new)
            Comments

            Element HealthcareService.availableTime.availableStartTime has a context of HealthcareService.availability based on following the parent source element upwards and mapping to HealthcareService. Element HealthcareService.availableTime.availableStartTime has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). The time zone is expected to be for where this HealthcareService is provided at.

            Control0..1
            TypeExtension(R4: Opening time of day (ignored if allDay = true) (new)) (Extension Type: time)
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            86. HealthcareService.availability.extension:availableEndTime
            Slice NameavailableEndTime
            Definition

            R4: HealthcareService.availableTime.availableEndTime (new:time)

            ShortR4: Closing time of day (ignored if allDay = true) (new)
            Comments

            Element HealthcareService.availableTime.availableEndTime has a context of HealthcareService.availability based on following the parent source element upwards and mapping to HealthcareService. Element HealthcareService.availableTime.availableEndTime has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). The time zone is expected to be for where this HealthcareService is provided at.

            Control0..1
            TypeExtension(R4: Closing time of day (ignored if allDay = true) (new)) (Extension Type: time)
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            88. HealthcareService.availability.extension:description
            Slice Namedescription
            Definition

            R4: HealthcareService.notAvailable.description additional types (string) additional types from child elements (value)

            ShortR4: Reason presented to the user explaining why time not available additional types
            Comments

            Element HealthcareService.notAvailable.description is mapped to FHIR R5 element HealthcareService.availability as RelatedTo. The mappings for HealthcareService.notAvailable.description do not cover the following types: string. The mappings for HealthcareService.notAvailable.description do not cover the following types based on type expansion: value.

            Control1..1
            TypeExtension(R4: Reason presented to the user explaining why time not available additional types) (Extension Type: string)
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            90. HealthcareService.availability.extension:during
            Slice Nameduring
            Definition

            R4: HealthcareService.notAvailable.during (new:Period)

            ShortR4: Service not available from this date (new)
            Comments

            Element HealthcareService.notAvailable.during has a context of HealthcareService.availability based on following the parent source element upwards and mapping to HealthcareService. Element HealthcareService.notAvailable.during has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).

            Control0..1
            TypeExtension(R4: Service not available from this date (new)) (Extension Type: Period)
            Is Modifierfalse
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            92. HealthcareService.availability.availableTime
            Definition

            Times the {item} is available.

            ShortTimes the {item} is available
            Control0..*
            TypeElement
            Is Modifierfalse
            Summarytrue
            Requirements

            A collection of times that the {item} is available.

            Invariantsav-1: Cannot include start/end times when selecting all day availability. (allDay.exists().not() or (allDay implies availableStartTime.exists().not() and availableEndTime.exists().not()))
            ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            94. HealthcareService.availability.availableTime.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
            This element is affected by the following invariants: ele-1
            Typestring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            96. HealthcareService.availability.availableTime.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 managable, 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 HealthcareService.availability.availableTime.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 98. HealthcareService.availability.availableTime.daysOfWeek
              Definition

              mon | tue | wed | thu | fri | sat | sun.

              Shortmon | tue | wed | thu | fri | sat | sun
              Control0..*
              BindingThe codes SHALL be taken from DaysOfWeek
              (required to http://hl7.org/fhir/ValueSet/days-of-week|5.0.0)

              The purpose for which an extended contact detail should be used.

              Typecode
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              Indicates which days of the week are available between the start and end Times.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              100. HealthcareService.availability.availableTime.allDay
              Definition

              Always available? i.e. 24 hour service.

              ShortAlways available? i.e. 24 hour service
              Control0..1
              This element is affected by the following invariants: av-1
              Typeboolean
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              Is this always available? (hence times are irrelevant) i.e. 24 hour service.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              102. HealthcareService.availability.availableTime.availableStartTime
              Definition

              Opening time of day (ignored if allDay = true).

              ShortOpening time of day (ignored if allDay = true)
              Comments

              The timezone is expected to be specified or implied by the context this datatype is used.

              Control0..1
              This element is affected by the following invariants: av-1
              Typetime
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              The opening time of day. Note: If the AllDay flag is set, then this time is ignored.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              104. HealthcareService.availability.availableTime.availableEndTime
              Definition

              Closing time of day (ignored if allDay = true).

              ShortClosing time of day (ignored if allDay = true)
              Comments

              The timezone is expected to be specified or implied by the context this datatype is used.

              Control0..1
              This element is affected by the following invariants: av-1
              Typetime
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              The closing time of day. Note: If the AllDay flag is set, then this time is ignored.

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

              Not available during this time due to provided reason.

              ShortNot available during this time due to provided reason
              Control0..*
              TypeElement
              Is Modifierfalse
              Summarytrue
              Requirements

              The {item} is not available during this period of time due to the provided reason.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              108. HealthcareService.availability.notAvailableTime.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
              This element is affected by the following invariants: ele-1
              Typestring
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              110. HealthcareService.availability.notAvailableTime.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 managable, 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 HealthcareService.availability.notAvailableTime.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 112. HealthcareService.availability.notAvailableTime.description
                Definition

                Reason presented to the user explaining why time not available.

                ShortReason presented to the user explaining why time not available
                Comments

                The reason will generally be provided to give the textual reason for displaying when the {item} is not available, e.g. 'Closed public holidays' or 'Independence Day'. In cases such as this, the during might not be included and local knowledge would be required in such cases (as don't desire to keep updating when the holiday occurs each year).

                e.g.2: 'Closed for maintenance over the summer' for this example you would want to include the during period, unless this was a university hospital and the "summer" period was well known, but would recommend its inclusion anyway.

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

                The reason that can be presented to the user as to why this time is not available.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                114. HealthcareService.availability.notAvailableTime.during
                Definition

                Service not available during this period.

                ShortService not available during this period
                Control0..1
                TypePeriod
                Is Modifierfalse
                Summarytrue
                Requirements

                The {item} is not available (seasonally or for a public holiday) during this period.

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

                Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.

                ShortTechnical endpoints providing access to electronic services operated for the healthcare service
                Control0..*
                TypeReference(Endpoint)
                Is Modifierfalse
                Must Supportfalse
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))