HealthcareService - FHIR Resource (dstu2)
This HealthcareService Resource uses the FHIR API standard for access and structure.
Validate an HealthcareService FHIR Resource (dstu2)
HealthcareService Attributes
AttributeField is listTypeDescription
Description: Additional description and/or any specific issues not covered elsewhere
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"comment": Learn more about the (HealthcareService) comment FHIR attribute
Description: Broad category of service being performed or delivered
FHIR Version: dstu2
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"serviceCategory": Learn more about the (HealthcareService) serviceCategory FHIR attribute
Description: Contacts related to the healthcare service
FHIR Version: dstu2
Attribute Type : ContactPoint
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"telecom": Learn more about the (HealthcareService) telecom FHIR attribute
Description: Facilitates quick identification of the service
FHIR Version: dstu2
Attribute Type : Attachment
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"photo": Learn more about the (HealthcareService) photo FHIR attribute
Description: Organization that provides this service
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"providedBy": Learn more about the (HealthcareService) providedBy FHIR attribute
Description: Not available during this time due to provided reason
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"notAvailable": Learn more about the (HealthcareService) notAvailable FHIR attribute
Description: Ways that the service accepts referrals
FHIR Version: dstu2
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"referralMethod": Learn more about the (HealthcareService) referralMethod FHIR attribute
Description: Describes the eligibility conditions for the service
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"eligibilityNote": Learn more about the (HealthcareService) eligibilityNote FHIR attribute
Description: Description of availability exceptions
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"availabilityExceptions": Learn more about the (HealthcareService) availabilityExceptions FHIR attribute
Description: Description of service as presented to a consumer while searching
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"serviceName": Learn more about the (HealthcareService) serviceName FHIR attribute
Description: Location where service may be provided
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"location": Learn more about the (HealthcareService) location FHIR attribute
Description: Location(s) service is inteded for/available to
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"coverageArea": Learn more about the (HealthcareService) coverageArea FHIR attribute
Description: Specific service delivered or performed
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"serviceType": Learn more about the (HealthcareService) serviceType FHIR attribute
Description: Specific eligibility requirements required to use the service
FHIR Version: dstu2
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"eligibility": Learn more about the (HealthcareService) eligibility FHIR attribute
Description: Times the Service Site is available
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"availableTime": Learn more about the (HealthcareService) availableTime FHIR attribute
Description: PKI Public keys to support secure communications
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"publicKey": Learn more about the (HealthcareService) publicKey FHIR attribute
Description: Program Names that categorize the service
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"programName": Learn more about the (HealthcareService) programName FHIR attribute
Description: Extra details about the service that can't be placed in the other fields
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"extraDetails": Learn more about the (HealthcareService) extraDetails FHIR attribute
Description: If an appointment is required for access to this service
FHIR Version: dstu2
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"appointmentRequired": Learn more about the (HealthcareService) appointmentRequired FHIR attribute
Description: Collection of characteristics (attributes)
FHIR Version: dstu2
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"characteristic": Learn more about the (HealthcareService) characteristic FHIR attribute
Description: Conditions under which service is available/offered
FHIR Version: dstu2
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"serviceProvisionCode": Learn more about the (HealthcareService) serviceProvisionCode FHIR attribute
Description: External identifiers for this item
FHIR Version: dstu2
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": Learn more about the (HealthcareService) identifier FHIR attribute
HealthcareService Structure
{
"resourceType" : "HealthcareService",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // External identifiers for this item
"providedBy" : { Reference(Organization) }, // Organization that provides this service
"serviceCategory" : { CodeableConcept }, // Broad category of service being performed or delivered
"serviceType" : [{ // Specific service delivered or performed
"type" : { CodeableConcept }, // R! Type of service delivered or performed
"specialty" : [{ CodeableConcept }] // Specialties handled by the Service Site
}],
"location" : { Reference(Location) }, // R! Location where service may be provided
"serviceName" : "<string>", // Description of service as presented to a consumer while searching
"comment" : "<string>", // Additional description and/or any specific issues not covered elsewhere
"extraDetails" : "<string>", // Extra details about the service that can't be placed in the other fields
"photo" : { Attachment }, // Facilitates quick identification of the service
"telecom" : [{ ContactPoint }], // Contacts related to the healthcare service
"coverageArea" : [{ Reference(Location) }], // Location(s) service is inteded for/available to
"serviceProvisionCode" : [{ CodeableConcept }], // Conditions under which service is available/offered
"eligibility" : { CodeableConcept }, // Specific eligibility requirements required to use the service
"eligibilityNote" : "<string>", // Describes the eligibility conditions for the service
"programName" : ["<string>"], // Program Names that categorize the service
"characteristic" : [{ CodeableConcept }], // Collection of characteristics (attributes)
"referralMethod" : [{ CodeableConcept }], // Ways that the service accepts referrals
"publicKey" : "<string>", // PKI Public keys to support secure communications
"appointmentRequired" : <boolean>, // If an appointment is required for access to this service
"availableTime" : [{ // Times the Service Site is available
"daysOfWeek" : ["<code>"], // mon | tue | wed | thu | fri | sat | sun
"allDay" : <boolean>, // Always available? e.g. 24 hour service
"availableStartTime" : "<time>", // Opening time of day (ignored if allDay = true)
"availableEndTime" : "<time>" // Closing time of day (ignored if allDay = true)
}],
"notAvailable" : [{ // Not available during this time due to provided reason
"description" : "<string>", // R! Reason presented to the user explaining why time not available
"during" : { Period } // Service not availablefrom this date
}],
"availabilityExceptions" : "<string>" // Description of availability exceptions
}
HealthcareService Search Parameters
The following search parameters can be used to query HealthcareService resources. Just submit them like so:
https://api.1up.health/fhir/dstu2/HealthcareService?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
characteristic | text | characteristic |
identifier | text | identifier |
location | reference | location |
name | text | serviceName |
organization | reference | providedBy |
programname | text | programName |
servicecategory | text | serviceCategory |
servicetype | text | serviceType.type |
