HealthcareService - FHIR Resource (r4)


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

Validate an HealthcareService FHIR Resource (r4)



Resource Attributes

AttributeField is listTypeDescription
activefalseboolean# Whether this HealthcareService record 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
categorytrueCodeableConcept# Broad category of service being performed or delivered
characteristictrueCodeableConcept# Collection of characteristics (attributes)
commentfalsestring# Additional description and/or any specific issues not covered elsewhere
communicationtrueCodeableConcept# The language that this service is offered in
coverageAreatrueReference# Location(s) service is intended for/available to
eligibilitytrueData Type# Specific eligibility requirements required to use the service
endpointtrueReference# Technical endpoints providing access to electronic services operated for the healthcare service
extraDetailsfalsemarkdown# 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
programtrueCodeableConcept# Programs that this service is applicable to
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

{
  "resourceType": "HealthcareService",
  "id": "example",
  "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>"
  },
  "contained": [
    {
      "resourceType": "Location",
      "id": "DenBurg",
      "description": "Greater Denburg area",
      "mode": "instance",
      "physicalType": {
        "coding": [
          {
            "code": "area",
            "display": "Area"
          }
        ]
      }
    }
  ],
  "identifier": [
    {
      "system": "http://example.org/shared-ids",
      "value": "HS-12"
    }
  ],
  "active": true,
  "providedBy": {
    "reference": "Organization/f001",
    "display": "Burgers University Medical Center"
  },
  "category": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/service-category",
          "code": "8",
          "display": "Counselling"
        }
      ],
      "text": "Counselling"
    }
  ],
  "type": [
    {
      "coding": [
        {
          "system": "http://snomed.info/sct",
          "code": "394913002",
          "display": "Psychotherapy"
        }
      ]
    },
    {
      "coding": [
        {
          "system": "http://snomed.info/sct",
          "code": "394587001",
          "display": "Psychiatry"
        }
      ]
    }
  ],
  "specialty": [
    {
      "coding": [
        {
          "system": "http://snomed.info/sct",
          "code": "47505003",
          "display": "Posttraumatic stress disorder"
        }
      ]
    }
  ],
  "location": [
    {
      "reference": "Location/1"
    }
  ],
  "name": "Consulting psychologists and/or psychology services",
  "comment": "Providing Specialist psychology services to the greater Den Burg area, many years of experience dealing with PTSD issues",
  "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.",
  "telecom": [
    {
      "system": "phone",
      "value": "(555) silent",
      "use": "work"
    },
    {
      "system": "email",
      "value": "directaddress@example.com",
      "use": "work"
    }
  ],
  "coverageArea": [
    {
      "reference": "#DenBurg",
      "display": "Greater Denburg area"
    }
  ],
  "serviceProvisionCode": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/service-provision-conditions",
          "code": "cost",
          "display": "Fees apply"
        }
      ]
    }
  ],
  "eligibility": [
    {
      "code": {
        "coding": [
          {
            "display": "DVA Required"
          }
        ]
      },
      "comment": "Evidence of application for DVA status may be sufficient for commencing assessment"
    }
  ],
  "program": [
    {
      "text": "PTSD outreach"
    }
  ],
  "characteristic": [
    {
      "coding": [
        {
          "display": "Wheelchair access"
        }
      ]
    }
  ],
  "referralMethod": [
    {
      "coding": [
        {
          "code": "phone",
          "display": "Phone"
        }
      ]
    },
    {
      "coding": [
        {
          "code": "fax",
          "display": "Fax"
        }
      ]
    },
    {
      "coding": [
        {
          "code": "elec",
          "display": "Secure Messaging"
        }
      ]
    },
    {
      "coding": [
        {
          "code": "semail",
          "display": "Secure Email"
        }
      ]
    }
  ],
  "appointmentRequired": false,
  "availableTime": [
    {
      "daysOfWeek": [
        "wed"
      ],
      "allDay": true
    },
    {
      "daysOfWeek": [
        "mon",
        "tue",
        "thu",
        "fri"
      ],
      "availableStartTime": "08:30:00",
      "availableEndTime": "05:30:00"
    },
    {
      "daysOfWeek": [
        "sat",
        "fri"
      ],
      "availableStartTime": "09:30:00",
      "availableEndTime": "04:30:00"
    }
  ],
  "notAvailable": [
    {
      "description": "Christmas/Boxing Day",
      "during": {
        "start": "2015-12-25",
        "end": "2015-12-26"
      }
    },
    {
      "description": "New Years Day",
      "during": {
        "start": "2016-01-01",
        "end": "2016-01-01"
      }
    }
  ],
  "availabilityExceptions": "Reduced capacity is available during the Christmas period",
  "endpoint": [
    {
      "reference": "Endpoint/example"
    }
  ]
}

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 record 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" : "<markdown>", // 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 intended for/available to
  "serviceProvisionCode" : [{ CodeableConcept }], // Conditions under which service is available/offered
  "eligibility" : [{ // Specific eligibility requirements required to use the service
    "code" : { CodeableConcept }, // Coded value for the eligibility
    "comment" : "<markdown>" // Describes the eligibility conditions for the service
  }],
  "program" : [{ CodeableConcept }], // Programs that this service is applicable to
  "characteristic" : [{ CodeableConcept }], // Collection of characteristics (attributes)
  "communication" : [{ CodeableConcept }], // The language that this service is offered in
  "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 available from this date
  }],
  "availabilityExceptions" : "<string>", // Description of availability exceptions
  "endpoint" : [{ Reference(Endpoint) }] // Technical endpoints providing access to electronic services operated for the healthcare service
}

HealthcareService Search Parameters

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

https://api.1up.health/fhir/r4/HealthcareService?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
activetextactive
characteristictextcharacteristic
coverage-areareferencecoverageArea
endpointreferenceendpoint
identifiertextidentifier
locationreferencelocation
nametextname
organizationreferenceprovidedBy
programtextprogram
service-categorytextcategory
service-typetexttype
specialtytextspecialty