Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Healthcare Service Implementation Guidance

HealthcareService resource implementation guidance

HealthcareService: Implementation Guidance

Usage

Within the Clinical Decision Support API implementation, the HealthcareService resource will be used to carry a service recommendation given by the Service Directory that is capable of delivering the patient’s health needs.

The table below gives implementation guidance in relation to the elements within a HealthcareService:

Name Cardinality Type FHIR Documentation CDS Implementation Guidance
id 0..1 id Logical id of this artifact Note that this will always be populated except when the resource is being created (initial creation call)
meta 0..1 Meta Metadata about the resource
implicitRules 0..1 uri A set of rules under which this content was created
language 0..1 code Language of the resource content.
Common Languages (Extensible but limited to All Languages)
text 0..1 Narrative Text summary of the resource, for human interpretation
contained 0..* Resource Contained, inline Resources This SHOULD NOT be populated
extension 0..* Extension Additional Content defined by implementations
modifierExtension 0..* Extension Extensions that cannot be ignored
idenfitier 0..* Identifier External identifiers for this item
active 0..1 boolean Whether this HealthcareService is in active use SHOULD always be true
providedBy 0..1 Reference(Organization) Organization that provides this service This MUST be populated with a reference to a CareConnectOrganization
category 0..1 CodeableConcept Broad category of service being performed or delivered
ServiceCategory (Example)
type 0..* CodeableConcept Type of service that may be delivered or performed
ServiceType (Example)
specialty 0..* CodeableConcept Specialties handled by the HealthcareService
Practice Setting Code Value Set (Preferred)
location 0..* Reference(Location) Location(s) where service may be provided This MUST be populated
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 string 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/offered
ServiceProvisionConditions (Example)
eligibility 0..1 CodeableConcept Specific eligibility requirements required to use the service
eligibilityNote 0..1 string Describes the eligibility conditions for the service
programName 0..* string Program Names that categorize the service
characteristic 0..* CodeableConcept Collection of characteristics (attributes)
referralMethod 0..* CodeableConcept Ways that the service accepts referrals
ReferralMethod (Example)
If populated MUST include the service type of the current EMS
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 | sun
DaysOfWeek (Required)
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
description 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 services operated for the location This MUST be populated with the invocation details suitable notification.
Ordering of endpoints has meaning and SHOULD be maintained by the end user system when trying to connect

HealthcareService Elements of note

endpoint

This element contains details of the server endpoint to be invoked following the selection of a HealthcareService that has been returned in the $check-services interaction.

Notification

The HealthcareService is notified of an Encounter Report by the EMS calling the HealthcareService.endpoint and passing the Encounter ID.

It is up to the Encounter Report Receiver (ERR) to then fetch the Encounter Report.

Tags: rest fhir api

All content is available under the Open Government Licence v3.0, except where otherwise stated