# HealthcareService

Canonical page: https://docs.ovok.com/api/fhir/r4/healthcare-service

The details of a healthcare service available at a location.

These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.

| **Interaction** | **Method** | **Path** |
| --- | --- | --- |
| Read | `GET` | `/fhir/R4/HealthcareService/[id]` |
| Vread | `GET` | `/fhir/R4/HealthcareService/[id]/_history/[vid]` |
| Update | `PUT` | `/fhir/R4/HealthcareService/[id]` |
| Patch | `PATCH` | `/fhir/R4/HealthcareService/[id]` |
| Delete | `DELETE` | `/fhir/R4/HealthcareService/[id]` |
| Create | `POST` | `/fhir/R4/HealthcareService` |
| Search | `GET` | `/fhir/R4/HealthcareService` |
| History | `GET` | `/fhir/R4/HealthcareService/[id]/_history` |

## Top-level elements [#top-level-elements]

| **Element** | **Type** | **Cardinality** | **Description** |
| --- | --- | --- | --- |
| <span id="element-id"></span>`id` | [string](/fhir-elements/primitive/string) | `0..1` | Logical id of this artifact |
| <span id="element-meta"></span>`meta` | [Meta](/fhir-elements/complex/meta) | `0..1` | Metadata about the resource |
| <span id="element-implicit-rules"></span>`implicitRules` | [uri](/fhir-elements/primitive/uri) | `0..1` | A set of rules under which this content was created |
| <span id="element-language"></span>`language` | [code](/fhir-elements/primitive/code) | `0..1` | Language of the resource content |
| <span id="element-text"></span>`text` | [Narrative](/fhir-elements/complex/narrative) | `0..1` | Text summary of the resource, for human interpretation |
| <span id="element-contained"></span>`contained` | [Resource](/fhir-elements/foundation/resource) | `0..*` | Contained, inline Resources |
| <span id="element-extension"></span>`extension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Additional content defined by implementations |
| <span id="element-modifier-extension"></span>`modifierExtension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Extensions that cannot be ignored |
| <span id="element-identifier"></span>`identifier` | [Identifier](/fhir-elements/complex/identifier) | `0..*` | External identifiers for this item |
| <span id="element-active"></span>`active` | [boolean](/fhir-elements/primitive/boolean) | `0..1` | Whether this HealthcareService record is in active use |
| <span id="element-provided-by"></span>`providedBy` | [Reference](/fhir-elements/complex/reference) | `0..1` | Organization that provides this service |
| <span id="element-category"></span>`category` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Broad category of service being performed or delivered |
| <span id="element-type"></span>`type` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Type of service that may be delivered or performed |
| <span id="element-specialty"></span>`specialty` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Specialties handled by the HealthcareService |
| <span id="element-location"></span>`location` | [Reference](/fhir-elements/complex/reference) | `0..*` | Location(s) where service may be provided |
| <span id="element-name"></span>`name` | [string](/fhir-elements/primitive/string) | `0..1` | Description of service as presented to a consumer while searching |
| <span id="element-comment"></span>`comment` | [string](/fhir-elements/primitive/string) | `0..1` | Additional description and/or any specific issues not covered elsewhere |
| <span id="element-extra-details"></span>`extraDetails` | [markdown](/fhir-elements/primitive/markdown) | `0..1` | Extra details about the service that can't be placed in the other fields |
| <span id="element-photo"></span>`photo` | [Attachment](/fhir-elements/complex/attachment) | `0..1` | Facilitates quick identification of the service |
| <span id="element-telecom"></span>`telecom` | [ContactPoint](/fhir-elements/complex/contact-point) | `0..*` | Contacts related to the healthcare service |
| <span id="element-coverage-area"></span>`coverageArea` | [Reference](/fhir-elements/complex/reference) | `0..*` | Location(s) service is intended for/available to |
| <span id="element-service-provision-code"></span>`serviceProvisionCode` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Conditions under which service is available/offered |
| <span id="element-eligibility"></span>`eligibility` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Specific eligibility requirements required to use the service |
| <span id="element-program"></span>`program` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Programs that this service is applicable to |
| <span id="element-characteristic"></span>`characteristic` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Collection of characteristics (attributes) |
| <span id="element-communication"></span>`communication` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | The language that this service is offered in |
| <span id="element-referral-method"></span>`referralMethod` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Ways that the service accepts referrals |
| <span id="element-appointment-required"></span>`appointmentRequired` | [boolean](/fhir-elements/primitive/boolean) | `0..1` | If an appointment is required for access to this service |
| <span id="element-available-time"></span>`availableTime` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Times the Service Site is available |
| <span id="element-not-available"></span>`notAvailable` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Not available during this time due to provided reason |
| <span id="element-availability-exceptions"></span>`availabilityExceptions` | [string](/fhir-elements/primitive/string) | `0..1` | Description of availability exceptions |
| <span id="element-endpoint"></span>`endpoint` | [Reference](/fhir-elements/complex/reference) | `0..*` | Technical endpoints providing access to electronic services operated for the healthcare service |

## Resource-specific search parameters [#resource-specific-search-parameters]

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| `active` | token | The Healthcare Service is currently marked as active |
| `characteristic` | token | One of the HealthcareService's characteristics |
| `coverage-area` | reference | Location(s) service is intended for/available to |
| `endpoint` | reference | Technical endpoints providing access to electronic services operated for the healthcare service |
| `identifier` | token | External identifiers for this item |
| `location` | reference | The location of the Healthcare Service |
| `name` | string | A portion of the Healthcare service name |
| `organization` | reference | The organization that provides this Healthcare Service |
| `program` | token | One of the Programs supported by this HealthcareService |
| `service-category` | token | Service Category of the Healthcare Service |
| `service-type` | token | The type of service provided by this healthcare service |
| `specialty` | token | The specialty of the service provided by this healthcare service |

## Reference [#reference]

Official FHIR R4 spec: [HealthcareService](https://hl7.org/fhir/R4/healthcareservice.html).  
Maturity: Trial Use 2 (FMM 2).
