HealthcareService - FHIR Resource (dstu2)


This HealthcareService Resource uses the FHIR API standard for access and structure.

Validate an HealthcareService FHIR Resource (dstu2)



Resource Attributes

AttributeField is listTypeDescription
appointmentRequiredfalseboolean# If an appointment is required for access to this service
availabilityExceptionsfalsestring# Description of availability exceptions
availableTimetrueData Type# Times the Service Site is available
characteristictrueCodeableConcept# Collection of characteristics (attributes)
commentfalsestring# Additional description and/or any specific issues not covered elsewhere
coverageAreatrueReference# Location(s) service is inteded for/available to
eligibilityfalseCodeableConcept# Specific eligibility requirements required to use the service
eligibilityNotefalsestring# Describes the eligibility conditions for the service
extraDetailsfalsestring# Extra details about the service that can't be placed in the other fields
identifiertrueIdentifier# External identifiers for this item
locationfalseReference# Location where service may be provided
notAvailabletrueData Type# Not available during this time due to provided reason
photofalseAttachment# Facilitates quick identification of the service
programNametruestring# Program Names that categorize the service
providedByfalseReference# Organization that provides this service
publicKeyfalsestring# PKI Public keys to support secure communications
referralMethodtrueCodeableConcept# Ways that the service accepts referrals
serviceCategoryfalseCodeableConcept# Broad category of service being performed or delivered
serviceNamefalsestring# Description of service as presented to a consumer while searching
serviceProvisionCodetrueCodeableConcept# Conditions under which service is available/offered
serviceTypetrueData Type# Specific service delivered or performed
telecomtrueContactPoint# Contacts related to the healthcare service

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 the like so:

https://api.1up.health/fhir/dstu2/HealthcareService?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
characteristictextcharacteristic
identifiertextidentifier
locationreferencelocation
nametextserviceName
organizationreferenceprovidedBy
programnametextprogramName
servicecategorytextserviceCategory
servicetypetextserviceType.type