Skip to main content

HealthcareService

PropertyValue
Publisher
NameHealthcareService
URLhttp://hl7.org/fhir/StructureDefinition/HealthcareService
Statusdraft
Description
Abstractfalse

Structure

PathCardinalityTypeDescription
HealthcareService0..*HealthcareServiceThe details of a healthcare service available at a location.
HealthcareService.id0..1http://hl7.org/fhirpath/System.StringThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
HealthcareService.meta0..1MetaThe 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.
HealthcareService.implicitRules0..1uriA 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.
HealthcareService.language0..1codeThe base language in which the resource is written.
HealthcareService.text0..1NarrativeA 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.
HealthcareService.contained0..*ResourceThese 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.
HealthcareService.extension0..*ExtensionMay 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.
HealthcareService.modifierExtension0..*ExtensionMay 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).
HealthcareService.identifier0..*IdentifierExternal identifiers for this item.
HealthcareService.active0..1booleanThis 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.
HealthcareService.providedBy0..1ReferenceThe organization that provides this healthcare service.
HealthcareService.category0..*CodeableConceptIdentifies the broad category of service being performed or delivered.
HealthcareService.type0..*CodeableConceptThe specific type of service that may be delivered or performed.
HealthcareService.specialty0..*CodeableConceptCollection of specialties handled by the service site. This is more of a medical term.
HealthcareService.location0..*ReferenceThe location(s) where this healthcare service may be provided.
HealthcareService.name0..1stringFurther description of the service as it would be presented to a consumer while searching.
HealthcareService.comment0..1stringAny 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.
HealthcareService.extraDetails0..1markdownExtra details about the service that can't be placed in the other fields.
HealthcareService.photo0..1AttachmentIf there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list.
HealthcareService.telecom0..*ContactPointList of contacts related to this specific healthcare service.
HealthcareService.coverageArea0..*ReferenceThe location(s) that this service is available to (not where the service is provided).
HealthcareService.serviceProvisionCode0..*CodeableConceptThe code(s) that detail the conditions under which the healthcare service is available/offered.
HealthcareService.eligibility0..*BackboneElementDoes this service have specific eligibility requirements that need to be met in order to use the service?
HealthcareService.eligibility.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
HealthcareService.eligibility.extension0..*ExtensionMay 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.
HealthcareService.eligibility.modifierExtension0..*ExtensionMay 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).
HealthcareService.eligibility.code0..1CodeableConceptCoded value for the eligibility.
HealthcareService.eligibility.comment0..1markdownDescribes the eligibility conditions for the service.
HealthcareService.program0..*CodeableConceptPrograms that this service is applicable to.
HealthcareService.characteristic0..*CodeableConceptCollection of characteristics (attributes).
HealthcareService.communication0..*CodeableConceptSome 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.
HealthcareService.referralMethod0..*CodeableConceptWays that the service accepts referrals, if this is not provided then it is implied that no referral is required.
HealthcareService.appointmentRequired0..1booleanIndicates 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.
HealthcareService.availableTime0..*BackboneElementA collection of times that the Service Site is available.
HealthcareService.availableTime.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
HealthcareService.availableTime.extension0..*ExtensionMay 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.
HealthcareService.availableTime.modifierExtension0..*ExtensionMay 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).
HealthcareService.availableTime.daysOfWeek0..*codeIndicates which days of the week are available between the start and end Times.
HealthcareService.availableTime.allDay0..1booleanIs this always available? (hence times are irrelevant) e.g. 24 hour service.
HealthcareService.availableTime.availableStartTime0..1timeThe opening time of day. Note: If the AllDay flag is set, then this time is ignored.
HealthcareService.availableTime.availableEndTime0..1timeThe closing time of day. Note: If the AllDay flag is set, then this time is ignored.
HealthcareService.notAvailable0..*BackboneElementThe HealthcareService is not available during this period of time due to the provided reason.
HealthcareService.notAvailable.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
HealthcareService.notAvailable.extension0..*ExtensionMay 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.
HealthcareService.notAvailable.modifierExtension0..*ExtensionMay 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).
HealthcareService.notAvailable.description1..1stringThe reason that can be presented to the user as to why this time is not available.
HealthcareService.notAvailable.during0..1PeriodService is not available (seasonally or for a public holiday) from this date.
HealthcareService.availabilityExceptions0..1stringA 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.
HealthcareService.endpoint0..*ReferenceTechnical endpoints providing access to services operated for the specific healthcare services defined at this resource.

Search Parameters

NameTypeDescriptionExpression
_textstringSearch on the narrative of the resource
_contentstringSearch on the entire content of the resource
_filtertokenFilter search parameter which supports a more sophisticated grammar for searching. See documentation for further details
_hasstringProvides limited support for reverse chaining - that is, selecting resources based on the properties of resources that refer to them (instead of chaining where resources can be selected based on the properties of resources that they refer to). See the FHIR search page for further documentation
_idtokenLogical id of this artifactResource.id
_lastUpdateddateWhen the resource version last changedResource.meta.lastUpdated
_liststringAll resources in nominated list (by id, Type/id, url or one of the magic List types)
_profileuriProfiles this resource claims to conform toResource.meta.profile
_querytokenA custom search profile that describes a specific defined query operation
_securitytokenSecurity Labels applied to this resourceResource.meta.security
_sourceuriIdentifies where the resource comes fromResource.meta.source
_tagtokenTags applied to this resourceResource.meta.tag
_textstringSearch on the narrative text (html) of the resource
_typetokenUsed when a search is performed in a context which doesn't limit the search to indicate which types are being searched. See the FHIR search page for further discussion
activetokenThe Healthcare Service is currently marked as activeHealthcareService.active
characteristictokenOne of the HealthcareService's characteristicsHealthcareService.characteristic
coverage-areareferenceLocation(s) service is intended for/available toHealthcareService.coverageArea
endpointreferenceTechnical endpoints providing access to electronic services operated for the healthcare serviceHealthcareService.endpoint
identifiertokenExternal identifiers for this itemHealthcareService.identifier
locationreferenceThe location of the Healthcare ServiceHealthcareService.location
namestringA portion of the Healthcare service nameHealthcareService.name
organizationreferenceThe organization that provides this Healthcare ServiceHealthcareService.providedBy
programtokenOne of the Programs supported by this HealthcareServiceHealthcareService.program
service-categorytokenService Category of the Healthcare ServiceHealthcareService.category
service-typetokenThe type of service provided by this healthcare serviceHealthcareService.type
specialtytokenThe specialty of the service provided by this healthcare serviceHealthcareService.specialty