This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
Patient Administration Work Group | Maturity Level: 1 | Compartments: Not linked to any defined compartments |
The details of a healthcare service available at a location.
The HealthcareService resource is used to describe a single healthcare service or
category of services that are provided by an organization at a location.
The location of the services could be virtual, as with TeleMedicine Services.
Common examples of HealthcareServices resources are:
HealthcareService resources do not represent Computer related Services (not SOA)
Example uses of HealthcareService resources are:
The HealthcareService resource can be used with the Schedule resource to define actual availability of the service. This would be done by using the Schedule's Actor property.
When creating an Appointment, the HealthcareService is to be assigned to one of the participants.
It is up to the scheduling system to determine if the service is available, and can be accepted.
This resource is referenced by Account, Appointment, AppointmentResponse, Practitioner, PractitionerRole and Schedule
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
HealthcareService | DomainResource | The details of a healthcare service available at a location | ||
identifier | Σ | 0..* | Identifier | External identifiers for this item |
active | ?!Σ | 0..1 | boolean | Whether this healthcareservice is in active use |
providedBy | Σ | 0..1 | Reference(Organization) | Organization that provides this service |
serviceCategory | Σ | 0..1 | CodeableConcept | Broad category of service being performed or delivered ServiceCategory (Example) |
serviceType | Σ | 0..* | CodeableConcept | Type of service that may be delivered or performed ServiceType (Example) |
specialty | Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Practice Setting Code Value Set (Preferred) |
location | Σ | 0..* | Reference(Location) | Location(s) where service may be provided |
serviceName | Σ | 0..1 | string | Description of service as presented to a consumer while searching |
comment | Σ | 0..1 | string | Additional description and/or any specific issues not covered elsewhere |
extraDetails | 0..1 | string | Extra details about the service that can't be placed in the other fields | |
photo | Σ | 0..1 | Attachment | Facilitates quick identification of the service |
telecom | 0..* | ContactPoint | Contacts related to the healthcare service | |
coverageArea | 0..* | Reference(Location) | Location(s) service is inteded for/available to | |
serviceProvisionCode | 0..* | CodeableConcept | Conditions under which service is available/offered ServiceProvisionConditions (Example) | |
eligibility | 0..1 | CodeableConcept | Specific eligibility requirements required to use the service | |
eligibilityNote | 0..1 | string | Describes the eligibility conditions for the service | |
programName | 0..* | string | Program Names that categorize the service | |
characteristic | 0..* | CodeableConcept | Collection of characteristics (attributes) | |
referralMethod | 0..* | CodeableConcept | Ways that the service accepts referrals ReferralMethod (Example) | |
publicKey | 0..1 | string | PKI Public keys to support secure communications | |
appointmentRequired | 0..1 | boolean | If an appointment is required for access to this service | |
availableTime | 0..* | BackboneElement | Times the Service Site is available | |
daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun DaysOfWeek (Required) | |
allDay | 0..1 | boolean | Always available? e.g. 24 hour service | |
availableStartTime | 0..1 | time | Opening time of day (ignored if allDay = true) | |
availableEndTime | 0..1 | time | Closing time of day (ignored if allDay = true) | |
notAvailable | 0..* | BackboneElement | Not available during this time due to provided reason | |
description | 1..1 | string | Reason presented to the user explaining why time not available | |
during | 0..1 | Period | Service not availablefrom this date | |
availabilityExceptions | 0..1 | string | Description of availability exceptions | |
endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location | |
Documentation for this format |
UML Diagram (Legend)
XML Template
<HealthcareService xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier External identifiers for this item --></identifier> <active value="[boolean]"/><!-- 0..1 Whether this healthcareservice is in active use --> <providedBy><!-- 0..1 Reference(Organization) Organization that provides this service --></providedBy> <serviceCategory><!-- 0..1 CodeableConcept Broad category of service being performed or delivered --></serviceCategory> <serviceType><!-- 0..* CodeableConcept Type of service that may be delivered or performed --></serviceType> <specialty><!-- 0..* CodeableConcept Specialties handled by the HealthcareService --></specialty> <location><!-- 0..* Reference(Location) Location(s) where service may be provided --></location> <serviceName value="[string]"/><!-- 0..1 Description of service as presented to a consumer while searching --> <comment value="[string]"/><!-- 0..1 Additional description and/or any specific issues not covered elsewhere --> <extraDetails value="[string]"/><!-- 0..1 Extra details about the service that can't be placed in the other fields --> <photo><!-- 0..1 Attachment Facilitates quick identification of the service --></photo> <telecom><!-- 0..* ContactPoint Contacts related to the healthcare service --></telecom> <coverageArea><!-- 0..* Reference(Location) Location(s) service is inteded for/available to --></coverageArea> <serviceProvisionCode><!-- 0..* CodeableConcept Conditions under which service is available/offered --></serviceProvisionCode> <eligibility><!-- 0..1 CodeableConcept Specific eligibility requirements required to use the service --></eligibility> <eligibilityNote value="[string]"/><!-- 0..1 Describes the eligibility conditions for the service --> <programName value="[string]"/><!-- 0..* Program Names that categorize the service --> <characteristic><!-- 0..* CodeableConcept Collection of characteristics (attributes) --></characteristic> <referralMethod><!-- 0..* CodeableConcept Ways that the service accepts referrals --></referralMethod> <publicKey value="[string]"/><!-- 0..1 PKI Public keys to support secure communications --> <appointmentRequired value="[boolean]"/><!-- 0..1 If an appointment is required for access to this service --> <availableTime> <!-- 0..* Times the Service Site is available --> <daysOfWeek value="[code]"/><!-- 0..* mon | tue | wed | thu | fri | sat | sun --> <allDay value="[boolean]"/><!-- 0..1 Always available? e.g. 24 hour service --> <availableStartTime value="[time]"/><!-- 0..1 Opening time of day (ignored if allDay = true) --> <availableEndTime value="[time]"/><!-- 0..1 Closing time of day (ignored if allDay = true) --> </availableTime> <notAvailable> <!-- 0..* Not available during this time due to provided reason --> <description value="[string]"/><!-- 1..1 Reason presented to the user explaining why time not available --> <during><!-- 0..1 Period Service not availablefrom this date --></during> </notAvailable> <availabilityExceptions value="[string]"/><!-- 0..1 Description of availability exceptions --> <endpoint><!-- 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the location --></endpoint> </HealthcareService>
JSON Template
{ "resourceType" : "HealthcareService", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "identifier" : [{ Identifier }], // External identifiers for this item "active" : <boolean>, // Whether this healthcareservice is in active use "providedBy" : { Reference(Organization) }, // Organization that provides this service "serviceCategory" : { CodeableConcept }, // Broad category of service being performed or delivered "serviceType" : [{ CodeableConcept }], // Type of service that may be delivered or performed "specialty" : [{ CodeableConcept }], // Specialties handled by the HealthcareService "location" : [{ Reference(Location) }], // Location(s) where service may be provided "serviceName" : "<string>", // Description of service as presented to a consumer while searching "comment" : "<string>", // Additional description and/or any specific issues not covered elsewhere "extraDetails" : "<string>", // Extra details about the service that can't be placed in the other fields "photo" : { Attachment }, // Facilitates quick identification of the service "telecom" : [{ ContactPoint }], // Contacts related to the healthcare service "coverageArea" : [{ Reference(Location) }], // Location(s) service is inteded for/available to "serviceProvisionCode" : [{ CodeableConcept }], // Conditions under which service is available/offered "eligibility" : { CodeableConcept }, // Specific eligibility requirements required to use the service "eligibilityNote" : "<string>", // Describes the eligibility conditions for the service "programName" : ["<string>"], // Program Names that categorize the service "characteristic" : [{ CodeableConcept }], // Collection of characteristics (attributes) "referralMethod" : [{ CodeableConcept }], // Ways that the service accepts referrals "publicKey" : "<string>", // PKI Public keys to support secure communications "appointmentRequired" : <boolean>, // If an appointment is required for access to this service "availableTime" : [{ // Times the Service Site is available "daysOfWeek" : ["<code>"], // mon | tue | wed | thu | fri | sat | sun "allDay" : <boolean>, // Always available? e.g. 24 hour service "availableStartTime" : "<time>", // Opening time of day (ignored if allDay = true) "availableEndTime" : "<time>" // Closing time of day (ignored if allDay = true) }], "notAvailable" : [{ // Not available during this time due to provided reason "description" : "<string>", // R! Reason presented to the user explaining why time not available "during" : { Period } // Service not availablefrom this date }], "availabilityExceptions" : "<string>", // Description of availability exceptions "endpoint" : [{ Reference(Endpoint) }] // Technical endpoints providing access to services operated for the location }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:HealthcareService; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:HealthcareService.identifier [ Identifier ], ... ; # 0..* External identifiers for this item fhir:HealthcareService.active [ boolean ]; # 0..1 Whether this healthcareservice is in active use fhir:HealthcareService.providedBy [ Reference(Organization) ]; # 0..1 Organization that provides this service fhir:HealthcareService.serviceCategory [ CodeableConcept ]; # 0..1 Broad category of service being performed or delivered fhir:HealthcareService.serviceType [ CodeableConcept ], ... ; # 0..* Type of service that may be delivered or performed fhir:HealthcareService.specialty [ CodeableConcept ], ... ; # 0..* Specialties handled by the HealthcareService fhir:HealthcareService.location [ Reference(Location) ], ... ; # 0..* Location(s) where service may be provided fhir:HealthcareService.serviceName [ string ]; # 0..1 Description of service as presented to a consumer while searching fhir:HealthcareService.comment [ string ]; # 0..1 Additional description and/or any specific issues not covered elsewhere fhir:HealthcareService.extraDetails [ string ]; # 0..1 Extra details about the service that can't be placed in the other fields fhir:HealthcareService.photo [ Attachment ]; # 0..1 Facilitates quick identification of the service fhir:HealthcareService.telecom [ ContactPoint ], ... ; # 0..* Contacts related to the healthcare service fhir:HealthcareService.coverageArea [ Reference(Location) ], ... ; # 0..* Location(s) service is inteded for/available to fhir:HealthcareService.serviceProvisionCode [ CodeableConcept ], ... ; # 0..* Conditions under which service is available/offered fhir:HealthcareService.eligibility [ CodeableConcept ]; # 0..1 Specific eligibility requirements required to use the service fhir:HealthcareService.eligibilityNote [ string ]; # 0..1 Describes the eligibility conditions for the service fhir:HealthcareService.programName [ string ], ... ; # 0..* Program Names that categorize the service fhir:HealthcareService.characteristic [ CodeableConcept ], ... ; # 0..* Collection of characteristics (attributes) fhir:HealthcareService.referralMethod [ CodeableConcept ], ... ; # 0..* Ways that the service accepts referrals fhir:HealthcareService.publicKey [ string ]; # 0..1 PKI Public keys to support secure communications fhir:HealthcareService.appointmentRequired [ boolean ]; # 0..1 If an appointment is required for access to this service fhir:HealthcareService.availableTime [ # 0..* Times the Service Site is available fhir:HealthcareService.availableTime.daysOfWeek [ code ], ... ; # 0..* mon | tue | wed | thu | fri | sat | sun fhir:HealthcareService.availableTime.allDay [ boolean ]; # 0..1 Always available? e.g. 24 hour service fhir:HealthcareService.availableTime.availableStartTime [ time ]; # 0..1 Opening time of day (ignored if allDay = true) fhir:HealthcareService.availableTime.availableEndTime [ time ]; # 0..1 Closing time of day (ignored if allDay = true) ], ...; fhir:HealthcareService.notAvailable [ # 0..* Not available during this time due to provided reason fhir:HealthcareService.notAvailable.description [ string ]; # 1..1 Reason presented to the user explaining why time not available fhir:HealthcareService.notAvailable.during [ Period ]; # 0..1 Service not availablefrom this date ], ...; fhir:HealthcareService.availabilityExceptions [ string ]; # 0..1 Description of availability exceptions fhir:HealthcareService.endpoint [ Reference(Endpoint) ], ... ; # 0..* Technical endpoints providing access to services operated for the location ]
Changes since DSTU2
HealthcareService | |
HealthcareService.active | added Element |
HealthcareService.serviceType | Type changed from BackboneElement to CodeableConcept |
HealthcareService.specialty | added Element |
HealthcareService.location |
Min Cardinality changed from 1 to 0 Max Cardinality changed from 1 to * |
HealthcareService.endpoint | added Element |
HealthcareService.serviceType.type | deleted |
HealthcareService.serviceType.specialty | deleted |
See the Full Difference for further information
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
HealthcareService | DomainResource | The details of a healthcare service available at a location | ||
identifier | Σ | 0..* | Identifier | External identifiers for this item |
active | ?!Σ | 0..1 | boolean | Whether this healthcareservice is in active use |
providedBy | Σ | 0..1 | Reference(Organization) | Organization that provides this service |
serviceCategory | Σ | 0..1 | CodeableConcept | Broad category of service being performed or delivered ServiceCategory (Example) |
serviceType | Σ | 0..* | CodeableConcept | Type of service that may be delivered or performed ServiceType (Example) |
specialty | Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Practice Setting Code Value Set (Preferred) |
location | Σ | 0..* | Reference(Location) | Location(s) where service may be provided |
serviceName | Σ | 0..1 | string | Description of service as presented to a consumer while searching |
comment | Σ | 0..1 | string | Additional description and/or any specific issues not covered elsewhere |
extraDetails | 0..1 | string | Extra details about the service that can't be placed in the other fields | |
photo | Σ | 0..1 | Attachment | Facilitates quick identification of the service |
telecom | 0..* | ContactPoint | Contacts related to the healthcare service | |
coverageArea | 0..* | Reference(Location) | Location(s) service is inteded for/available to | |
serviceProvisionCode | 0..* | CodeableConcept | Conditions under which service is available/offered ServiceProvisionConditions (Example) | |
eligibility | 0..1 | CodeableConcept | Specific eligibility requirements required to use the service | |
eligibilityNote | 0..1 | string | Describes the eligibility conditions for the service | |
programName | 0..* | string | Program Names that categorize the service | |
characteristic | 0..* | CodeableConcept | Collection of characteristics (attributes) | |
referralMethod | 0..* | CodeableConcept | Ways that the service accepts referrals ReferralMethod (Example) | |
publicKey | 0..1 | string | PKI Public keys to support secure communications | |
appointmentRequired | 0..1 | boolean | If an appointment is required for access to this service | |
availableTime | 0..* | BackboneElement | Times the Service Site is available | |
daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun DaysOfWeek (Required) | |
allDay | 0..1 | boolean | Always available? e.g. 24 hour service | |
availableStartTime | 0..1 | time | Opening time of day (ignored if allDay = true) | |
availableEndTime | 0..1 | time | Closing time of day (ignored if allDay = true) | |
notAvailable | 0..* | BackboneElement | Not available during this time due to provided reason | |
description | 1..1 | string | Reason presented to the user explaining why time not available | |
during | 0..1 | Period | Service not availablefrom this date | |
availabilityExceptions | 0..1 | string | Description of availability exceptions | |
endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location | |
Documentation for this format |
XML Template
<HealthcareService xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier External identifiers for this item --></identifier> <active value="[boolean]"/><!-- 0..1 Whether this healthcareservice is in active use --> <providedBy><!-- 0..1 Reference(Organization) Organization that provides this service --></providedBy> <serviceCategory><!-- 0..1 CodeableConcept Broad category of service being performed or delivered --></serviceCategory> <serviceType><!-- 0..* CodeableConcept Type of service that may be delivered or performed --></serviceType> <specialty><!-- 0..* CodeableConcept Specialties handled by the HealthcareService --></specialty> <location><!-- 0..* Reference(Location) Location(s) where service may be provided --></location> <serviceName value="[string]"/><!-- 0..1 Description of service as presented to a consumer while searching --> <comment value="[string]"/><!-- 0..1 Additional description and/or any specific issues not covered elsewhere --> <extraDetails value="[string]"/><!-- 0..1 Extra details about the service that can't be placed in the other fields --> <photo><!-- 0..1 Attachment Facilitates quick identification of the service --></photo> <telecom><!-- 0..* ContactPoint Contacts related to the healthcare service --></telecom> <coverageArea><!-- 0..* Reference(Location) Location(s) service is inteded for/available to --></coverageArea> <serviceProvisionCode><!-- 0..* CodeableConcept Conditions under which service is available/offered --></serviceProvisionCode> <eligibility><!-- 0..1 CodeableConcept Specific eligibility requirements required to use the service --></eligibility> <eligibilityNote value="[string]"/><!-- 0..1 Describes the eligibility conditions for the service --> <programName value="[string]"/><!-- 0..* Program Names that categorize the service --> <characteristic><!-- 0..* CodeableConcept Collection of characteristics (attributes) --></characteristic> <referralMethod><!-- 0..* CodeableConcept Ways that the service accepts referrals --></referralMethod> <publicKey value="[string]"/><!-- 0..1 PKI Public keys to support secure communications --> <appointmentRequired value="[boolean]"/><!-- 0..1 If an appointment is required for access to this service --> <availableTime> <!-- 0..* Times the Service Site is available --> <daysOfWeek value="[code]"/><!-- 0..* mon | tue | wed | thu | fri | sat | sun --> <allDay value="[boolean]"/><!-- 0..1 Always available? e.g. 24 hour service --> <availableStartTime value="[time]"/><!-- 0..1 Opening time of day (ignored if allDay = true) --> <availableEndTime value="[time]"/><!-- 0..1 Closing time of day (ignored if allDay = true) --> </availableTime> <notAvailable> <!-- 0..* Not available during this time due to provided reason --> <description value="[string]"/><!-- 1..1 Reason presented to the user explaining why time not available --> <during><!-- 0..1 Period Service not availablefrom this date --></during> </notAvailable> <availabilityExceptions value="[string]"/><!-- 0..1 Description of availability exceptions --> <endpoint><!-- 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the location --></endpoint> </HealthcareService>
JSON Template
{ "resourceType" : "HealthcareService", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "identifier" : [{ Identifier }], // External identifiers for this item "active" : <boolean>, // Whether this healthcareservice is in active use "providedBy" : { Reference(Organization) }, // Organization that provides this service "serviceCategory" : { CodeableConcept }, // Broad category of service being performed or delivered "serviceType" : [{ CodeableConcept }], // Type of service that may be delivered or performed "specialty" : [{ CodeableConcept }], // Specialties handled by the HealthcareService "location" : [{ Reference(Location) }], // Location(s) where service may be provided "serviceName" : "<string>", // Description of service as presented to a consumer while searching "comment" : "<string>", // Additional description and/or any specific issues not covered elsewhere "extraDetails" : "<string>", // Extra details about the service that can't be placed in the other fields "photo" : { Attachment }, // Facilitates quick identification of the service "telecom" : [{ ContactPoint }], // Contacts related to the healthcare service "coverageArea" : [{ Reference(Location) }], // Location(s) service is inteded for/available to "serviceProvisionCode" : [{ CodeableConcept }], // Conditions under which service is available/offered "eligibility" : { CodeableConcept }, // Specific eligibility requirements required to use the service "eligibilityNote" : "<string>", // Describes the eligibility conditions for the service "programName" : ["<string>"], // Program Names that categorize the service "characteristic" : [{ CodeableConcept }], // Collection of characteristics (attributes) "referralMethod" : [{ CodeableConcept }], // Ways that the service accepts referrals "publicKey" : "<string>", // PKI Public keys to support secure communications "appointmentRequired" : <boolean>, // If an appointment is required for access to this service "availableTime" : [{ // Times the Service Site is available "daysOfWeek" : ["<code>"], // mon | tue | wed | thu | fri | sat | sun "allDay" : <boolean>, // Always available? e.g. 24 hour service "availableStartTime" : "<time>", // Opening time of day (ignored if allDay = true) "availableEndTime" : "<time>" // Closing time of day (ignored if allDay = true) }], "notAvailable" : [{ // Not available during this time due to provided reason "description" : "<string>", // R! Reason presented to the user explaining why time not available "during" : { Period } // Service not availablefrom this date }], "availabilityExceptions" : "<string>", // Description of availability exceptions "endpoint" : [{ Reference(Endpoint) }] // Technical endpoints providing access to services operated for the location }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:HealthcareService; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:HealthcareService.identifier [ Identifier ], ... ; # 0..* External identifiers for this item fhir:HealthcareService.active [ boolean ]; # 0..1 Whether this healthcareservice is in active use fhir:HealthcareService.providedBy [ Reference(Organization) ]; # 0..1 Organization that provides this service fhir:HealthcareService.serviceCategory [ CodeableConcept ]; # 0..1 Broad category of service being performed or delivered fhir:HealthcareService.serviceType [ CodeableConcept ], ... ; # 0..* Type of service that may be delivered or performed fhir:HealthcareService.specialty [ CodeableConcept ], ... ; # 0..* Specialties handled by the HealthcareService fhir:HealthcareService.location [ Reference(Location) ], ... ; # 0..* Location(s) where service may be provided fhir:HealthcareService.serviceName [ string ]; # 0..1 Description of service as presented to a consumer while searching fhir:HealthcareService.comment [ string ]; # 0..1 Additional description and/or any specific issues not covered elsewhere fhir:HealthcareService.extraDetails [ string ]; # 0..1 Extra details about the service that can't be placed in the other fields fhir:HealthcareService.photo [ Attachment ]; # 0..1 Facilitates quick identification of the service fhir:HealthcareService.telecom [ ContactPoint ], ... ; # 0..* Contacts related to the healthcare service fhir:HealthcareService.coverageArea [ Reference(Location) ], ... ; # 0..* Location(s) service is inteded for/available to fhir:HealthcareService.serviceProvisionCode [ CodeableConcept ], ... ; # 0..* Conditions under which service is available/offered fhir:HealthcareService.eligibility [ CodeableConcept ]; # 0..1 Specific eligibility requirements required to use the service fhir:HealthcareService.eligibilityNote [ string ]; # 0..1 Describes the eligibility conditions for the service fhir:HealthcareService.programName [ string ], ... ; # 0..* Program Names that categorize the service fhir:HealthcareService.characteristic [ CodeableConcept ], ... ; # 0..* Collection of characteristics (attributes) fhir:HealthcareService.referralMethod [ CodeableConcept ], ... ; # 0..* Ways that the service accepts referrals fhir:HealthcareService.publicKey [ string ]; # 0..1 PKI Public keys to support secure communications fhir:HealthcareService.appointmentRequired [ boolean ]; # 0..1 If an appointment is required for access to this service fhir:HealthcareService.availableTime [ # 0..* Times the Service Site is available fhir:HealthcareService.availableTime.daysOfWeek [ code ], ... ; # 0..* mon | tue | wed | thu | fri | sat | sun fhir:HealthcareService.availableTime.allDay [ boolean ]; # 0..1 Always available? e.g. 24 hour service fhir:HealthcareService.availableTime.availableStartTime [ time ]; # 0..1 Opening time of day (ignored if allDay = true) fhir:HealthcareService.availableTime.availableEndTime [ time ]; # 0..1 Closing time of day (ignored if allDay = true) ], ...; fhir:HealthcareService.notAvailable [ # 0..* Not available during this time due to provided reason fhir:HealthcareService.notAvailable.description [ string ]; # 1..1 Reason presented to the user explaining why time not available fhir:HealthcareService.notAvailable.during [ Period ]; # 0..1 Service not availablefrom this date ], ...; fhir:HealthcareService.availabilityExceptions [ string ]; # 0..1 Description of availability exceptions fhir:HealthcareService.endpoint [ Reference(Endpoint) ], ... ; # 0..* Technical endpoints providing access to services operated for the location ]
Changes since DSTU2
HealthcareService | |
HealthcareService.active | added Element |
HealthcareService.serviceType | Type changed from BackboneElement to CodeableConcept |
HealthcareService.specialty | added Element |
HealthcareService.location |
Min Cardinality changed from 1 to 0 Max Cardinality changed from 1 to * |
HealthcareService.endpoint | added Element |
HealthcareService.serviceType.type | deleted |
HealthcareService.serviceType.specialty | deleted |
See the Full Difference for further information
Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle), JSON-LD (for RDF as JSON-LD),
Path | Definition | Type | Reference |
---|---|---|---|
HealthcareService.serviceCategory | A category of the service(s) that could be provided. | Example | ServiceCategory |
HealthcareService.serviceType | Additional details about where the content was created (e.g. clinical specialty). | Example | ServiceType |
HealthcareService.specialty | A specialty that a healthcare service may provide. | Preferred | Practice Setting Code Value Set |
HealthcareService.serviceProvisionCode | The code(s) that detail the conditions under which the healthcare service is available/offered. | Example | ServiceProvisionConditions |
HealthcareService.eligibility | Coded values underwhich a specific service is made available. | Unknown | No details provided yet |
HealthcareService.characteristic | A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | Unknown | No details provided yet |
HealthcareService.referralMethod | The methods of referral can be used when referring to a specific HealthCareService resource. | Example | ReferralMethod |
HealthcareService.availableTime.daysOfWeek | The days of the week. | Required | DaysOfWeek |
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
Name | Type | Description | Paths | In Common |
active | token | The Healthcare Service is currently marked as active | HealthcareService.active | |
characteristic | token | One of the HealthcareService's characteristics | HealthcareService.characteristic | |
endpoint | reference | Technical endpoints providing access to services operated for the location | HealthcareService.endpoint (Endpoint) | |
identifier | token | External identifiers for this item | HealthcareService.identifier | |
location | reference | The location of the Healthcare Service | HealthcareService.location (Location) | |
name | string | A portion of the Healthcare service name | HealthcareService.serviceName | |
organization | reference | The organization that provides this Healthcare Service | HealthcareService.providedBy (Organization) | |
programname | string | One of the Program Names serviced by this HealthcareService | HealthcareService.programName | |
servicecategory | token | Service Category of the Healthcare Service | HealthcareService.serviceCategory | |
servicetype | token | The type of service provided by this healthcare service | HealthcareService.serviceType |