The HealthcareService resource implements the FHIR R4 HealthcareService specification

Fields

Name Type Cardinality Required Description
identifier Identifier 0..*   External identifiers for this item
active boolean 0..1   Whether this HealthcareService record is in active use
providedBy Reference(Organization) 0..1   Organization that provides this service
category CodeableConcept 0..*   Broad category of service being performed or delivered Service category ( Example )
type CodeableConcept 0..*   Type of service that may be delivered or performed Service type ( Example )
specialty CodeableConcept 0..*   Specialties handled by the HealthcareService Practice Setting Code Value Set ( Preferred )
location Reference(Location) 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(Location) 0..*   Location(s) service is intended for/available to
serviceProvisionCode CodeableConcept 0..*   Conditions under which service is available/offered ServiceProvisionConditions ( Example )
eligibility BackboneElement 0..*   Specific eligibility requirements required to use the service
code CodeableConcept 0..1   Coded value for the eligibility
comment markdown 0..1   Describes the eligibility conditions for the service
program CodeableConcept 0..*   Programs that this service is applicable to Program ( Example )
characteristic CodeableConcept 0..*   Collection of characteristics (attributes)
communication CodeableConcept 0..*   The language that this service is offered in Common Languages ( Preferred but limited to AllLanguages )
referralMethod CodeableConcept 0..*   Ways that the service accepts referrals ReferralMethod ( Example )
appointmentRequired boolean 0..1   If an appointment is required for access to this service
availableTime BackboneElement 0..*   Times the Service Site is available
daysOfWeek code 0..*   mon | tue | wed | thu | fri | sat | sun DaysOfWeek ( Required )
allDay boolean 0..1   Always available? e.g. 24 hour service
availableStartTime time 0..1   Opening time of day (ignored if allDay = true)
availableEndTime time 0..1   Closing time of day (ignored if allDay = true)
notAvailable BackboneElement 0..*   Not available during this time due to provided reason
description string 1..1 * Reason presented to the user explaining why time not available
during Period 0..1   Service not available from this date
availabilityExceptions string 0..1   Description of availability exceptions
endpoint Reference(Endpoint) 0..*   Technical endpoints providing access to electronic services operated for the healthcare service
HealthcareService DomainResource     The details of a healthcare service available at a locationElements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
identifier Identifier 0..*   External identifiers for this item
active boolean 0..1   Whether this HealthcareService record is in active use
providedBy Reference(Organization) 0..1   Organization that provides this service
category CodeableConcept 0..*   Broad category of service being performed or delivered Service category ( Example )
type CodeableConcept 0..*   Type of service that may be delivered or performed Service type ( Example )
specialty CodeableConcept 0..*   Specialties handled by the HealthcareService Practice Setting Code Value Set ( Preferred )
location Reference(Location) 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(Location) 0..*   Location(s) service is intended for/available to
serviceProvisionCode CodeableConcept 0..*   Conditions under which service is available/offered ServiceProvisionConditions ( Example )
eligibility BackboneElement 0..*   Specific eligibility requirements required to use the service
code CodeableConcept 0..1   Coded value for the eligibility
comment markdown 0..1   Describes the eligibility conditions for the service
program CodeableConcept 0..*   Programs that this service is applicable to Program ( Example )
characteristic CodeableConcept 0..*   Collection of characteristics (attributes)
communication CodeableConcept 0..*   The language that this service is offered in Common Languages ( Preferred but limited to AllLanguages )
referralMethod CodeableConcept 0..*   Ways that the service accepts referrals ReferralMethod ( Example )
appointmentRequired boolean 0..1   If an appointment is required for access to this service
availableTime BackboneElement 0..*   Times the Service Site is available
daysOfWeek code 0..*   mon | tue | wed | thu | fri | sat | sun DaysOfWeek ( Required )
allDay boolean 0..1   Always available? e.g. 24 hour service
availableStartTime time 0..1   Opening time of day (ignored if allDay = true)
availableEndTime time 0..1   Closing time of day (ignored if allDay = true)
notAvailable BackboneElement 0..*   Not available during this time due to provided reason
description string 1..1 * Reason presented to the user explaining why time not available
during Period 0..1   Service not available from this date
availabilityExceptions string 0..1   Description of availability exceptions
endpoint Reference(Endpoint) 0..*   Technical endpoints providing access to electronic services operated for the healthcare service

Interactions

Read

Get a HealthcareService entry by id

GET /HealthcareService/:id

Example

Request

https://r4cert.medicasoft.us/api/fhir/HealthcareService/f87a35d7-51cc-4dcc-9574-7a52513107bc

Response

{
  "timestamp": 1749113651747,
  "lastUpdated": "2025-06-09T18:28:14.209Z",
  "version": 9,
  "type": "healthcareservice",
  "healthcareservice": {
    "resourceType": "HealthcareService",
    "identifier": [
      {
        "value": "PRN",
        "systemValue": "http://medicasoft.com/nxt/healthcare-service-identifier|PRN"
      },
      {
        "value": "50456458",
        "systemValue": "http://medicasoft.com/nxt/healthcare-service-identifier|50456458"
      }
    ]
  }
}

Query HealthcareService resources

GET /HealthcareService?:query_parameters

Parameters

Name 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

Errors

Code Description
400 Invalid parameters
404 Resource not found