This page is part of the FHIR Specification (v0.5.0: DSTU 2 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
StructureDefinition for healthcareservice
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="HealthcareService"/> <meta> <lastUpdated value="2015-04-03T14:24:32.000+11:00"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div> </text> <url value="http://hl7.org/fhir/StructureDefinition/HealthcareService"/> <name value="HealthcareService"/> <publisher value="HL7 FHIR Project (Patient Administration)"/> <contact> <telecom> <system value="url"/> <value value="http://hl7.org/fhir"/> </telecom> </contact> <contact> <telecom> <system value="url"/> <value value="http://www.hl7.org/Special/committees/pafm/index.cfm"/> </telecom> </contact> <description value="Base StructureDefinition for HealthcareService Resource"/> <status value="draft"/> <date value="2015-04-03T14:24:32+11:00"/> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <type value="resource"/> <abstract value="true"/> <snapshot> <element> <path value="HealthcareService"/> <short value="The details of a Healthcare Service available at a location"/> <definition value="The details of a Healthcare Service available at a location."/> <min value="1"/> <max value="1"/> <type> <code value="DomainResource"/> </type> </element> <element> <path value="HealthcareService.id"/> <short value="Logical id of this artefact"/> <definition value="The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes."/> <comments value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID."/> <min value="0"/> <max value="1"/> <type> <code value="id"/> </type> </element> <element> <path value="HealthcareService.meta"/> <short value="Metadata about the resource"/> <definition value="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."/> <min value="0"/> <max value="1"/> <type> <code value="Meta"/> </type> </element> <element> <path value="HealthcareService.implicitRules"/> <short value="A set of rules under which this content was created"/> <definition value="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content."/> <comments value="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 as much as possible."/> <min value="0"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="true"/> </element> <element> <path value="HealthcareService.language"/> <short value="Language of the resource content"/> <definition value="The base language in which the resource is written."/> <comments value="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)."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <binding> <name value="Language"/> <strength value="required"/> <description value="A human language"/> <valueSetUri value="http://tools.ietf.org/html/bcp47"/> </binding> </element> <element> <path value="HealthcareService.text"/> <short value="Text summary of the resource, for human interpretation"/> <definition value="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."/> <comments value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <alias value="narrative"/> <alias value="html"/> <alias value="xhtml"/> <alias value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <condition value="dom-1"/> <mapping> <identity value="rim"/> <map value="Act.text?"/> </mapping> </element> <element> <path value="HealthcareService.contained"/> <short value="Contained, inline Resources"/> <definition value="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."/> <comments value="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."/> <alias value="inline resources"/> <alias value="anonymous resources"/> <alias value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="HealthcareService.extension"/> <short value="Additional Content defined by implementations"/> <definition value="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."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="HealthcareService.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="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."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="HealthcareService.identifier"/> <short value="External Identifiers for this item"/> <definition value="External Identifiers for this item."/> <min value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> </element> <element> <path value="HealthcareService.providedBy"/> <short value="The organization that provides this Healthcare Service"/> <definition value="The organization that provides this Healthcare Service."/> <comments value="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."/> <min value="0"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Organization"/> </type> <isSummary value="true"/> </element> <element> <path value="HealthcareService.location"/> <short value="The location where this healthcare service may be provided"/> <definition value="The location where this healthcare service may be provided."/> <min value="1"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Location"/> </type> <isSummary value="true"/> </element> <element> <path value="HealthcareService.serviceCategory"/> <short value="Identifies the broad category of service being performed or delivered. Selecting a Service Category then determines the list of relevant service types that can be selected in the Primary Service Type"/> <definition value="Identifies the broad category of service being performed or delivered. Selecting a Service Category then determines the list of relevant service types that can be selected in the Primary Service Type."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> </element> <element> <path value="HealthcareService.serviceType"/> <short value="A specific type of service that may be delivered or performed"/> <definition value="A specific type of service that may be delivered or performed."/> <min value="0"/> <max value="*"/> <isSummary value="true"/> </element> <element> <path value="HealthcareService.serviceType.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="HealthcareService.serviceType.extension"/> <short value="Additional Content defined by implementations"/> <definition value="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."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="HealthcareService.serviceType.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="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 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."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="HealthcareService.serviceType.type"/> <short value="The specific type of service being delivered or performed"/> <definition value="The specific type of service being delivered or performed."/> <comments value="Change to serviceType?"/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <name value="DocumentC80PracticeSetting"/> <strength value="preferred"/> <description value="Additional details about where the content was created (e.g. clinical specialty)"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/c80-practice-codes"/> </valueSetReference> </binding> </element> <element> <path value="HealthcareService.serviceType.specialty"/> <short value="Collection of Specialties handled by the Service Site. This is more of a Medical Term"/> <definition value="Collection of Specialties handled by the Service Site. This is more of a Medical Term."/> <min value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> </element> <element> <path value="HealthcareService.serviceName"/> <short value="Further description of the service as it would be presented to a consumer while searching"/> <definition value="Further description of the service as it would be presented to a consumer while searching."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isSummary value="true"/> </element> <element> <path value="HealthcareService.comment"/> <short value="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"/> <definition value="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."/> <comments value="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."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isSummary value="true"/> </element> <element> <path value="HealthcareService.extraDetails"/> <short value="Extra details about the service that can't be placed in the other fields"/> <definition value="Extra details about the service that can't be placed in the other fields."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="HealthcareService.photo"/> <short value="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"/> <definition value="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."/> <min value="0"/> <max value="1"/> <type> <code value="Attachment"/> </type> <isSummary value="true"/> </element> <element> <path value="HealthcareService.telecom"/> <short value="List of contacts related to this specific healthcare service. If this is empty, then refer to the location's contacts"/> <definition value="List of contacts related to this specific healthcare service. If this is empty, then refer to the location's contacts."/> <min value="0"/> <max value="*"/> <type> <code value="ContactPoint"/> </type> </element> <element> <path value="HealthcareService.coverageArea"/> <short value="The location(s) that this service is available to (not where the service is provided)"/> <definition value="The location(s) that this service is available to (not where the service is provided)."/> <comments value="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"."/> <min value="0"/> <max value="*"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Location"/> </type> </element> <element> <path value="HealthcareService.serviceProvisionCode"/> <short value="The code(s) that detail the conditions under which the healthcare service is available/offered"/> <definition value="The code(s) that detail the conditions under which the healthcare service is available/offered."/> <comments value="The provision means being commissioned by, contractually obliged, 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."/> <min value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <binding> <name value="ServiceProvisionConditions"/> <strength value="example"/> <description value="The code(s) that detail the conditions under which the healthcare service is available/offered"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/service-provision-conditions"/> </valueSetReference> </binding> </element> <element> <path value="HealthcareService.eligibility"/> <short value="Does this service have specific eligibility requirements that need to be met in order to use the service"/> <definition value="Does this service have specific eligibility requirements that need to be met in order to use the service."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> </element> <element> <path value="HealthcareService.eligibilityNote"/> <short value="Describes the eligibility conditions for the service"/> <definition value="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."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="HealthcareService.programName"/> <short value="Program Names that can be used to categorize the service"/> <definition value="Program Names that can be used to categorize the service."/> <comments value="Programs are often defined externally to an Organization, commonly by governments. E.g. Home and Community Care Programs, Homeless Program, …."/> <min value="0"/> <max value="*"/> <type> <code value="string"/> </type> </element> <element> <path value="HealthcareService.characteristic"/> <short value="Collection of Characteristics (attributes)"/> <definition value="Collection of Characteristics (attributes)."/> <comments value="These could be such things as is wheelchair accessible."/> <min value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> </element> <element> <path value="HealthcareService.referralMethod"/> <short value="Ways that the service accepts referrals"/> <definition value="Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required."/> <min value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <binding> <name value="ReferralMethod"/> <strength value="example"/> <description value="The methods of referral can be used when referring to a specific HealthCareService resource"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/service-referral-method"/> </valueSetReference> </binding> </element> <element> <path value="HealthcareService.publicKey"/> <short value="The public part of the 'keys' allocated to an Organization by an accredited body to support secure exchange of data over the internet. To be provided by the Organization, where available"/> <definition value="The public part of the 'keys' allocated to an Organization by an accredited body to support secure exchange of data over the internet. To be provided by the Organization, where available."/> <comments value="Note: This is a base64 encoded digital certificate."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="HealthcareService.appointmentRequired"/> <short value="Indicates if an appointment is required for access to this service"/> <definition value="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."/> <min value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> </element> <element> <path value="HealthcareService.availableTime"/> <short value="A Collection of times that the Service Site is available"/> <definition value="A Collection of times that the Service Site is available."/> <comments value="More detailed availability information may be provided in associated Schedule/Slot resources."/> <min value="0"/> <max value="*"/> </element> <element> <path value="HealthcareService.availableTime.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="HealthcareService.availableTime.extension"/> <short value="Additional Content defined by implementations"/> <definition value="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."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="HealthcareService.availableTime.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="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 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."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="HealthcareService.availableTime.daysOfWeek"/> <short value="mon | tue | wed | thu | fri | sat | sun"/> <definition value="Indicates which Days of the week are available between the Start and End Times."/> <min value="0"/> <max value="*"/> <type> <code value="code"/> </type> <binding> <name value="DaysOfWeek"/> <strength value="required"/> <description value="The days of the week"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/days-of-week"/> </valueSetReference> </binding> </element> <element> <path value="HealthcareService.availableTime.allDay"/> <short value="Is this always available? (hence times are irrelevant) e.g. 24 hour service"/> <definition value="Is this always available? (hence times are irrelevant) e.g. 24 hour service."/> <min value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> </element> <element> <path value="HealthcareService.availableTime.availableStartTime"/> <short value="The opening time of day. Note: If the AllDay flag is set, then this time is ignored"/> <definition value="The opening time of day. Note: If the AllDay flag is set, then this time is ignored."/> <comments value="The timezone is expected to be that of the location this HealthcareService is provided at."/> <min value="0"/> <max value="1"/> <type> <code value="time"/> </type> </element> <element> <path value="HealthcareService.availableTime.availableEndTime"/> <short value="The closing time of day. Note: If the AllDay flag is set, then this time is ignored"/> <definition value="The closing time of day. Note: If the AllDay flag is set, then this time is ignored."/> <comments value="The timezone is expected to be that of the location this HealthcareService is provided at."/> <min value="0"/> <max value="1"/> <type> <code value="time"/> </type> </element> <element> <path value="HealthcareService.notAvailable"/> <short value="The HealthcareService is not available during this period of time due to the provided reason"/> <definition value="The HealthcareService is not available during this period of time due to the provided reason."/> <min value="0"/> <max value="*"/> </element> <element> <path value="HealthcareService.notAvailable.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="HealthcareService.notAvailable.extension"/> <short value="Additional Content defined by implementations"/> <definition value="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."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="HealthcareService.notAvailable.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="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 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."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="HealthcareService.notAvailable.description"/> <short value="The reason that can be presented to the user as to why this time is not available"/> <definition value="The reason that can be presented to the user as to why this time is not available."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="HealthcareService.notAvailable.during"/> <short value="Service is not available (seasonally or for a public holiday) from this date"/> <definition value="Service is not available (seasonally or for a public holiday) from this date."/> <min value="0"/> <max value="1"/> <type> <code value="Period"/> </type> </element> <element> <path value="HealthcareService.availabilityExceptions"/> <short value="A description of Site availability exceptions, e.g., public holiday availability. Succinctly describing all possible exceptions to normal Site availability as details in the Available Times and Not Available Times"/> <definition value="A description of Site availability exceptions, e.g., public holiday availability. Succinctly describing all possible exceptions to normal Site availability as details in the Available Times and Not Available Times."/> <comments value="(May contain HTML formatted text)."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> </element> </snapshot> <differential> <element> <path value="HealthcareService"/> <short value="The details of a Healthcare Service available at a location"/> <definition value="The details of a Healthcare Service available at a location."/> <min value="1"/> <max value="1"/> <type> <code value="DomainResource"/> </type> </element> <element> <path value="HealthcareService.identifier"/> <short value="External Identifiers for this item"/> <definition value="External Identifiers for this item."/> <min value="0"/> <max value="*"/> <type> <code value="Identifier"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> </element> <element> <path value="HealthcareService.providedBy"/> <short value="The organization that provides this Healthcare Service"/> <definition value="The organization that provides this Healthcare Service."/> <comments value="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."/> <min value="0"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Organization"/> </type> <isSummary value="true"/> </element> <element> <path value="HealthcareService.location"/> <short value="The location where this healthcare service may be provided"/> <definition value="The location where this healthcare service may be provided."/> <min value="1"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Location"/> </type> <isSummary value="true"/> </element> <element> <path value="HealthcareService.serviceCategory"/> <short value="Identifies the broad category of service being performed or delivered. Selecting a Service Category then determines the list of relevant service types that can be selected in the Primary Service Type"/> <definition value="Identifies the broad category of service being performed or delivered. Selecting a Service Category then determines the list of relevant service types that can be selected in the Primary Service Type."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> </element> <element> <path value="HealthcareService.serviceType"/> <short value="A specific type of service that may be delivered or performed"/> <definition value="A specific type of service that may be delivered or performed."/> <min value="0"/> <max value="*"/> <isSummary value="true"/> </element> <element> <path value="HealthcareService.serviceType.type"/> <short value="The specific type of service being delivered or performed"/> <definition value="The specific type of service being delivered or performed."/> <comments value="Change to serviceType?"/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <name value="DocumentC80PracticeSetting"/> <strength value="preferred"/> <description value="Additional details about where the content was created (e.g. clinical specialty)"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/c80-practice-codes"/> </valueSetReference> </binding> </element> <element> <path value="HealthcareService.serviceType.specialty"/> <short value="Collection of Specialties handled by the Service Site. This is more of a Medical Term"/> <definition value="Collection of Specialties handled by the Service Site. This is more of a Medical Term."/> <min value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> </element> <element> <path value="HealthcareService.serviceName"/> <short value="Further description of the service as it would be presented to a consumer while searching"/> <definition value="Further description of the service as it would be presented to a consumer while searching."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isSummary value="true"/> </element> <element> <path value="HealthcareService.comment"/> <short value="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"/> <definition value="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."/> <comments value="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."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <isSummary value="true"/> </element> <element> <path value="HealthcareService.extraDetails"/> <short value="Extra details about the service that can't be placed in the other fields"/> <definition value="Extra details about the service that can't be placed in the other fields."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="HealthcareService.photo"/> <short value="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"/> <definition value="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."/> <min value="0"/> <max value="1"/> <type> <code value="Attachment"/> </type> <isSummary value="true"/> </element> <element> <path value="HealthcareService.telecom"/> <short value="List of contacts related to this specific healthcare service. If this is empty, then refer to the location's contacts"/> <definition value="List of contacts related to this specific healthcare service. If this is empty, then refer to the location's contacts."/> <min value="0"/> <max value="*"/> <type> <code value="ContactPoint"/> </type> </element> <element> <path value="HealthcareService.coverageArea"/> <short value="The location(s) that this service is available to (not where the service is provided)"/> <definition value="The location(s) that this service is available to (not where the service is provided)."/> <comments value="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"."/> <min value="0"/> <max value="*"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Location"/> </type> </element> <element> <path value="HealthcareService.serviceProvisionCode"/> <short value="The code(s) that detail the conditions under which the healthcare service is available/offered"/> <definition value="The code(s) that detail the conditions under which the healthcare service is available/offered."/> <comments value="The provision means being commissioned by, contractually obliged, 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."/> <min value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <binding> <name value="ServiceProvisionConditions"/> <strength value="example"/> <description value="The code(s) that detail the conditions under which the healthcare service is available/offered"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/service-provision-conditions"/> </valueSetReference> </binding> </element> <element> <path value="HealthcareService.eligibility"/> <short value="Does this service have specific eligibility requirements that need to be met in order to use the service"/> <definition value="Does this service have specific eligibility requirements that need to be met in order to use the service."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> </element> <element> <path value="HealthcareService.eligibilityNote"/> <short value="Describes the eligibility conditions for the service"/> <definition value="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."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="HealthcareService.programName"/> <short value="Program Names that can be used to categorize the service"/> <definition value="Program Names that can be used to categorize the service."/> <comments value="Programs are often defined externally to an Organization, commonly by governments. E.g. Home and Community Care Programs, Homeless Program, …."/> <min value="0"/> <max value="*"/> <type> <code value="string"/> </type> </element> <element> <path value="HealthcareService.characteristic"/> <short value="Collection of Characteristics (attributes)"/> <definition value="Collection of Characteristics (attributes)."/> <comments value="These could be such things as is wheelchair accessible."/> <min value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> </element> <element> <path value="HealthcareService.referralMethod"/> <short value="Ways that the service accepts referrals"/> <definition value="Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required."/> <min value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <binding> <name value="ReferralMethod"/> <strength value="example"/> <description value="The methods of referral can be used when referring to a specific HealthCareService resource"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/service-referral-method"/> </valueSetReference> </binding> </element> <element> <path value="HealthcareService.publicKey"/> <short value="The public part of the 'keys' allocated to an Organization by an accredited body to support secure exchange of data over the internet. To be provided by the Organization, where available"/> <definition value="The public part of the 'keys' allocated to an Organization by an accredited body to support secure exchange of data over the internet. To be provided by the Organization, where available."/> <comments value="Note: This is a base64 encoded digital certificate."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="HealthcareService.appointmentRequired"/> <short value="Indicates if an appointment is required for access to this service"/> <definition value="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."/> <min value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> </element> <element> <path value="HealthcareService.availableTime"/> <short value="A Collection of times that the Service Site is available"/> <definition value="A Collection of times that the Service Site is available."/> <comments value="More detailed availability information may be provided in associated Schedule/Slot resources."/> <min value="0"/> <max value="*"/> </element> <element> <path value="HealthcareService.availableTime.daysOfWeek"/> <short value="mon | tue | wed | thu | fri | sat | sun"/> <definition value="Indicates which Days of the week are available between the Start and End Times."/> <min value="0"/> <max value="*"/> <type> <code value="code"/> </type> <binding> <name value="DaysOfWeek"/> <strength value="required"/> <description value="The days of the week"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/days-of-week"/> </valueSetReference> </binding> </element> <element> <path value="HealthcareService.availableTime.allDay"/> <short value="Is this always available? (hence times are irrelevant) e.g. 24 hour service"/> <definition value="Is this always available? (hence times are irrelevant) e.g. 24 hour service."/> <min value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> </element> <element> <path value="HealthcareService.availableTime.availableStartTime"/> <short value="The opening time of day. Note: If the AllDay flag is set, then this time is ignored"/> <definition value="The opening time of day. Note: If the AllDay flag is set, then this time is ignored."/> <comments value="The timezone is expected to be that of the location this HealthcareService is provided at."/> <min value="0"/> <max value="1"/> <type> <code value="time"/> </type> </element> <element> <path value="HealthcareService.availableTime.availableEndTime"/> <short value="The closing time of day. Note: If the AllDay flag is set, then this time is ignored"/> <definition value="The closing time of day. Note: If the AllDay flag is set, then this time is ignored."/> <comments value="The timezone is expected to be that of the location this HealthcareService is provided at."/> <min value="0"/> <max value="1"/> <type> <code value="time"/> </type> </element> <element> <path value="HealthcareService.notAvailable"/> <short value="The HealthcareService is not available during this period of time due to the provided reason"/> <definition value="The HealthcareService is not available during this period of time due to the provided reason."/> <min value="0"/> <max value="*"/> </element> <element> <path value="HealthcareService.notAvailable.description"/> <short value="The reason that can be presented to the user as to why this time is not available"/> <definition value="The reason that can be presented to the user as to why this time is not available."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="HealthcareService.notAvailable.during"/> <short value="Service is not available (seasonally or for a public holiday) from this date"/> <definition value="Service is not available (seasonally or for a public holiday) from this date."/> <min value="0"/> <max value="1"/> <type> <code value="Period"/> </type> </element> <element> <path value="HealthcareService.availabilityExceptions"/> <short value="A description of Site availability exceptions, e.g., public holiday availability. Succinctly describing all possible exceptions to normal Site availability as details in the Available Times and Not Available Times"/> <definition value="A description of Site availability exceptions, e.g., public holiday availability. Succinctly describing all possible exceptions to normal Site availability as details in the Available Times and Not Available Times."/> <comments value="(May contain HTML formatted text)."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> </element> </differential> </StructureDefinition>
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.