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 |
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.
The HealthcareService resource is used with the following resources:
Structure
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
HealthcareService | TU | DomainResource | The details of a healthcare service available at a location Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |||||
identifier | Σ | 0..* | Identifier | External identifiers for this item | ||||
active | ?!Σ | 0..1 | boolean | Whether this HealthcareService record is in active use | ||||
providedBy | Σ | 0..1 | Reference(Organization) | Organization that provides this service | ||||
offeredIn | 0..* | Reference(HealthcareService) | The service within which this service is offered | |||||
category | Σ | 0..* | CodeableConcept | Broad category of service being performed or delivered Binding: Service Category (Example) | ||||
type | Σ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: Service Type (Example) | ||||
specialty | Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: Practice Setting Code Value Set (Preferred) | ||||
location | Σ | 0..* | Reference(Location) | Location(s) where service may be provided | ||||
name | Σ | 0..1 | string | Description of service as presented to a consumer while searching | ||||
comment | Σ | 0..1 | markdown | Additional description and/or any specific issues not covered elsewhere | ||||
extraDetails | 0..1 | markdown | Extra details about the service that can't be placed in the other fields | |||||
photo | Σ | 0..1 | Attachment | Facilitates quick identification of the service | ||||
contact | 0..* | ExtendedContactDetail | Official contact details for the HealthcareService | |||||
coverageArea | 0..* | Reference(Location) | Location(s) service is intended for/available to | |||||
serviceProvisionCode | 0..* | CodeableConcept | Conditions under which service is available/offered Binding: Service Provision Conditions (Example) | |||||
eligibility | C | 0..* | BackboneElement | Specific eligibility requirements required to use the service + Rule: To use an eligibility value a code must also be provided to determine the type of eligibility the value applies to. | ||||
code | C | 0..1 | CodeableConcept | Coded value for the eligibility Binding: Eligibility Characteristics (Example) | ||||
value[x] | C | 0..1 | Value associated with the eligibility code | |||||
valueCodeableConcept | CodeableConcept | |||||||
valueBoolean | boolean | |||||||
valueQuantity | Quantity | |||||||
valueRange | Range | |||||||
valueReference | Reference() | |||||||
comment | 0..1 | markdown | Describes the eligibility conditions for the service | |||||
period | 0..1 | markdown | The period this eligibility rule applies | |||||
program | 0..* | CodeableConcept | Programs that this service is applicable to Binding: Program (Example) | |||||
characteristic | 0..* | CodeableConcept | Collection of characteristics (attributes) Binding: Service Mode (Example) | |||||
communication | 0..* | CodeableConcept | The language that this service is offered in Binding: All Languages (Required)
| |||||
referralMethod | 0..* | CodeableConcept | Ways that the service accepts referrals Binding: Referral Method (Example) | |||||
referralRequired | 0..1 | boolean | A referral is required for access to this service | |||||
appointmentRequired | 0..1 | boolean | An appointment is required for access to this service | |||||
availability | 0..1 | Availability | Times the healthcare service is available (including exceptions) | |||||
endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service | |||||
Documentation for this format |
See the Extensions for this resource
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 record is in active use --> <providedBy><!-- 0..1 Reference(Organization) Organization that provides this service --></providedBy> <offeredIn><!-- 0..* Reference(HealthcareService) The service within which this service is offered --></offeredIn> <category><!-- 0..* CodeableConcept Broad category of service being performed or delivered --></category> <type><!-- 0..* CodeableConcept Type of service that may be delivered or performed --></type> <specialty><!-- 0..* CodeableConcept Specialties handled by the HealthcareService --></specialty> <location><!-- 0..* Reference(Location) Location(s) where service may be provided --></location> <name value="[string]"/><!-- 0..1 Description of service as presented to a consumer while searching --> <comment value="[markdown]"/><!-- 0..1 Additional description and/or any specific issues not covered elsewhere --> <extraDetails value="[markdown]"/><!-- 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> <contact><!-- 0..* ExtendedContactDetail Official contact details for the HealthcareService --></contact> <coverageArea><!-- 0..* Reference(Location) Location(s) service is intended for/available to --></coverageArea> <serviceProvisionCode><!-- 0..* CodeableConcept Conditions under which service is available/offered --></serviceProvisionCode> <eligibility> <!-- 0..* Specific eligibility requirements required to use the service --> <code><!-- I 0..1 CodeableConcept Coded value for the eligibility --></code> <value[x]><!-- I 0..1 CodeableConcept|boolean|Quantity|Range|Reference Value associated with the eligibility code --></value[x]> <comment value="[markdown]"/><!-- 0..1 Describes the eligibility conditions for the service --> <period value="[markdown]"/><!-- 0..1 The period this eligibility rule applies --> </eligibility> <program><!-- 0..* CodeableConcept Programs that this service is applicable to --></program> <characteristic><!-- 0..* CodeableConcept Collection of characteristics (attributes) --></characteristic> <communication><!-- 0..* CodeableConcept The language that this service is offered in --></communication> <referralMethod><!-- 0..* CodeableConcept Ways that the service accepts referrals --></referralMethod> <referralRequired value="[boolean]"/><!-- 0..1 A referral is required for access to this service --> <appointmentRequired value="[boolean]"/><!-- 0..1 An appointment is required for access to this service --> <availability><!-- 0..1 Availability Times the healthcare service is available (including exceptions) --></availability> <endpoint><!-- 0..* Reference(Endpoint) Technical endpoints providing access to electronic services operated for the healthcare service --></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 record is in active use "providedBy" : { Reference(Organization) }, // Organization that provides this service "offeredIn" : [{ Reference(HealthcareService) }], // The service within which this service is offered "category" : [{ CodeableConcept }], // Broad category of service being performed or delivered "type" : [{ 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 "name" : "<string>", // Description of service as presented to a consumer while searching "comment" : "<markdown>", // Additional description and/or any specific issues not covered elsewhere "extraDetails" : "<markdown>", // Extra details about the service that can't be placed in the other fields "photo" : { Attachment }, // Facilitates quick identification of the service "contact" : [{ ExtendedContactDetail }], // Official contact details for the HealthcareService "coverageArea" : [{ Reference(Location) }], // Location(s) service is intended for/available to "serviceProvisionCode" : [{ CodeableConcept }], // Conditions under which service is available/offered "eligibility" : [{ // Specific eligibility requirements required to use the service "code" : { CodeableConcept }, // I Coded value for the eligibility // value[x]: Value associated with the eligibility code. One of these 5: "valueCodeableConcept" : { CodeableConcept }, "valueBoolean" : <boolean>, "valueQuantity" : { Quantity }, "valueRange" : { Range }, "valueReference" : { Reference }, "comment" : "<markdown>", // Describes the eligibility conditions for the service "period" : "<markdown>" // The period this eligibility rule applies }], "program" : [{ CodeableConcept }], // Programs that this service is applicable to "characteristic" : [{ CodeableConcept }], // Collection of characteristics (attributes) "communication" : [{ CodeableConcept }], // The language that this service is offered in "referralMethod" : [{ CodeableConcept }], // Ways that the service accepts referrals "referralRequired" : <boolean>, // A referral is required for access to this service "appointmentRequired" : <boolean>, // An appointment is required for access to this service "availability" : { Availability }, // Times the healthcare service is available (including exceptions) "endpoint" : [{ Reference(Endpoint) }] // Technical endpoints providing access to electronic services operated for the healthcare service }
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:identifier ( [ Identifier ] ... ) ; # 0..* External identifiers for this item fhir:active [ boolean ] ; # 0..1 Whether this HealthcareService record is in active use fhir:providedBy [ Reference(Organization) ] ; # 0..1 Organization that provides this service fhir:offeredIn ( [ Reference(HealthcareService) ] ... ) ; # 0..* The service within which this service is offered fhir:category ( [ CodeableConcept ] ... ) ; # 0..* Broad category of service being performed or delivered fhir:type ( [ CodeableConcept ] ... ) ; # 0..* Type of service that may be delivered or performed fhir:specialty ( [ CodeableConcept ] ... ) ; # 0..* Specialties handled by the HealthcareService fhir:location ( [ Reference(Location) ] ... ) ; # 0..* Location(s) where service may be provided fhir:name [ string ] ; # 0..1 Description of service as presented to a consumer while searching fhir:comment [ markdown ] ; # 0..1 Additional description and/or any specific issues not covered elsewhere fhir:extraDetails [ markdown ] ; # 0..1 Extra details about the service that can't be placed in the other fields fhir:photo [ Attachment ] ; # 0..1 Facilitates quick identification of the service fhir:contact ( [ ExtendedContactDetail ] ... ) ; # 0..* Official contact details for the HealthcareService fhir:coverageArea ( [ Reference(Location) ] ... ) ; # 0..* Location(s) service is intended for/available to fhir:serviceProvisionCode ( [ CodeableConcept ] ... ) ; # 0..* Conditions under which service is available/offered fhir:eligibility ( [ # 0..* Specific eligibility requirements required to use the service fhir:code [ CodeableConcept ] ; # 0..1 I Coded value for the eligibility # value[x] : 0..1 I Value associated with the eligibility code. One of these 5 fhir:value [ a fhir:CodeableConcept ; CodeableConcept ] fhir:value [ a fhir:boolean ; boolean ] fhir:value [ a fhir:Quantity ; Quantity ] fhir:value [ a fhir:Range ; Range ] fhir:value [ a fhir:Reference ; Reference ] fhir:comment [ markdown ] ; # 0..1 Describes the eligibility conditions for the service fhir:period [ markdown ] ; # 0..1 The period this eligibility rule applies ] ... ) ; fhir:program ( [ CodeableConcept ] ... ) ; # 0..* Programs that this service is applicable to fhir:characteristic ( [ CodeableConcept ] ... ) ; # 0..* Collection of characteristics (attributes) fhir:communication ( [ CodeableConcept ] ... ) ; # 0..* The language that this service is offered in fhir:referralMethod ( [ CodeableConcept ] ... ) ; # 0..* Ways that the service accepts referrals fhir:referralRequired [ boolean ] ; # 0..1 A referral is required for access to this service fhir:appointmentRequired [ boolean ] ; # 0..1 An appointment is required for access to this service fhir:availability [ Availability ] ; # 0..1 Times the healthcare service is available (including exceptions) fhir:endpoint ( [ Reference(Endpoint) ] ... ) ; # 0..* Technical endpoints providing access to electronic services operated for the healthcare service ]
Changes from both R4 and R4B
HealthcareService | |
HealthcareService.offeredIn |
|
HealthcareService.comment |
|
HealthcareService.contact |
|
HealthcareService.eligibility.value[x] |
|
HealthcareService.eligibility.period |
|
HealthcareService.communication |
|
HealthcareService.referralRequired |
|
HealthcareService.availability |
|
HealthcareService.telecom |
|
HealthcareService.availableTime |
|
HealthcareService.notAvailable |
|
HealthcareService.availabilityExceptions |
|
See the Full Difference for further information
This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.
Structure
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
HealthcareService | TU | DomainResource | The details of a healthcare service available at a location Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |||||
identifier | Σ | 0..* | Identifier | External identifiers for this item | ||||
active | ?!Σ | 0..1 | boolean | Whether this HealthcareService record is in active use | ||||
providedBy | Σ | 0..1 | Reference(Organization) | Organization that provides this service | ||||
offeredIn | 0..* | Reference(HealthcareService) | The service within which this service is offered | |||||
category | Σ | 0..* | CodeableConcept | Broad category of service being performed or delivered Binding: Service Category (Example) | ||||
type | Σ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: Service Type (Example) | ||||
specialty | Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: Practice Setting Code Value Set (Preferred) | ||||
location | Σ | 0..* | Reference(Location) | Location(s) where service may be provided | ||||
name | Σ | 0..1 | string | Description of service as presented to a consumer while searching | ||||
comment | Σ | 0..1 | markdown | Additional description and/or any specific issues not covered elsewhere | ||||
extraDetails | 0..1 | markdown | Extra details about the service that can't be placed in the other fields | |||||
photo | Σ | 0..1 | Attachment | Facilitates quick identification of the service | ||||
contact | 0..* | ExtendedContactDetail | Official contact details for the HealthcareService | |||||
coverageArea | 0..* | Reference(Location) | Location(s) service is intended for/available to | |||||
serviceProvisionCode | 0..* | CodeableConcept | Conditions under which service is available/offered Binding: Service Provision Conditions (Example) | |||||
eligibility | C | 0..* | BackboneElement | Specific eligibility requirements required to use the service + Rule: To use an eligibility value a code must also be provided to determine the type of eligibility the value applies to. | ||||
code | C | 0..1 | CodeableConcept | Coded value for the eligibility Binding: Eligibility Characteristics (Example) | ||||
value[x] | C | 0..1 | Value associated with the eligibility code | |||||
valueCodeableConcept | CodeableConcept | |||||||
valueBoolean | boolean | |||||||
valueQuantity | Quantity | |||||||
valueRange | Range | |||||||
valueReference | Reference() | |||||||
comment | 0..1 | markdown | Describes the eligibility conditions for the service | |||||
period | 0..1 | markdown | The period this eligibility rule applies | |||||
program | 0..* | CodeableConcept | Programs that this service is applicable to Binding: Program (Example) | |||||
characteristic | 0..* | CodeableConcept | Collection of characteristics (attributes) Binding: Service Mode (Example) | |||||
communication | 0..* | CodeableConcept | The language that this service is offered in Binding: All Languages (Required)
| |||||
referralMethod | 0..* | CodeableConcept | Ways that the service accepts referrals Binding: Referral Method (Example) | |||||
referralRequired | 0..1 | boolean | A referral is required for access to this service | |||||
appointmentRequired | 0..1 | boolean | An appointment is required for access to this service | |||||
availability | 0..1 | Availability | Times the healthcare service is available (including exceptions) | |||||
endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service | |||||
Documentation for this format |
See the Extensions for this resource
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 record is in active use --> <providedBy><!-- 0..1 Reference(Organization) Organization that provides this service --></providedBy> <offeredIn><!-- 0..* Reference(HealthcareService) The service within which this service is offered --></offeredIn> <category><!-- 0..* CodeableConcept Broad category of service being performed or delivered --></category> <type><!-- 0..* CodeableConcept Type of service that may be delivered or performed --></type> <specialty><!-- 0..* CodeableConcept Specialties handled by the HealthcareService --></specialty> <location><!-- 0..* Reference(Location) Location(s) where service may be provided --></location> <name value="[string]"/><!-- 0..1 Description of service as presented to a consumer while searching --> <comment value="[markdown]"/><!-- 0..1 Additional description and/or any specific issues not covered elsewhere --> <extraDetails value="[markdown]"/><!-- 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> <contact><!-- 0..* ExtendedContactDetail Official contact details for the HealthcareService --></contact> <coverageArea><!-- 0..* Reference(Location) Location(s) service is intended for/available to --></coverageArea> <serviceProvisionCode><!-- 0..* CodeableConcept Conditions under which service is available/offered --></serviceProvisionCode> <eligibility> <!-- 0..* Specific eligibility requirements required to use the service --> <code><!-- I 0..1 CodeableConcept Coded value for the eligibility --></code> <value[x]><!-- I 0..1 CodeableConcept|boolean|Quantity|Range|Reference Value associated with the eligibility code --></value[x]> <comment value="[markdown]"/><!-- 0..1 Describes the eligibility conditions for the service --> <period value="[markdown]"/><!-- 0..1 The period this eligibility rule applies --> </eligibility> <program><!-- 0..* CodeableConcept Programs that this service is applicable to --></program> <characteristic><!-- 0..* CodeableConcept Collection of characteristics (attributes) --></characteristic> <communication><!-- 0..* CodeableConcept The language that this service is offered in --></communication> <referralMethod><!-- 0..* CodeableConcept Ways that the service accepts referrals --></referralMethod> <referralRequired value="[boolean]"/><!-- 0..1 A referral is required for access to this service --> <appointmentRequired value="[boolean]"/><!-- 0..1 An appointment is required for access to this service --> <availability><!-- 0..1 Availability Times the healthcare service is available (including exceptions) --></availability> <endpoint><!-- 0..* Reference(Endpoint) Technical endpoints providing access to electronic services operated for the healthcare service --></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 record is in active use "providedBy" : { Reference(Organization) }, // Organization that provides this service "offeredIn" : [{ Reference(HealthcareService) }], // The service within which this service is offered "category" : [{ CodeableConcept }], // Broad category of service being performed or delivered "type" : [{ 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 "name" : "<string>", // Description of service as presented to a consumer while searching "comment" : "<markdown>", // Additional description and/or any specific issues not covered elsewhere "extraDetails" : "<markdown>", // Extra details about the service that can't be placed in the other fields "photo" : { Attachment }, // Facilitates quick identification of the service "contact" : [{ ExtendedContactDetail }], // Official contact details for the HealthcareService "coverageArea" : [{ Reference(Location) }], // Location(s) service is intended for/available to "serviceProvisionCode" : [{ CodeableConcept }], // Conditions under which service is available/offered "eligibility" : [{ // Specific eligibility requirements required to use the service "code" : { CodeableConcept }, // I Coded value for the eligibility // value[x]: Value associated with the eligibility code. One of these 5: "valueCodeableConcept" : { CodeableConcept }, "valueBoolean" : <boolean>, "valueQuantity" : { Quantity }, "valueRange" : { Range }, "valueReference" : { Reference }, "comment" : "<markdown>", // Describes the eligibility conditions for the service "period" : "<markdown>" // The period this eligibility rule applies }], "program" : [{ CodeableConcept }], // Programs that this service is applicable to "characteristic" : [{ CodeableConcept }], // Collection of characteristics (attributes) "communication" : [{ CodeableConcept }], // The language that this service is offered in "referralMethod" : [{ CodeableConcept }], // Ways that the service accepts referrals "referralRequired" : <boolean>, // A referral is required for access to this service "appointmentRequired" : <boolean>, // An appointment is required for access to this service "availability" : { Availability }, // Times the healthcare service is available (including exceptions) "endpoint" : [{ Reference(Endpoint) }] // Technical endpoints providing access to electronic services operated for the healthcare service }
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:identifier ( [ Identifier ] ... ) ; # 0..* External identifiers for this item fhir:active [ boolean ] ; # 0..1 Whether this HealthcareService record is in active use fhir:providedBy [ Reference(Organization) ] ; # 0..1 Organization that provides this service fhir:offeredIn ( [ Reference(HealthcareService) ] ... ) ; # 0..* The service within which this service is offered fhir:category ( [ CodeableConcept ] ... ) ; # 0..* Broad category of service being performed or delivered fhir:type ( [ CodeableConcept ] ... ) ; # 0..* Type of service that may be delivered or performed fhir:specialty ( [ CodeableConcept ] ... ) ; # 0..* Specialties handled by the HealthcareService fhir:location ( [ Reference(Location) ] ... ) ; # 0..* Location(s) where service may be provided fhir:name [ string ] ; # 0..1 Description of service as presented to a consumer while searching fhir:comment [ markdown ] ; # 0..1 Additional description and/or any specific issues not covered elsewhere fhir:extraDetails [ markdown ] ; # 0..1 Extra details about the service that can't be placed in the other fields fhir:photo [ Attachment ] ; # 0..1 Facilitates quick identification of the service fhir:contact ( [ ExtendedContactDetail ] ... ) ; # 0..* Official contact details for the HealthcareService fhir:coverageArea ( [ Reference(Location) ] ... ) ; # 0..* Location(s) service is intended for/available to fhir:serviceProvisionCode ( [ CodeableConcept ] ... ) ; # 0..* Conditions under which service is available/offered fhir:eligibility ( [ # 0..* Specific eligibility requirements required to use the service fhir:code [ CodeableConcept ] ; # 0..1 I Coded value for the eligibility # value[x] : 0..1 I Value associated with the eligibility code. One of these 5 fhir:value [ a fhir:CodeableConcept ; CodeableConcept ] fhir:value [ a fhir:boolean ; boolean ] fhir:value [ a fhir:Quantity ; Quantity ] fhir:value [ a fhir:Range ; Range ] fhir:value [ a fhir:Reference ; Reference ] fhir:comment [ markdown ] ; # 0..1 Describes the eligibility conditions for the service fhir:period [ markdown ] ; # 0..1 The period this eligibility rule applies ] ... ) ; fhir:program ( [ CodeableConcept ] ... ) ; # 0..* Programs that this service is applicable to fhir:characteristic ( [ CodeableConcept ] ... ) ; # 0..* Collection of characteristics (attributes) fhir:communication ( [ CodeableConcept ] ... ) ; # 0..* The language that this service is offered in fhir:referralMethod ( [ CodeableConcept ] ... ) ; # 0..* Ways that the service accepts referrals fhir:referralRequired [ boolean ] ; # 0..1 A referral is required for access to this service fhir:appointmentRequired [ boolean ] ; # 0..1 An appointment is required for access to this service fhir:availability [ Availability ] ; # 0..1 Times the healthcare service is available (including exceptions) fhir:endpoint ( [ Reference(Endpoint) ] ... ) ; # 0..* Technical endpoints providing access to electronic services operated for the healthcare service ]
Changes from both R4 and R4B
HealthcareService | |
HealthcareService.offeredIn |
|
HealthcareService.comment |
|
HealthcareService.contact |
|
HealthcareService.eligibility.value[x] |
|
HealthcareService.eligibility.period |
|
HealthcareService.communication |
|
HealthcareService.referralRequired |
|
HealthcareService.availability |
|
HealthcareService.telecom |
|
HealthcareService.availableTime |
|
HealthcareService.notAvailable |
|
HealthcareService.availabilityExceptions |
|
See the Full Difference for further information
This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.
Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis
Path | ValueSet | Type | Documentation |
---|---|---|---|
HealthcareService.category | ServiceCategory | Example | This value set defines an example set of codes that can be used to classify groupings of service-types/specialties. |
HealthcareService.type | ServiceType | Example | This value set defines an example set of codes of service-types. |
HealthcareService.specialty | PracticeSettingCodeValueSet | Preferred | This is the code representing the clinical specialty of the clinician or provider who interacted with, treated, or provided a service to/for the patient. The value set used for clinical specialty has been limited by HITSP to the value set reproduced from HITSP C80 Table 2-149 Clinical Specialty Value Set Definition. |
HealthcareService.serviceProvisionCode | ServiceProvisionConditions | Example | The code(s) that detail the conditions under which the healthcare service is available/offered. |
HealthcareService.eligibility.code | Eligibility (a valid code from Eligibility Characteristics) | Example | Example set of HealthcareService eligibility codes |
HealthcareService.program | Program | Example | This value set defines an example set of codes that could be can be used to classify groupings of service-types/specialties. |
HealthcareService.characteristic | ServiceMode | Example | An example set of Service Modes that could be applicable to use to characterize HealthcareServices or PractitionerRoles while searching |
HealthcareService.communication | AllLanguages (a valid code from Tags for the Identification of Languages ) | Required | This value set includes all possible codes from BCP-47 (see http://tools.ietf.org/html/bcp47) |
Common Languages | starter | ||
HealthcareService.referralMethod | ReferralMethod | Example | The methods of referral can be used when referring to a specific HealthcareService resource. |
UniqueKey | Level | Location | Description | Expression |
hcs-1 | Rule | HealthcareService.eligibility | To use an eligibility value a code must also be provided to determine the type of eligibility the value applies to. | value.exists() implies code.exists() |
When deciding to whether to use multiple locations on a single HealthcareService, or create multiple HealthcareService resources for each location on each you should consider:
Any/all of these factors could require constraining the use down to a single location on the resource and create separate HealthcareService resources covering the details of the referenced Location.
In a case where all this data is the same across all locations, then a single HealthcareService resource instance can be used with all the locations listed on it.
Note that if the contact/availability/endpoint details of the HealthcareService are the same as the Location, then these may be omitted from the HealthcareService and use the Location (thus reducing administrative burden)
Search parameters for this resource. See also the full list of search parameters for this resource, and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
Name | Type | Description | Expression | In Common |
active | token | The Healthcare Service is currently marked as active | HealthcareService.active | |
characteristic | token | One of the HealthcareService's characteristics | HealthcareService.characteristic | |
communication | token | Languages that are available at this service | HealthcareService.communication | |
coverage-area | reference | Location(s) service is intended for/available to | HealthcareService.coverageArea (Location) |
|
eligibility | token | One of the HealthcareService's eligibility requirements | HealthcareService.eligibility.code | |
endpoint | reference | Technical endpoints providing access to electronic services operated for the healthcare service | 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.name | |
offered-in | reference | The service within which this service is offered | HealthcareService.offeredIn (HealthcareService) |
|
organization | reference | The organization that provides this Healthcare Service | HealthcareService.providedBy (Organization) |
|
program | token | One of the Programs supported by this HealthcareService | HealthcareService.program | |
service-category | token | Service Category of the Healthcare Service | HealthcareService.category | |
service-type | token | The type of service provided by this healthcare service | HealthcareService.type | |
specialty | token | The specialty of the service provided by this healthcare service | HealthcareService.specialty |