HealthcareService

Trial Use 4 Base

The details of a healthcare service available at a location or in a catalog. In the case where there is a hierarchy of services (for example, Lab -> Pathology -> Wound Cultures), this can be represented using a set of linked HealthcareServices.

Endpoints

devhttps://api.sandbox.ovok.com/fhir/R5/HealthcareService

Interaction	Method	Path
Read	GET	/fhir/R5/HealthcareService/[id]
Vread	GET	/fhir/R5/HealthcareService/[id]/_history/[vid]
Update	PUT	/fhir/R5/HealthcareService/[id]
Patch	PATCH	/fhir/R5/HealthcareService/[id]
Delete	DELETE	/fhir/R5/HealthcareService/[id]
Create	POST	/fhir/R5/HealthcareService
Search	GET	/fhir/R5/HealthcareService?...
History	GET	/fhir/R5/HealthcareService/[id]/_history
Type-history	GET	/fhir/R5/HealthcareService/_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
offeredIn	Reference	0..*	The service within which this service is offered
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	markdown	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
contact	ExtendedContactDetail	0..*	Official contact details for the HealthcareService
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
availability	Availability	0..*	Times the healthcare service is available (including exceptions)
endpoint	Reference	0..*	Technical endpoints providing access to electronic services operated for the healthcare service

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
communication	token	Languages that are available at this service
coverage-area	reference	Location(s) service is intended for/available to
eligibility	token	One of the HealthcareService's eligibility requirements
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
offered-in	reference	The service within which this service is offered
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

• Official FHIR R5 spec: HealthcareService
• Maturity: Trial Use 4 (FMM 4).