This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions
Patient Administration Work Group | Maturity Level: 4 | Trial Use | Security Category: Business | Compartments: No defined compartments |
Detailed Descriptions for the elements in the HealthcareService resource.
HealthcareService | |||||||||
Element Id | HealthcareService | ||||||||
Definition | The details of a healthcare service available at a location. | ||||||||
Short Display | The details of a healthcare service available at a location | ||||||||
Cardinality | 0..* | ||||||||
Type | DomainResource | ||||||||
Summary | false | ||||||||
HealthcareService.identifier | |||||||||
Element Id | HealthcareService.identifier | ||||||||
Definition | External identifiers for this item. | ||||||||
Short Display | External identifiers for this item | ||||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
Cardinality | 0..* | ||||||||
Type | Identifier | ||||||||
Summary | true | ||||||||
HealthcareService.active | |||||||||
Element Id | HealthcareService.active | ||||||||
Definition | This flag is used to mark the record to not be used. This is not used when a center is closed for maintenance, or for holidays, the notAvailable period is to be used for this. | ||||||||
Short Display | Whether this HealthcareService record is in active use | ||||||||
Cardinality | 0..1 | ||||||||
Type | boolean | ||||||||
Is Modifier | true (Reason: 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) | ||||||||
Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element | ||||||||
Summary | true | ||||||||
Comments | This element is labeled as a modifier because it may be used to mark that the resource was created in error. | ||||||||
HealthcareService.providedBy | |||||||||
Element Id | HealthcareService.providedBy | ||||||||
Definition | The organization that provides this healthcare service. | ||||||||
Short Display | Organization that provides this service | ||||||||
Cardinality | 0..1 | ||||||||
Type | Reference(Organization) | ||||||||
Summary | true | ||||||||
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. | ||||||||
HealthcareService.offeredIn | |||||||||
Element Id | HealthcareService.offeredIn | ||||||||
Definition | When the HealthcareService is representing a specific, schedulable service, the availableIn property can refer to a generic service. | ||||||||
Short Display | The service within which this service is offered | ||||||||
Cardinality | 0..* | ||||||||
Type | Reference(HealthcareService) | ||||||||
Summary | false | ||||||||
Comments | For example, if there is a generic Radiology service that offers CT Scans, MRIs, etc. You could have HealthcareService resources for the CT Scans and MRIs, which have an offeredIn reference to the Radiology HealthcareService. | ||||||||
HealthcareService.category | |||||||||
Element Id | HealthcareService.category | ||||||||
Definition | Identifies the broad category of service being performed or delivered. | ||||||||
Short Display | Broad category of service being performed or delivered | ||||||||
Cardinality | 0..* | ||||||||
Terminology Binding | Service Category (Example) | ||||||||
Type | CodeableConcept | ||||||||
Alternate Names | service category | ||||||||
Summary | true | ||||||||
Comments | Selecting a Service Category then determines the list of relevant service types that can be selected in the primary service type. | ||||||||
HealthcareService.type | |||||||||
Element Id | HealthcareService.type | ||||||||
Definition | The specific type of service that may be delivered or performed. | ||||||||
Short Display | Type of service that may be delivered or performed | ||||||||
Cardinality | 0..* | ||||||||
Terminology Binding | Service Type (Example) | ||||||||
Type | CodeableConcept | ||||||||
Alternate Names | service type | ||||||||
Summary | true | ||||||||
HealthcareService.specialty | |||||||||
Element Id | HealthcareService.specialty | ||||||||
Definition | Collection of specialties handled by the Healthcare service. This is more of a medical term. | ||||||||
Short Display | Specialties handled by the HealthcareService | ||||||||
Cardinality | 0..* | ||||||||
Terminology Binding | Practice Setting Code Value Set (Preferred) | ||||||||
Type | CodeableConcept | ||||||||
Summary | true | ||||||||
HealthcareService.location | |||||||||
Element Id | HealthcareService.location | ||||||||
Definition | The location(s) where this healthcare service may be provided. | ||||||||
Short Display | Location(s) where service may be provided | ||||||||
Cardinality | 0..* | ||||||||
Type | Reference(Location) | ||||||||
Summary | true | ||||||||
HealthcareService.name | |||||||||
Element Id | HealthcareService.name | ||||||||
Definition | Further description of the service as it would be presented to a consumer while searching. | ||||||||
Short Display | Description of service as presented to a consumer while searching | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | true | ||||||||
HealthcareService.comment | |||||||||
Element Id | 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 Display | Additional description and/or any specific issues not covered elsewhere | ||||||||
Cardinality | 0..1 | ||||||||
Type | markdown | ||||||||
Summary | true | ||||||||
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. | ||||||||
HealthcareService.extraDetails | |||||||||
Element Id | HealthcareService.extraDetails | ||||||||
Definition | Extra details about the service that can't be placed in the other fields. | ||||||||
Short Display | Extra details about the service that can't be placed in the other fields | ||||||||
Cardinality | 0..1 | ||||||||
Type | markdown | ||||||||
Summary | false | ||||||||
HealthcareService.photo | |||||||||
Element Id | HealthcareService.photo | ||||||||
Definition | If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list. | ||||||||
Short Display | Facilitates quick identification of the service | ||||||||
Cardinality | 0..1 | ||||||||
Type | Attachment | ||||||||
Summary | true | ||||||||
HealthcareService.contact | |||||||||
Element Id | HealthcareService.contact | ||||||||
Definition | The contact details of communication devices available relevant to the specific HealthcareService. This can include addresses, phone numbers, fax numbers, mobile numbers, email addresses and web sites. | ||||||||
Short Display | Official contact details for the HealthcareService | ||||||||
Cardinality | 0..* | ||||||||
Type | ExtendedContactDetail | ||||||||
Requirements | Need to keep track of both simple contact details and also assigned contacts within larger organizations. | ||||||||
Summary | false | ||||||||
Comments | The address/telecom use code 'home' are not to be used. Note that these contacts are not the contact details of people who provide the service (that would be through PractitionerRole), these are official contacts for the HealthcareService itself for specific purposes. E.g. Mailing Addresses, Billing Addresses, Contact numbers for Booking or Billing Enquiries, general web address, web address for online bookings etc. If this is empty (or the type of interest is empty), refer to the location's contacts. | ||||||||
HealthcareService.coverageArea | |||||||||
Element Id | HealthcareService.coverageArea | ||||||||
Definition | The location(s) that this service is available to (not where the service is provided). | ||||||||
Short Display | Location(s) service is intended for/available to | ||||||||
Cardinality | 0..* | ||||||||
Type | Reference(Location) | ||||||||
Summary | false | ||||||||
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". | ||||||||
HealthcareService.serviceProvisionCode | |||||||||
Element Id | HealthcareService.serviceProvisionCode | ||||||||
Definition | The code(s) that detail the conditions under which the healthcare service is available/offered. | ||||||||
Short Display | Conditions under which service is available/offered | ||||||||
Cardinality | 0..* | ||||||||
Terminology Binding | Service Provision Conditions (Example) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
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. | ||||||||
HealthcareService.eligibility | |||||||||
Element Id | HealthcareService.eligibility | ||||||||
Definition | Does this service have specific eligibility requirements that need to be met in order to use the service? | ||||||||
Short Display | Specific eligibility requirements required to use the service | ||||||||
Cardinality | 0..* | ||||||||
Summary | false | ||||||||
Invariants |
| ||||||||
HealthcareService.eligibility.code | |||||||||
Element Id | HealthcareService.eligibility.code | ||||||||
Definition | Coded value for the eligibility. | ||||||||
Short Display | Coded value for the eligibility | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | Eligibility Characteristics (Example) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
Invariants |
| ||||||||
HealthcareService.eligibility.value[x] | |||||||||
Element Id | HealthcareService.eligibility.value[x] | ||||||||
Definition | Sometimes an eligibility code requires additional data to calculate the eligibility rules. | ||||||||
Short Display | Value associated with the eligibility code | ||||||||
Cardinality | 0..1 | ||||||||
Type | CodeableConcept|boolean|Quantity|Range|Reference | ||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||
Summary | false | ||||||||
Comments | The example binding could utilize the value where the eligibility code is not sufficient alone.
| ||||||||
Invariants |
| ||||||||
HealthcareService.eligibility.comment | |||||||||
Element Id | HealthcareService.eligibility.comment | ||||||||
Definition | Describes the eligibility conditions for the service. | ||||||||
Short Display | Describes the eligibility conditions for the service | ||||||||
Cardinality | 0..1 | ||||||||
Type | markdown | ||||||||
Summary | false | ||||||||
Comments | The description of service eligibility should, in general, not exceed one or two paragraphs. It should be sufficient for a prospective consumer to determine if they are likely to be eligible or not. Where eligibility requirements and conditions are complex, it may simply be noted that an eligibility assessment is required. Where eligibility is determined by an outside source, such as an Act of Parliament, this should be noted, preferably with a reference to a commonly available copy of the source document such as a web page. | ||||||||
HealthcareService.eligibility.period | |||||||||
Element Id | HealthcareService.eligibility.period | ||||||||
Definition | The period that this eligibility rule is a requirement for this service. | ||||||||
Short Display | The period this eligibility rule applies | ||||||||
Cardinality | 0..1 | ||||||||
Type | markdown | ||||||||
Summary | false | ||||||||
HealthcareService.program | |||||||||
Element Id | HealthcareService.program | ||||||||
Definition | Programs that this service is applicable to. | ||||||||
Short Display | Programs that this service is applicable to | ||||||||
Cardinality | 0..* | ||||||||
Terminology Binding | Program (Example) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
Comments | Programs are often defined externally to an Organization, commonly by governments; e.g. Home and Community Care Programs, Homeless Program, …. | ||||||||
HealthcareService.characteristic | |||||||||
Element Id | HealthcareService.characteristic | ||||||||
Definition | Collection of characteristics (attributes). | ||||||||
Short Display | Collection of characteristics (attributes) | ||||||||
Cardinality | 0..* | ||||||||
Terminology Binding | Service Mode (Example) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
Comments | These could be such things as is wheelchair accessible. | ||||||||
HealthcareService.communication | |||||||||
Element Id | 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 Display | The language that this service is offered in | ||||||||
Cardinality | 0..* | ||||||||
Terminology Binding | All Languages (Required)
| ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
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. | ||||||||
HealthcareService.referralMethod | |||||||||
Element Id | HealthcareService.referralMethod | ||||||||
Definition | Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required. | ||||||||
Short Display | Ways that the service accepts referrals | ||||||||
Cardinality | 0..* | ||||||||
Terminology Binding | Referral Method (Example) | ||||||||
Type | CodeableConcept | ||||||||
Summary | false | ||||||||
HealthcareService.referralRequired | |||||||||
Element Id | HealthcareService.referralRequired | ||||||||
Definition | Indicates whether or not a prospective consumer will require a referral for a particular service at a site to be provided by the Organization. | ||||||||
Short Display | A referral is required for access to this service | ||||||||
Cardinality | 0..1 | ||||||||
Type | boolean | ||||||||
Summary | false | ||||||||
Comments | If more than just a general referral is required then you can combine this with the eligibility property to specify additional requirements, such as using the sample code | ||||||||
HealthcareService.appointmentRequired | |||||||||
Element Id | 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. | ||||||||
Short Display | An appointment is required for access to this service | ||||||||
Cardinality | 0..1 | ||||||||
Type | boolean | ||||||||
Summary | false | ||||||||
HealthcareService.availability | |||||||||
Element Id | HealthcareService.availability | ||||||||
Definition | A collection of times that the healthcare service is available. | ||||||||
Short Display | Times the healthcare service is available (including exceptions) | ||||||||
Cardinality | 0..1 | ||||||||
Type | Availability | ||||||||
Summary | false | ||||||||
Comments | More detailed availability information may be provided in associated Schedule/Slot resources. Systems may choose to render availability differently than it is exchanged on the interface. For example, rather than "Mon, Tue, Wed, Thur, Fri from 9am-12am; Mon, Tue, Wed, Thur, Fri from 1pm-5pm" as would be implied by two availableTime repetitions, an application could render this information as "Mon-Fri 9-12am and 1-5pm". The NotAvailableTime(s) included indicate the general days/periods where the service is not available (for things such as public holidays). | ||||||||
HealthcareService.endpoint | |||||||||
Element Id | HealthcareService.endpoint | ||||||||
Definition | Technical endpoints providing access to services operated for the specific healthcare services defined at this resource. | ||||||||
Short Display | Technical endpoints providing access to electronic services operated for the healthcare service | ||||||||
Cardinality | 0..* | ||||||||
Type | Reference(Endpoint) | ||||||||
Summary | false |