HealthcareService
The details of a healthcare service available at a location.
- Backends
- PostgreSQLElasticsearch
- Interactions
- CreateReadUpdatePatchDelete
- Search
- 12 of 12 parameters tested
Structure
| Element | Card. | Type | Description |
|---|---|---|---|
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 |
categoryΣ | 0..* | CodeableConcept | Broad category of service being performed or deliveredBinding (example): service-category |
typeΣ | 0..* | CodeableConcept | Type of service that may be delivered or performedBinding (example): service-type |
specialtyΣ | 0..* | CodeableConcept | Specialties handled by the HealthcareServiceBinding (preferred): c80-practice-codes |
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 | string | 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 |
telecom | 0..* | ContactPoint | Contacts related to the healthcare service |
coverageArea | 0..* | Reference(Location) | Location(s) service is intended for/available to |
serviceProvisionCode | 0..* | CodeableConcept | Conditions under which service is available/offeredBinding (example): service-provision-conditions |
eligibility | 0..* | BackboneElement | Specific eligibility requirements required to use the service |
code | 0..1 | CodeableConcept | Coded value for the eligibility |
comment | 0..1 | markdown | Describes the eligibility conditions for the service |
program | 0..* | CodeableConcept | Programs that this service is applicable toBinding (example): program |
characteristic | 0..* | CodeableConcept | Collection of characteristics (attributes) |
communication | 0..* | CodeableConcept | The language that this service is offered inBinding (preferred): languages |
referralMethod | 0..* | CodeableConcept | Ways that the service accepts referralsBinding (example): service-referral-method |
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 | sunBinding (required): days-of-week |
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 |
descriptionRequired | 1..1 | string | Reason presented to the user explaining why time not available |
during | 0..1 | Period | Service not available from this date |
availabilityExceptions | 0..1 | string | Description of availability exceptions |
endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service |
Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey
Search parameters
Query with GET [base]/HealthcareService?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.
| Parameter | Type | Description | PG | ES |
|---|---|---|---|---|
active | token | The Healthcare Service is currently marked as active HealthcareService.active | ||
characteristic | token | One of the HealthcareService's characteristics HealthcareService.characteristic | ||
coverage-area | reference | Location(s) service is intended for/available to HealthcareService.coverageArea | ||
endpoint | reference | Technical endpoints providing access to electronic services operated for the healthcare service HealthcareService.endpoint | ||
identifier | token | External identifiers for this item HealthcareService.identifier | ||
location | reference | The location of the Healthcare Service HealthcareService.location | ||
name | string | A portion of the Healthcare service name HealthcareService.name | ||
organization | reference | The organization that provides this Healthcare Service HealthcareService.providedBy | ||
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 |
PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet. The author of the resource Logical id of this artifact When the resource version last changed Profiles this resource claims to conform to Security Labels applied to this resource Identifies where the resource comes from Tags applied to this resource Derived from the R4B DefinitionCommon parameters on every resource (8)
_haste-health-authorreference _idtoken _lastUpdateddate _profileuri _securitytoken _sourceuri _tagtoken _typetoken