HealthcareService
The details of a healthcare service available at a location.
Endpoints
alpha
https://api.dev.ovok.com/fhir/R4/HealthcareService| 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
| Element | Type(s) | Cardinality | Description |
|---|---|---|---|
identifier | Identifier | 0..* | External identifiers for this item |
active | boolean | 0..1 | Whether this HealthcareService record is in active use modifier |
providedBy | Reference | 0..1 | Organization that provides this service |
category | CodeableConcept | 0..* | Broad category of service being performed or delivered |
type | CodeableConcept | 0..* | Type of service that may be delivered or performed |
specialty | CodeableConcept | 0..* | Specialties handled by the HealthcareService |
location | Reference | 0..* | Location(s) where service may be provided |
name | string | 0..1 | Description of service as presented to a consumer while searching |
comment | string | 0..1 | Additional description and/or any specific issues not covered elsewhere |
extraDetails | markdown | 0..1 | Extra details about the service that can't be placed in the other fields |
photo | Attachment | 0..1 | Facilitates quick identification of the service |
telecom | ContactPoint | 0..* | Contacts related to the healthcare service |
coverageArea | Reference | 0..* | Location(s) service is intended for/available to |
serviceProvisionCode | CodeableConcept | 0..* | Conditions under which service is available/offered |
eligibility | BackboneElement | 0..* | Specific eligibility requirements required to use the service |
program | CodeableConcept | 0..* | Programs that this service is applicable to |
characteristic | CodeableConcept | 0..* | Collection of characteristics (attributes) |
communication | CodeableConcept | 0..* | The language that this service is offered in |
referralMethod | CodeableConcept | 0..* | Ways that the service accepts referrals |
appointmentRequired | boolean | 0..1 | If an appointment is required for access to this service |
availableTime | BackboneElement | 0..* | Times the Service Site is available |
notAvailable | BackboneElement | 0..* | Not available during this time due to provided reason |
availabilityExceptions | string | 0..1 | Description of availability exceptions |
endpoint | Reference | 0..* | Technical endpoints providing access to electronic services operated for the healthcare service |
Resource-specific search parameters
Reference
- Official FHIR R4 spec:
HealthcareService - Maturity: Trial Use 2 (FMM 2).