HealthcareService - FHIR Resource (stu3)

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

Validate an HealthcareService FHIR Resource (stu3)

HealthcareService Attributes

AttributeField is listTypeDescription

Description: Additional description and/or any specific issues not covered elsewhere

FHIR Version: stu3

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"comment": "Providing Specialist psychology services to the greater Den Burg area, many years of experience dealing with PTSD issues"

Learn more about the (HealthcareService) comment FHIR attribute

Description: Contacts related to the healthcare service

FHIR Version: stu3

Attribute Type : ContactPoint

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"telecom": [
  {
    "use": "work",
    "system": "phone",
    "value": "(555) silent"
  },
  {
    "use": "work",
    "system": "email",
    "value": "directaddress@example.com"
  }
]

Learn more about the (HealthcareService) telecom FHIR attribute

Description: Facilitates quick identification of the service

FHIR Version: stu3

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: stu3

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"providedBy": {
  "display": "Burgers University Medical Center",
  "reference": "Organization/f001"
}

Learn more about the (HealthcareService) providedBy FHIR attribute

Description: Extra details about the service that can't be placed in the other fields

FHIR Version: stu3

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"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."

Learn more about the (HealthcareService) extraDetails FHIR attribute

Description: Ways that the service accepts referrals

FHIR Version: stu3

Attribute Type : CodeableConcept

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"referralMethod": [
  {
    "coding": [
      {
        "code": "phone",
        "display": "Phone"
      }
    ]
  },
  {
    "coding": [
      {
        "code": "fax",
        "display": "Fax"
      }
    ]
  },
  {
    "coding": [
      {
        "code": "elec",
        "display": "Secure Messaging"
      }
    ]
  },
  {
    "coding": [
      {
        "code": "semail",
        "display": "Secure Email"
      }
    ]
  }
]

Learn more about the (HealthcareService) referralMethod FHIR attribute

Description: Broad category of service being performed or delivered

FHIR Version: stu3

Attribute Type : CodeableConcept

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"category": {
  "text": "Counselling",
  "coding": [
    {
      "code": "8",
      "system": "http://hl7.org/fhir/service-category",
      "display": "Counselling"
    }
  ]
}

Learn more about the (HealthcareService) category FHIR attribute

Description: Describes the eligibility conditions for the service

FHIR Version: stu3

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"eligibilityNote": "Evidence of application for DVA status may be sufficient for commencing assessment"

Learn more about the (HealthcareService) eligibilityNote FHIR attribute

Description: Description of availability exceptions

FHIR Version: stu3

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"availabilityExceptions": "Reduced capacity is available during the Christmas period"

Learn more about the (HealthcareService) availabilityExceptions FHIR attribute

Description: Location(s) where service may be provided

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"location": [
  {
    "reference": "Location/1"
  }
]

Learn more about the (HealthcareService) location FHIR attribute

Description: Location(s) service is inteded for/available to

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"coverageArea": [
  {
    "display": "Greater Denburg area",
    "reference": "#DenBurg"
  }
]

Learn more about the (HealthcareService) coverageArea FHIR attribute

Description: Type of service that may be delivered or performed

FHIR Version: stu3

Attribute Type : CodeableConcept

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"type": [
  {
    "coding": [
      {
        "code": "394913002",
        "system": "http://snomed.info/sct",
        "display": "Psychotherapy"
      }
    ]
  },
  {
    "coding": [
      {
        "code": "394587001",
        "system": "http://snomed.info/sct",
        "display": "Psychiatry"
      }
    ]
  }
]

Learn more about the (HealthcareService) type FHIR attribute

Description: Specific eligibility requirements required to use the service

FHIR Version: stu3

Attribute Type : CodeableConcept

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"eligibility": {
  "coding": [
    {
      "display": "DVA Required"
    }
  ]
}

Learn more about the (HealthcareService) eligibility FHIR attribute

Description: Times the Service Site is available

FHIR Version: stu3

Attribute Type : Data Type

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"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"
    ]
  }
]

Learn more about the (HealthcareService) availableTime FHIR attribute

Description: Specialties handled by the HealthcareService

FHIR Version: stu3

Attribute Type : CodeableConcept

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"specialty": [
  {
    "coding": [
      {
        "code": "47505003",
        "system": "http://snomed.info/sct",
        "display": "Posttraumatic stress disorder"
      }
    ]
  }
]

Learn more about the (HealthcareService) specialty FHIR attribute

Description: Program Names that categorize the service

FHIR Version: stu3

Attribute Type : string

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"programName": [
  "PTSD outreach"
]

Learn more about the (HealthcareService) programName FHIR attribute

Description: Not available during this time due to provided reason

FHIR Version: stu3

Attribute Type : Data Type

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

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"
  }
]

Learn more about the (HealthcareService) notAvailable FHIR attribute

Description: If an appointment is required for access to this service

FHIR Version: stu3

Attribute Type : boolean

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"appointmentRequired": false

Learn more about the (HealthcareService) appointmentRequired FHIR attribute

Description: Whether this healthcareservice is in active use

FHIR Version: stu3

Attribute Type : boolean

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"active": true

Learn more about the (HealthcareService) active FHIR attribute

Description: Technical endpoints providing access to services operated for the location

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"endpoint": [
  {
    "reference": "Endpoint/example"
  }
]

Learn more about the (HealthcareService) endpoint FHIR attribute

Description: Description of service as presented to a consumer while searching

FHIR Version: stu3

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"name": "Consulting psychologists and/or psychology services"

Learn more about the (HealthcareService) name FHIR attribute

Description: Collection of characteristics (attributes)

FHIR Version: stu3

Attribute Type : CodeableConcept

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"characteristic": [
  {
    "coding": [
      {
        "display": "Wheelchair access"
      }
    ]
  }
]

Learn more about the (HealthcareService) characteristic FHIR attribute

Description: Conditions under which service is available/offered

FHIR Version: stu3

Attribute Type : CodeableConcept

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"serviceProvisionCode": [
  {
    "coding": [
      {
        "code": "cost",
        "system": "http://hl7.org/fhir/service-provision-conditions",
        "display": "Fees apply"
      }
    ]
  }
]

Learn more about the (HealthcareService) serviceProvisionCode FHIR attribute

Description: External identifiers for this item

FHIR Version: stu3

Attribute Type : Identifier

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"identifier": [
  {
    "system": "http://example.org/shared-ids",
    "value": "HS-12"
  }
]

Learn more about the (HealthcareService) identifier FHIR attribute

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

https://api.1up.health/fhir/stu3/HealthcareService?query-param=queryvalue

Search Parameter	Field Type	Resource Fields Searched
`active`	`text`	`active`
`category`	`text`	`category`
`characteristic`	`text`	`characteristic`
`endpoint`	`reference`	`endpoint`
`identifier`	`text`	`identifier`
`location`	`reference`	`location`
`name`	`text`	`name`
`organization`	`reference`	`providedBy`
`programname`	`text`	`programName`
`type`	`text`	`type`