HealthcareService - FHIR Resource (stu3)


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

Resource Attributes

AttributeField is listTypeDescription
activefalseboolean Whether this healthcareservice is in active use
appointmentRequiredfalseboolean If an appointment is required for access to this service
availabilityExceptionsfalsestring Description of availability exceptions
availableTimetrueData Type Times the Service Site is available
categoryfalseCodeableConcept Broad category of service being performed or delivered
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
endpointtrueReference Technical endpoints providing access to services operated for the location
extraDetailsfalsestring Extra details about the service that can't be placed in the other fields
identifiertrueIdentifier External identifiers for this item
locationtrueReference Location(s) where service may be provided
namefalsestring Description of service as presented to a consumer while searching
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
referralMethodtrueCodeableConcept Ways that the service accepts referrals
serviceProvisionCodetrueCodeableConcept Conditions under which service is available/offered
specialtytrueCodeableConcept Specialties handled by the HealthcareService
telecomtrueContactPoint Contacts related to the healthcare service
typetrueCodeableConcept Type of service that may be delivered or performed

HealthcareService Example

{
  "comment": "Providing Specialist psychology services to the greater Den Burg area, many years of experience dealing with PTSD issues",
  "telecom": [
    {
      "use": "work",
      "system": "phone",
      "value": "(555) silent"
    },
    {
      "use": "work",
      "system": "email",
      "value": "directaddress@example.com"
    }
  ],
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n\t\t\t25 Dec 2013 9:15am - 9:30am: <b>Busy</b> Physiotherapy\n\t\t</div>"
  },
  "providedBy": {
    "display": "Burgers University Medical Center",
    "reference": "Organization/f001"
  },
  "referralMethod": [
    {
      "coding": [
        {
          "code": "phone",
          "display": "Phone"
        }
      ]
    },
    {
      "coding": [
        {
          "code": "fax",
          "display": "Fax"
        }
      ]
    },
    {
      "coding": [
        {
          "code": "elec",
          "display": "Secure Messaging"
        }
      ]
    },
    {
      "coding": [
        {
          "code": "semail",
          "display": "Secure Email"
        }
      ]
    }
  ],
  "id": "example",
  "category": {
    "text": "Counselling",
    "coding": [
      {
        "code": "8",
        "system": "http://hl7.org/fhir/service-category",
        "display": "Counselling"
      }
    ]
  },
  "eligibilityNote": "Evidence of application for DVA status may be sufficient for commencing assessment",
  "availabilityExceptions": "Reduced capacity is available during the Christmas period",
  "contained": [
    {
      "resourceType": "Location",
      "mode": "instance",
      "physicalType": {
        "coding": [
          {
            "code": "area",
            "display": "Area"
          }
        ]
      },
      "id": "DenBurg",
      "description": "Greater Denburg area"
    }
  ],
  "location": [
    {
      "reference": "Location/1"
    }
  ],
  "coverageArea": [
    {
      "display": "Greater Denburg area",
      "reference": "#DenBurg"
    }
  ],
  "type": [
    {
      "coding": [
        {
          "code": "394913002",
          "system": "http://snomed.info/sct",
          "display": "Psychotherapy"
        }
      ]
    },
    {
      "coding": [
        {
          "code": "394587001",
          "system": "http://snomed.info/sct",
          "display": "Psychiatry"
        }
      ]
    }
  ],
  "eligibility": {
    "coding": [
      {
        "display": "DVA Required"
      }
    ]
  },
  "availableTime": [
    {
      "allDay": true,
      "daysOfWeek": [
        "wed"
      ]
    },
    {
      "availableStartTime": "08:30:00",
      "availableEndTime": "05:30:00",
      "daysOfWeek": [
        "mon",
        "tue",
        "thu",
        "fri"
      ]
    },
    {
      "availableStartTime": "09:30:00",
      "availableEndTime": "04:30:00",
      "daysOfWeek": [
        "sat",
        "fri"
      ]
    }
  ],
  "specialty": [
    {
      "coding": [
        {
          "code": "47505003",
          "system": "http://snomed.info/sct",
          "display": "Posttraumatic stress disorder"
        }
      ]
    }
  ],
  "programName": [
    "PTSD outreach"
  ],
  "extraDetails": "Several assessments are required for these specialist services, and the waiting times can be greater than 3 months at times. Existing patients are prioritized when requesting appointments on the schedule.",
  "appointmentRequired": false,
  "active": true,
  "endpoint": [
    {
      "reference": "Endpoint/example"
    }
  ],
  "notAvailable": [
    {
      "during": {
        "start": "2015-12-25",
        "end": "2015-12-26"
      },
      "description": "Christmas/Boxing Day"
    },
    {
      "during": {
        "start": "2016-01-01",
        "end": "2016-01-01"
      },
      "description": "New Years Day"
    }
  ],
  "name": "Consulting psychologists and/or psychology services",
  "resourceType": "HealthcareService",
  "characteristic": [
    {
      "coding": [
        {
          "display": "Wheelchair access"
        }
      ]
    }
  ],
  "serviceProvisionCode": [
    {
      "coding": [
        {
          "code": "cost",
          "system": "http://hl7.org/fhir/service-provision-conditions",
          "display": "Fees apply"
        }
      ]
    }
  ],
  "identifier": [
    {
      "system": "http://example.org/shared-ids",
      "value": "HS-12"
    }
  ]
}

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
  "active" : <boolean>, // Whether this healthcareservice is in active use
  "providedBy" : { Reference(Organization) }, // Organization that provides this service
  "category" : { CodeableConcept }, // Broad category of service being performed or delivered
  "type" : [{ CodeableConcept }], // Type of service that may be delivered or performed
  "specialty" : [{ CodeableConcept }], // Specialties handled by the HealthcareService
  "location" : [{ Reference(Location) }], // Location(s) where service may be provided
  "name" : "<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
  "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
  "endpoint" : [{ Reference(Endpoint) }] // Technical endpoints providing access to services operated for the location
}


 

HealthcareService Search Parameters

The following search parameters can be used to query HealthcareService resources. Just submit the like so:

https://api.1up.health/fhir/stu3/HealthcareService?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
activetextactive
categorytextcategory
characteristictextcharacteristic
endpointreferenceendpoint
identifiertextidentifier
locationreferencelocation
nametextname
organizationreferenceprovidedBy
programnametextprogramName
typetexttype