ITB - Online appointment booking service, published by Service Well AB. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/servicewell/servicewell.fhir.wof-portal/ and changes regularly. See the Directory of published versions
| Active as of 2026-04-20 |
Definitions for the wof-base-healthcare-service 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. | ||||
| Short | The details of a healthcare service available at a location | ||||
| Control | 0..* | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) | ||||
| 2. HealthcareService.id | |||||
| Definition | The logical id of this WofBaseHealthcareService resource. It identifies the specific care offering location instance within the portal. The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
| Short | Stable logical identifier for the healthcare serviceLogical id of this artifact | ||||
| Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
| Control | 0..1 | ||||
| Type | idstring | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| 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. | ||||
| Short | Metadata about the resource | ||||
| Control | 0..1 | ||||
| Type | Meta | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 6. HealthcareService.meta.versionId | |||||
| Definition | The technical resource version supplied by the server for change tracking of this specific WofBaseHealthcareService instance. The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. | ||||
| Short | Server-managed resource versionVersion specific identifier | ||||
| Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Obligations |
| ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 8. HealthcareService.meta.profile | |||||
| Definition | Identifies that the resource conforms to WofBaseHealthcareService so clients can safely process it as the WOF Portal service concept profile. A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. | ||||
| Short | Profile declaration for this portal resourceProfiles this resource claims to conform to | ||||
| Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. | ||||
| Control | 10..* | ||||
| Type | canonical(StructureDefinition) | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Obligations |
| ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 10. 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. | ||||
| Short | A set of rules under which this content was created | ||||
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||
| Control | 0..01 | ||||
| Type | uri | ||||
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 12. HealthcareService.contained | |||||
| Definition | Inline resources, such as a location, that are packaged together with the healthcare service example or representation. 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. | ||||
| Short | Contained resources used by the healthcare serviceContained, 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. | ||||
| Control | 0..* | ||||
| Type | Resource | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | inline resources, anonymous resources, contained resources | ||||
| 14. 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | ExtensionAdditional 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | 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()) | ||||
| Slicing | This element introduces a set of slices on HealthcareService.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 16. HealthcareService.extension:clinicInfo | |||||
| Slice Name | clinicInfo | ||||
| Definition | Portal-specific clinic information such as URL placeholder, directions, parking, about text, spoken languages, and booking summary information text. | ||||
| Short | Grouped clinic presentation information | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(Clinic Info) (Complex Extension) | ||||
| Is Modifier | false | ||||
| Invariants | 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()) | ||||
| 18. HealthcareService.extension:bookingRules | |||||
| Slice Name | bookingRules | ||||
| Definition | Container for healthcare-service-specific supporting payloads, including reusable booking-rules configuration. | ||||
| Short | Grouped booking-related attachments | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(Booking Rules) (Complex Extension) | ||||
| Is Modifier | false | ||||
| Invariants | 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()) | ||||
| 20. HealthcareService.modifierExtension | |||||
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | ExtensionExtensions 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. | ||||
| Control | 0..0* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||
| Summary | false | ||||
| 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 Names | extensions, user content | ||||
| Invariants | 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()) | ||||
| 22. HealthcareService.active | |||||
| Definition | Indicates whether the healthcare service is active and should be considered available for use in the portal context. 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. | ||||
| Short | Whether the healthcare service is activeWhether 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. | ||||
| Control | 10..1 | ||||
| Type | boolean | ||||
| Is Modifier | true 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 Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 24. HealthcareService.providedBy | |||||
| Definition | Reference to the top-level owning ServiceProviderPortal organization that owns the configuration, endpoints, and service structure for the customer, and is responsible for the healthcare service shown in the portal. The organization that provides this healthcare service. | ||||
| Short | Organization responsible for the healthcare serviceOrganization 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. | ||||
| Control | 0..1 | ||||
| Type | Reference(Organization) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 26. HealthcareService.category | |||||
| Definition | Identifies the broad category of service being performed or delivered. | ||||
| Short | Broad 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. | ||||
| Control | 0..0* | ||||
| Binding | For example codes, see ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-category|4.0.1 (example to http://hl7.org/fhir/ValueSet/service-category|4.0.1)A category of the service(s) that could be provided. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Alternate Names | service category | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 28. HealthcareService.type | |||||
| Definition | The specific type of service that may be delivered or performed. | ||||
| Short | Type of service that may be delivered or performed | ||||
| Control | 0..0* | ||||
| Binding | For example codes, see ServiceTypehttp://hl7.org/fhir/ValueSet/service-type|4.0.1 (example to http://hl7.org/fhir/ValueSet/service-type|4.0.1)Additional details about where the content was created (e.g. clinical specialty). | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Alternate Names | service type | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 30. HealthcareService.specialty | |||||
| Definition | Collection of specialties handled by the service site. This is more of a medical term. | ||||
| Short | Specialties handled by the HealthcareService | ||||
| Control | 0..0* | ||||
| Binding | The codes SHOULD be taken from PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes|4.0.1 (preferred to http://hl7.org/fhir/ValueSet/c80-practice-codes|4.0.1)A specialty that a healthcare service may provide. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 32. HealthcareService.location | |||||
| Definition | Reference to the single contained HealthcareServiceLocation instance that holds the clinic address for this healthcare service. The location(s) where this healthcare service may be provided. | ||||
| Short | Contained address for the healthcare serviceLocation(s) where service may be provided | ||||
| Control | 10..* | ||||
| Type | Reference(Location) | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 34. HealthcareService.name | |||||
| Definition | The human-readable name used to present the healthcare service in the portal. Further description of the service as it would be presented to a consumer while searching. | ||||
| Short | Display name of the healthcare serviceDescription of service as presented to a consumer while searching | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 36. HealthcareService.extraDetails | |||||
| Definition | Extra details about the service that can't be placed in the other fields. | ||||
| Short | Extra details about the service that can't be placed in the other fields | ||||
| Control | 0..01 | ||||
| Type | markdown | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 38. HealthcareService.photo | |||||
| Definition | Attachment carrying binary image data that represents the healthcare service in the portal. 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. | ||||
| Short | Image representing the healthcare serviceFacilitates quick identification of the service | ||||
| Control | 0..1 | ||||
| Type | Attachment | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 40. HealthcareService.telecom | |||||
| Definition | Contact points such as phone, URL, or email used to reach the healthcare service. List of contacts related to this specific healthcare service. | ||||
| Short | Portal contact details for the healthcare serviceContacts related to the healthcare service | ||||
| Comments | If this is empty, then refer to the location's contacts. | ||||
| Control | 0..* | ||||
| Type | ContactPoint | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 42. HealthcareService.telecom.system | |||||
| Definition | The contact point system, for example phone, url, or email. Telecommunications form for contact point - what communications system is required to make use of the contact. | ||||
| Short | Type of contact pointphone | fax | email | pager | url | sms | other | ||||
| Control | 0..1 This element is affected by the following invariants: cpt-2 | ||||
| Binding | The codes SHALL be taken from ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)Telecommunications form for contact point. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 44. HealthcareService.telecom.value | |||||
| Definition | The phone number, URL, or email address for the contact point. The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). | ||||
| Short | Actual contact valueThe actual contact point details | ||||
| Comments | Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to support legacy numbers that are not in a tightly controlled format. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 46. HealthcareService.telecom.use | |||||
| Definition | The intended usage for the contact point, such as work. Identifies the purpose for the contact point. | ||||
| Short | Usage context for the contact pointhome | work | temp | old | mobile - purpose of this contact point | ||||
| Comments | Applications can assume that a contact is current unless it explicitly says that it is temporary or old. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1)Use of contact point. | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 48. HealthcareService.telecom.rank | |||||
| Definition | Specifies the preferred order in which the listed contact points should be used. Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. | ||||
| Short | Priority order of contact pointsSpecify preferred order of use (1 = highest) | ||||
| Comments | Note that rank does not necessarily follow the order in which the contacts are represented in the instance. | ||||
| Control | 0..1 | ||||
| Type | positiveInt | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 50. HealthcareService.coverageArea | |||||
| Definition | The location(s) that this service is available to (not where the service is provided). | ||||
| Short | Location(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". | ||||
| Control | 0..0* | ||||
| Type | Reference(Location) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 52. HealthcareService.serviceProvisionCode | |||||
| Definition | The code(s) that detail the conditions under which the healthcare service is available/offered. | ||||
| Short | Conditions 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. | ||||
| Control | 0..0* | ||||
| Binding | For example codes, see ServiceProvisionConditionshttp://hl7.org/fhir/ValueSet/service-provision-conditions|4.0.1 (example to http://hl7.org/fhir/ValueSet/service-provision-conditions|4.0.1)The code(s) that detail the conditions under which the healthcare service is available/offered. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 54. HealthcareService.eligibility | |||||
| Definition | Does this service have specific eligibility requirements that need to be met in order to use the service? | ||||
| Short | Specific eligibility requirements required to use the service | ||||
| Control | 0..0* | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 57. HealthcareService.program | |||||
| Definition | Programs that this service is applicable to. | ||||
| Short | Programs 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, …. | ||||
| Control | 0..0* | ||||
| Binding | For example codes, see Programhttp://hl7.org/fhir/ValueSet/program|4.0.1 (example to http://hl7.org/fhir/ValueSet/program|4.0.1)Government or local programs that this service applies to. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 59. 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. | ||||
| Short | The 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. | ||||
| Control | 0..0* | ||||
| Binding | The codes SHOULD be taken from CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1 (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)A human language.
| ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 61. HealthcareService.referralMethod | |||||
| Definition | Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required. | ||||
| Short | Ways that the service accepts referrals | ||||
| Control | 0..0* | ||||
| Binding | For example codes, see ReferralMethodhttp://hl7.org/fhir/ValueSet/service-referral-method|4.0.1 (example to http://hl7.org/fhir/ValueSet/service-referral-method|4.0.1)The methods of referral can be used when referring to a specific HealthCareService resource. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 63. 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. | ||||
| Short | If an appointment is required for access to this service | ||||
| Control | 0..01 | ||||
| Type | boolean | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 65. HealthcareService.availableTime | |||||
| Definition | Opening hours and other published availability windows for when the healthcare service is available in the portal. A collection of times that the Service Site is available. | ||||
| Short | Opening hours and availability windowsTimes the Service Site is available | ||||
| Comments | More detailed availability information may be provided in associated Schedule/Slot resources. | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 67. HealthcareService.availableTime.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| 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 Names | extensions, user content, modifiers | ||||
| Invariants | 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()) | ||||
| 69. HealthcareService.notAvailable | |||||
| Definition | The HealthcareService is not available during this period of time due to the provided reason. | ||||
| Short | Not available during this time due to provided reason | ||||
| Control | 0..0* | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 73. HealthcareService.availabilityExceptions | |||||
| Definition | 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. | ||||
| Short | Description of availability exceptions | ||||
| Control | 0..01 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 75. HealthcareService.endpoint | |||||
| Definition | Technical endpoints providing access to services operated for the specific healthcare services defined at this resource. | ||||
| Short | Technical endpoints providing access to electronic services operated for the healthcare service | ||||
| Control | 0..0* | ||||
| Type | Reference(Endpoint) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | 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.id | |||||
| Definition | The logical id of this WofBaseHealthcareService resource. It identifies the specific care offering location instance within the portal. | ||||
| Short | Stable logical identifier for the healthcare service | ||||
| 4. HealthcareService.meta | |||||
| 6. HealthcareService.meta.versionId | |||||
| Definition | The technical resource version supplied by the server for change tracking of this specific WofBaseHealthcareService instance. | ||||
| Short | Server-managed resource version | ||||
| Must Support | true | ||||
| Obligations |
| ||||
| 8. HealthcareService.meta.profile | |||||
| Definition | Identifies that the resource conforms to WofBaseHealthcareService so clients can safely process it as the WOF Portal service concept profile. | ||||
| Short | Profile declaration for this portal resource | ||||
| Control | 1..? | ||||
| Must Support | true | ||||
| Obligations |
| ||||
| 10. HealthcareService.implicitRules | |||||
| Control | 0..0 | ||||
| 12. HealthcareService.contained | |||||
| Definition | Inline resources, such as a location, that are packaged together with the healthcare service example or representation. | ||||
| Short | Contained resources used by the healthcare service | ||||
| 14. HealthcareService.extension | |||||
| Slicing | This element introduces a set of slices on HealthcareService.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 16. HealthcareService.extension:clinicInfo | |||||
| Slice Name | clinicInfo | ||||
| Definition | Portal-specific clinic information such as URL placeholder, directions, parking, about text, spoken languages, and booking summary information text. | ||||
| Short | Grouped clinic presentation information | ||||
| Control | 0..1 | ||||
| Type | Extension(Clinic Info) (Complex Extension) | ||||
| 18. HealthcareService.extension:bookingRules | |||||
| Slice Name | bookingRules | ||||
| Definition | Container for healthcare-service-specific supporting payloads, including reusable booking-rules configuration. | ||||
| Short | Grouped booking-related attachments | ||||
| Control | 0..1 | ||||
| Type | Extension(Booking Rules) (Complex Extension) | ||||
| 20. HealthcareService.modifierExtension | |||||
| Control | 0..0 | ||||
| 22. HealthcareService.active | |||||
| Definition | Indicates whether the healthcare service is active and should be considered available for use in the portal context. | ||||
| Short | Whether the healthcare service is active | ||||
| Control | 1..? | ||||
| 24. HealthcareService.providedBy | |||||
| Definition | Reference to the top-level owning ServiceProviderPortal organization that owns the configuration, endpoints, and service structure for the customer, and is responsible for the healthcare service shown in the portal. | ||||
| Short | Organization responsible for the healthcare service | ||||
| Must Support | true | ||||
| 26. HealthcareService.category | |||||
| Control | 0..0 | ||||
| 28. HealthcareService.type | |||||
| Control | 0..0 | ||||
| 30. HealthcareService.specialty | |||||
| Control | 0..0 | ||||
| 32. HealthcareService.location | |||||
| Definition | Reference to the single contained HealthcareServiceLocation instance that holds the clinic address for this healthcare service. | ||||
| Short | Contained address for the healthcare service | ||||
| Control | 1..? | ||||
| 34. HealthcareService.name | |||||
| Definition | The human-readable name used to present the healthcare service in the portal. | ||||
| Short | Display name of the healthcare service | ||||
| Must Support | true | ||||
| 36. HealthcareService.extraDetails | |||||
| Control | 0..0 | ||||
| 38. HealthcareService.photo | |||||
| Definition | Attachment carrying binary image data that represents the healthcare service in the portal. | ||||
| Short | Image representing the healthcare service | ||||
| 40. HealthcareService.telecom | |||||
| Definition | Contact points such as phone, URL, or email used to reach the healthcare service. | ||||
| Short | Portal contact details for the healthcare service | ||||
| 42. HealthcareService.telecom.system | |||||
| Definition | The contact point system, for example phone, url, or email. | ||||
| Short | Type of contact point | ||||
| 44. HealthcareService.telecom.value | |||||
| Definition | The phone number, URL, or email address for the contact point. | ||||
| Short | Actual contact value | ||||
| 46. HealthcareService.telecom.use | |||||
| Definition | The intended usage for the contact point, such as work. | ||||
| Short | Usage context for the contact point | ||||
| 48. HealthcareService.telecom.rank | |||||
| Definition | Specifies the preferred order in which the listed contact points should be used. | ||||
| Short | Priority order of contact points | ||||
| 50. HealthcareService.coverageArea | |||||
| Control | 0..0 | ||||
| 52. HealthcareService.serviceProvisionCode | |||||
| Control | 0..0 | ||||
| 54. HealthcareService.eligibility | |||||
| Control | 0..0 | ||||
| 56. HealthcareService.program | |||||
| Control | 0..0 | ||||
| 58. HealthcareService.communication | |||||
| Control | 0..0 | ||||
| 60. HealthcareService.referralMethod | |||||
| Control | 0..0 | ||||
| 62. HealthcareService.appointmentRequired | |||||
| Control | 0..0 | ||||
| 64. HealthcareService.availableTime | |||||
| Definition | Opening hours and other published availability windows for when the healthcare service is available in the portal. | ||||
| Short | Opening hours and availability windows | ||||
| 66. HealthcareService.notAvailable | |||||
| Control | 0..0 | ||||
| 68. HealthcareService.availabilityExceptions | |||||
| Control | 0..0 | ||||
| 70. HealthcareService.endpoint | |||||
| Control | 0..0 | ||||
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. | ||||
| Short | The details of a healthcare service available at a location | ||||
| Control | 0..* | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource ( contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())dom-5: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty())dom-6: A resource should have narrative for robust management ( text.`div`.exists()) | ||||
| 2. HealthcareService.id | |||||
| Definition | The logical id of this WofBaseHealthcareService resource. It identifies the specific care offering location instance within the portal. | ||||
| Short | Stable logical identifier for the healthcare service | ||||
| Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| 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. | ||||
| Short | Metadata about the resource | ||||
| Control | 0..1 | ||||
| Type | Meta | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 6. HealthcareService.meta.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 8. HealthcareService.meta.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | 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()) | ||||
| Slicing | This element introduces a set of slices on HealthcareService.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 10. HealthcareService.meta.versionId | |||||
| Definition | The technical resource version supplied by the server for change tracking of this specific WofBaseHealthcareService instance. | ||||
| Short | Server-managed resource version | ||||
| Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Obligations |
| ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 12. HealthcareService.meta.lastUpdated | |||||
| Definition | When the resource last changed - e.g. when the version changed. | ||||
| Short | When the resource version last changed | ||||
| Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction. | ||||
| Control | 0..1 | ||||
| Type | instant | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 14. HealthcareService.meta.source | |||||
| Definition | A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. | ||||
| Short | Identifies where the resource comes from | ||||
| Comments | In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 16. HealthcareService.meta.profile | |||||
| Definition | Identifies that the resource conforms to WofBaseHealthcareService so clients can safely process it as the WOF Portal service concept profile. | ||||
| Short | Profile declaration for this portal resource | ||||
| Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. | ||||
| Control | 1..* | ||||
| Type | canonical(StructureDefinition) | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Obligations |
| ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 18. HealthcareService.meta.security | |||||
| Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. | ||||
| Short | Security Labels applied to this resource | ||||
| Comments | The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||
| Control | 0..* | ||||
| Binding | Unless not suitable, these codes SHALL be taken from All Security Labels (extensible to http://hl7.org/fhir/ValueSet/security-labels|4.0.1)Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| Type | Coding | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 20. HealthcareService.meta.tag | |||||
| Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. | ||||
| Short | Tags applied to this resource | ||||
| Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||
| Control | 0..* | ||||
| Binding | For example codes, see CommonTags (example to http://hl7.org/fhir/ValueSet/common-tags|4.0.1)Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| Type | Coding | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 22. 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. | ||||
| Short | A set of rules under which this content was created | ||||
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||
| Control | 0..0 | ||||
| Type | uri | ||||
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 24. HealthcareService.language | |||||
| Definition | The base language in which the resource is written. | ||||
| Short | Language 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). | ||||
| Control | 0..1 | ||||
| Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)A human language.
| ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 26. 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. | ||||
| Short | Text summary of the resource, for human interpretation | ||||
| Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | ||||
| Control | 0..1 | ||||
| Type | Narrative | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | narrative, html, xhtml, display | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 28. HealthcareService.contained | |||||
| Definition | Inline resources, such as a location, that are packaged together with the healthcare service example or representation. | ||||
| Short | Contained resources used by the healthcare service | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Resource | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | inline resources, anonymous resources, contained resources | ||||
| 30. HealthcareService.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | 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()) | ||||
| Slicing | This element introduces a set of slices on HealthcareService.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 32. HealthcareService.extension:clinicInfo | |||||
| Slice Name | clinicInfo | ||||
| Definition | Portal-specific clinic information such as URL placeholder, directions, parking, about text, spoken languages, and booking summary information text. | ||||
| Short | Grouped clinic presentation information | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(Clinic Info) (Complex Extension) | ||||
| Is Modifier | false | ||||
| Invariants | 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()) | ||||
| 34. HealthcareService.extension:bookingRules | |||||
| Slice Name | bookingRules | ||||
| Definition | Container for healthcare-service-specific supporting payloads, including reusable booking-rules configuration. | ||||
| Short | Grouped booking-related attachments | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(Booking Rules) (Complex Extension) | ||||
| Is Modifier | false | ||||
| Invariants | 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()) | ||||
| 36. HealthcareService.modifierExtension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..0 | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||
| Summary | false | ||||
| Invariants | 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()) | ||||
| 38. HealthcareService.identifier | |||||
| Definition | External identifiers for this item. | ||||
| Short | External identifiers for this item | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..* | ||||
| Type | Identifier | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 40. HealthcareService.active | |||||
| Definition | Indicates whether the healthcare service is active and should be considered available for use in the portal context. | ||||
| Short | Whether the healthcare service is active | ||||
| Comments | This element is labeled as a modifier because it may be used to mark that the resource was created in error. | ||||
| Control | 1..1 | ||||
| Type | boolean | ||||
| Is Modifier | true 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 Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 42. HealthcareService.providedBy | |||||
| Definition | Reference to the top-level owning ServiceProviderPortal organization that owns the configuration, endpoints, and service structure for the customer, and is responsible for the healthcare service shown in the portal. | ||||
| Short | Organization responsible for the healthcare 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. | ||||
| Control | 0..1 | ||||
| Type | Reference(Organization) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 44. HealthcareService.category | |||||
| Definition | Identifies the broad category of service being performed or delivered. | ||||
| Short | Broad 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. | ||||
| Control | 0..0 | ||||
| Binding | For example codes, see ServiceCategory (example to http://hl7.org/fhir/ValueSet/service-category|4.0.1)A category of the service(s) that could be provided. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Alternate Names | service category | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 46. HealthcareService.type | |||||
| Definition | The specific type of service that may be delivered or performed. | ||||
| Short | Type of service that may be delivered or performed | ||||
| Control | 0..0 | ||||
| Binding | For example codes, see ServiceType (example to http://hl7.org/fhir/ValueSet/service-type|4.0.1)Additional details about where the content was created (e.g. clinical specialty). | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Alternate Names | service type | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 48. HealthcareService.specialty | |||||
| Definition | Collection of specialties handled by the service site. This is more of a medical term. | ||||
| Short | Specialties handled by the HealthcareService | ||||
| Control | 0..0 | ||||
| Binding | The codes SHOULD be taken from PracticeSettingCodeValueSet (preferred to http://hl7.org/fhir/ValueSet/c80-practice-codes|4.0.1)A specialty that a healthcare service may provide. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 50. HealthcareService.location | |||||
| Definition | Reference to the single contained HealthcareServiceLocation instance that holds the clinic address for this healthcare service. | ||||
| Short | Contained address for the healthcare service | ||||
| Control | 1..* | ||||
| Type | Reference(Location) | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 52. HealthcareService.name | |||||
| Definition | The human-readable name used to present the healthcare service in the portal. | ||||
| Short | Display name of the healthcare service | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 54. 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. | ||||
| Short | Additional 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. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 56. HealthcareService.extraDetails | |||||
| Definition | Extra details about the service that can't be placed in the other fields. | ||||
| Short | Extra details about the service that can't be placed in the other fields | ||||
| Control | 0..0 | ||||
| Type | markdown | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 58. HealthcareService.photo | |||||
| Definition | Attachment carrying binary image data that represents the healthcare service in the portal. | ||||
| Short | Image representing the healthcare service | ||||
| Control | 0..1 | ||||
| Type | Attachment | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 60. HealthcareService.telecom | |||||
| Definition | Contact points such as phone, URL, or email used to reach the healthcare service. | ||||
| Short | Portal contact details for the healthcare service | ||||
| Comments | If this is empty, then refer to the location's contacts. | ||||
| Control | 0..* | ||||
| Type | ContactPoint | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 62. HealthcareService.telecom.id | |||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 64. HealthcareService.telecom.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | 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()) | ||||
| Slicing | This element introduces a set of slices on HealthcareService.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 66. HealthcareService.telecom.system | |||||
| Definition | The contact point system, for example phone, url, or email. | ||||
| Short | Type of contact point | ||||
| Control | 0..1 This element is affected by the following invariants: cpt-2 | ||||
| Binding | The codes SHALL be taken from ContactPointSystem (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)Telecommunications form for contact point. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 68. HealthcareService.telecom.value | |||||
| Definition | The phone number, URL, or email address for the contact point. | ||||
| Short | Actual contact value | ||||
| Comments | Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to support legacy numbers that are not in a tightly controlled format. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 70. HealthcareService.telecom.use | |||||
| Definition | The intended usage for the contact point, such as work. | ||||
| Short | Usage context for the contact point | ||||
| Comments | Applications can assume that a contact is current unless it explicitly says that it is temporary or old. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from ContactPointUse (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1)Use of contact point. | ||||
| Type | code | ||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 72. HealthcareService.telecom.rank | |||||
| Definition | Specifies the preferred order in which the listed contact points should be used. | ||||
| Short | Priority order of contact points | ||||
| Comments | Note that rank does not necessarily follow the order in which the contacts are represented in the instance. | ||||
| Control | 0..1 | ||||
| Type | positiveInt | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 74. HealthcareService.telecom.period | |||||
| Definition | Time period when the contact point was/is in use. | ||||
| Short | Time period when the contact point was/is in use | ||||
| Control | 0..1 | ||||
| Type | Period | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 76. HealthcareService.coverageArea | |||||
| Definition | The location(s) that this service is available to (not where the service is provided). | ||||
| Short | Location(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". | ||||
| Control | 0..0 | ||||
| Type | Reference(Location) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 78. HealthcareService.serviceProvisionCode | |||||
| Definition | The code(s) that detail the conditions under which the healthcare service is available/offered. | ||||
| Short | Conditions 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. | ||||
| Control | 0..0 | ||||
| Binding | For example codes, see ServiceProvisionConditions (example to http://hl7.org/fhir/ValueSet/service-provision-conditions|4.0.1)The code(s) that detail the conditions under which the healthcare service is available/offered. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 80. HealthcareService.eligibility | |||||
| Definition | Does this service have specific eligibility requirements that need to be met in order to use the service? | ||||
| Short | Specific eligibility requirements required to use the service | ||||
| Control | 0..0 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 87. HealthcareService.program | |||||
| Definition | Programs that this service is applicable to. | ||||
| Short | Programs 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, …. | ||||
| Control | 0..0 | ||||
| Binding | For example codes, see Program (example to http://hl7.org/fhir/ValueSet/program|4.0.1)Government or local programs that this service applies to. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 89. HealthcareService.characteristic | |||||
| Definition | Collection of characteristics (attributes). | ||||
| Short | Collection of characteristics (attributes) | ||||
| Comments | These could be such things as is wheelchair accessible. | ||||
| Control | 0..* | ||||
| Binding | A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 91. 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. | ||||
| Short | The 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. | ||||
| Control | 0..0 | ||||
| Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)A human language.
| ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 93. HealthcareService.referralMethod | |||||
| Definition | Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required. | ||||
| Short | Ways that the service accepts referrals | ||||
| Control | 0..0 | ||||
| Binding | For example codes, see ReferralMethod (example to http://hl7.org/fhir/ValueSet/service-referral-method|4.0.1)The methods of referral can be used when referring to a specific HealthCareService resource. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 95. 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. | ||||
| Short | If an appointment is required for access to this service | ||||
| Control | 0..0 | ||||
| Type | boolean | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 97. HealthcareService.availableTime | |||||
| Definition | Opening hours and other published availability windows for when the healthcare service is available in the portal. | ||||
| Short | Opening hours and availability windows | ||||
| Comments | More detailed availability information may be provided in associated Schedule/Slot resources. | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 99. HealthcareService.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. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 101. HealthcareService.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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
| Short | Additional 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | 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()) | ||||
| 103. HealthcareService.availableTime.modifierExtension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
| Short | Extensions 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| Summary | true | ||||
| 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 Names | extensions, user content, modifiers | ||||
| Invariants | 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()) | ||||
| 105. HealthcareService.availableTime.daysOfWeek | |||||
| Definition | Indicates which days of the week are available between the start and end Times. | ||||
| Short | mon | tue | wed | thu | fri | sat | sun | ||||
| Control | 0..* | ||||
| Binding | The codes SHALL be taken from DaysOfWeek (required to http://hl7.org/fhir/ValueSet/days-of-week|4.0.1)The days of the week. | ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 107. HealthcareService.availableTime.allDay | |||||
| Definition | Is this always available? (hence times are irrelevant) e.g. 24 hour service. | ||||
| Short | Always available? e.g. 24 hour service | ||||
| Control | 0..1 | ||||
| Type | boolean | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 109. HealthcareService.availableTime.availableStartTime | |||||
| Definition | The opening time of day. Note: If the AllDay flag is set, then this time is ignored. | ||||
| Short | Opening time of day (ignored if allDay = true) | ||||
| Comments | The time zone is expected to be for where this HealthcareService is provided at. | ||||
| Control | 0..1 | ||||
| Type | time | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 111. HealthcareService.availableTime.availableEndTime | |||||
| Definition | The closing time of day. Note: If the AllDay flag is set, then this time is ignored. | ||||
| Short | Closing time of day (ignored if allDay = true) | ||||
| Comments | The time zone is expected to be for where this HealthcareService is provided at. | ||||
| Control | 0..1 | ||||
| Type | time | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 113. HealthcareService.notAvailable | |||||
| Definition | The HealthcareService is not available during this period of time due to the provided reason. | ||||
| Short | Not available during this time due to provided reason | ||||
| Control | 0..0 | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 120. HealthcareService.availabilityExceptions | |||||
| Definition | 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. | ||||
| Short | Description of availability exceptions | ||||
| Control | 0..0 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 122. HealthcareService.endpoint | |||||
| Definition | Technical endpoints providing access to services operated for the specific healthcare services defined at this resource. | ||||
| Short | Technical endpoints providing access to electronic services operated for the healthcare service | ||||
| Control | 0..0 | ||||
| Type | Reference(Endpoint) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||