HealthcareService

The details of a healthcare service available at a location.

Columns

Header row
# path type required description
0 resourceType string * Resource type identifier. Must be string "HealthcareService"
1 integer * Number of subrows
2 id string * Logical id of this artifact
3 active boolean Whether this HealthcareService record is in active use
providedBy Reference Organization that provides this service
4 providedBy.reference string Literal reference, Relative, internal or absolute URL
5 providedBy.type uri Type the reference refers to (e.g. "Patient")
providedBy.identifier Identifier Logical reference, when literal reference is not known
6 providedBy.identifier.use code usual | official | temp | secondary | old (If known)
providedBy.identifier.type CodeableConcept Description of identifier
providedBy.identifier.type.coding Coding Code defined by a terminology system
7 providedBy.identifier.type.coding.system uri Identity of the terminology system
8 providedBy.identifier.type.coding.version string Version of the system - if relevant
9 providedBy.identifier.type.coding.code code Symbol in syntax defined by the system
10 providedBy.identifier.type.coding.display string Representation defined by the system
11 providedBy.identifier.type.coding.userSelected boolean If this coding was chosen directly by the user
12 providedBy.identifier.type.text string Plain text representation of the concept
13 providedBy.identifier.system uri The namespace for the identifier value
14 providedBy.identifier.value string The value that is unique
providedBy.identifier.period Period Time period when id is/was valid for use
15 providedBy.identifier.period.start dateTime Starting time with inclusive boundary
16 providedBy.identifier.period.end dateTime End time with inclusive boundary, if not ongoing
17 providedBy.display string Text alternative for the resource
18 name string Description of service as presented to a consumer while searching
19 comment string Additional description and/or any specific issues not covered elsewhere
20 extraDetails markdown Extra details about the service that can't be placed in the other fields
photo Attachment Facilitates quick identification of the service
21 photo.contentType code Mime type of the content, with charset etc.
22 photo.language code Human language of the content (BCP-47)
23 photo.data base64Binary Data inline, base64ed
24 photo.url url Uri where the data can be found
25 photo.size unsignedInt Number of bytes of content (if url provided)
26 photo.hash base64Binary Hash of the data (sha-1, base64ed)
27 photo.title string Label to display in place of the data
28 photo.creation dateTime Date attachment was first created
29 appointmentRequired boolean If an appointment is required for access to this service
30 availabilityExceptions string Description of availability exceptions
Row identifier
# path type required description
0 string * Subrow identifier. Must be string "identifier"
identifier Identifier External identifiers for this item
1 identifier.use code usual | official | temp | secondary | old (If known)
identifier.type CodeableConcept Description of identifier
identifier.type.coding Coding Code defined by a terminology system
2 identifier.type.coding.system uri Identity of the terminology system
3 identifier.type.coding.version string Version of the system - if relevant
4 identifier.type.coding.code code Symbol in syntax defined by the system
5 identifier.type.coding.display string Representation defined by the system
6 identifier.type.coding.userSelected boolean If this coding was chosen directly by the user
7 identifier.type.text string Plain text representation of the concept
8 identifier.system uri The namespace for the identifier value
9 identifier.value string The value that is unique
identifier.period Period Time period when id is/was valid for use
10 identifier.period.start dateTime Starting time with inclusive boundary
11 identifier.period.end dateTime End time with inclusive boundary, if not ongoing
Row category
# path type required description
0 string * Subrow identifier. Must be string "category"
category CodeableConcept Broad category of service being performed or delivered
category.coding Coding Code defined by a terminology system
1 category.coding.system uri Identity of the terminology system
2 category.coding.version string Version of the system - if relevant
3 category.coding.code code Symbol in syntax defined by the system
4 category.coding.display string Representation defined by the system
5 category.coding.userSelected boolean If this coding was chosen directly by the user
6 category.text string Plain text representation of the concept
Row type
# path type required description
0 string * Subrow identifier. Must be string "type"
type CodeableConcept Type of service that may be delivered or performed
type.coding Coding Code defined by a terminology system
1 type.coding.system uri Identity of the terminology system
2 type.coding.version string Version of the system - if relevant
3 type.coding.code code Symbol in syntax defined by the system
4 type.coding.display string Representation defined by the system
5 type.coding.userSelected boolean If this coding was chosen directly by the user
6 type.text string Plain text representation of the concept
Row specialty
# path type required description
0 string * Subrow identifier. Must be string "specialty"
specialty CodeableConcept Specialties handled by the HealthcareService
specialty.coding Coding Code defined by a terminology system
1 specialty.coding.system uri Identity of the terminology system
2 specialty.coding.version string Version of the system - if relevant
3 specialty.coding.code code Symbol in syntax defined by the system
4 specialty.coding.display string Representation defined by the system
5 specialty.coding.userSelected boolean If this coding was chosen directly by the user
6 specialty.text string Plain text representation of the concept
Row location
# path type required description
0 string * Subrow identifier. Must be string "location"
location Reference Location(s) where service may be provided
1 location.reference string Literal reference, Relative, internal or absolute URL
2 location.type uri Type the reference refers to (e.g. "Patient")
location.identifier Identifier Logical reference, when literal reference is not known
3 location.identifier.use code usual | official | temp | secondary | old (If known)
location.identifier.type CodeableConcept Description of identifier
location.identifier.type.coding Coding Code defined by a terminology system
4 location.identifier.type.coding.system uri Identity of the terminology system
5 location.identifier.type.coding.version string Version of the system - if relevant
6 location.identifier.type.coding.code code Symbol in syntax defined by the system
7 location.identifier.type.coding.display string Representation defined by the system
8 location.identifier.type.coding.userSelected boolean If this coding was chosen directly by the user
9 location.identifier.type.text string Plain text representation of the concept
10 location.identifier.system uri The namespace for the identifier value
11 location.identifier.value string The value that is unique
location.identifier.period Period Time period when id is/was valid for use
12 location.identifier.period.start dateTime Starting time with inclusive boundary
13 location.identifier.period.end dateTime End time with inclusive boundary, if not ongoing
14 location.display string Text alternative for the resource
Row telecom
# path type required description
0 string * Subrow identifier. Must be string "telecom"
telecom ContactPoint Contacts related to the healthcare service
1 telecom.system code phone | fax | email | pager | url | sms | other
2 telecom.value string The actual contact point details
3 telecom.use code home | work | temp | old | mobile - purpose of this contact point
4 telecom.rank positiveInt Specify preferred order of use (1 = highest)
telecom.period Period Time period when the contact point was/is in use
5 telecom.period.start dateTime Starting time with inclusive boundary
6 telecom.period.end dateTime End time with inclusive boundary, if not ongoing
Row coverageArea
# path type required description
0 string * Subrow identifier. Must be string "coverageArea"
coverageArea Reference Location(s) service is intended for/available to
1 coverageArea.reference string Literal reference, Relative, internal or absolute URL
2 coverageArea.type uri Type the reference refers to (e.g. "Patient")
coverageArea.identifier Identifier Logical reference, when literal reference is not known
3 coverageArea.identifier.use code usual | official | temp | secondary | old (If known)
coverageArea.identifier.type CodeableConcept Description of identifier
coverageArea.identifier.type.coding Coding Code defined by a terminology system
4 coverageArea.identifier.type.coding.system uri Identity of the terminology system
5 coverageArea.identifier.type.coding.version string Version of the system - if relevant
6 coverageArea.identifier.type.coding.code code Symbol in syntax defined by the system
7 coverageArea.identifier.type.coding.display string Representation defined by the system
8 coverageArea.identifier.type.coding.userSelected boolean If this coding was chosen directly by the user
9 coverageArea.identifier.type.text string Plain text representation of the concept
10 coverageArea.identifier.system uri The namespace for the identifier value
11 coverageArea.identifier.value string The value that is unique
coverageArea.identifier.period Period Time period when id is/was valid for use
12 coverageArea.identifier.period.start dateTime Starting time with inclusive boundary
13 coverageArea.identifier.period.end dateTime End time with inclusive boundary, if not ongoing
14 coverageArea.display string Text alternative for the resource
Row serviceProvisionCode
# path type required description
0 string * Subrow identifier. Must be string "serviceProvisionCode"
serviceProvisionCode CodeableConcept Conditions under which service is available/offered
serviceProvisionCode.coding Coding Code defined by a terminology system
1 serviceProvisionCode.coding.system uri Identity of the terminology system
2 serviceProvisionCode.coding.version string Version of the system - if relevant
3 serviceProvisionCode.coding.code code Symbol in syntax defined by the system
4 serviceProvisionCode.coding.display string Representation defined by the system
5 serviceProvisionCode.coding.userSelected boolean If this coding was chosen directly by the user
6 serviceProvisionCode.text string Plain text representation of the concept
Row eligibility
# path type required description
0 string * Subrow identifier. Must be string "eligibility"
eligibility Specific eligibility requirements required to use the service
eligibility.code CodeableConcept Coded value for the eligibility
eligibility.code.coding Coding Code defined by a terminology system
1 eligibility.code.coding.system uri Identity of the terminology system
2 eligibility.code.coding.version string Version of the system - if relevant
3 eligibility.code.coding.code code Symbol in syntax defined by the system
4 eligibility.code.coding.display string Representation defined by the system
5 eligibility.code.coding.userSelected boolean If this coding was chosen directly by the user
6 eligibility.code.text string Plain text representation of the concept
7 eligibility.comment markdown Describes the eligibility conditions for the service
Row program
# path type required description
0 string * Subrow identifier. Must be string "program"
program CodeableConcept Programs that this service is applicable to
program.coding Coding Code defined by a terminology system
1 program.coding.system uri Identity of the terminology system
2 program.coding.version string Version of the system - if relevant
3 program.coding.code code Symbol in syntax defined by the system
4 program.coding.display string Representation defined by the system
5 program.coding.userSelected boolean If this coding was chosen directly by the user
6 program.text string Plain text representation of the concept
Row characteristic
# path type required description
0 string * Subrow identifier. Must be string "characteristic"
characteristic CodeableConcept Collection of characteristics (attributes)
characteristic.coding Coding Code defined by a terminology system
1 characteristic.coding.system uri Identity of the terminology system
2 characteristic.coding.version string Version of the system - if relevant
3 characteristic.coding.code code Symbol in syntax defined by the system
4 characteristic.coding.display string Representation defined by the system
5 characteristic.coding.userSelected boolean If this coding was chosen directly by the user
6 characteristic.text string Plain text representation of the concept
Row communication
# path type required description
0 string * Subrow identifier. Must be string "communication"
communication CodeableConcept The language that this service is offered in
communication.coding Coding Code defined by a terminology system
1 communication.coding.system uri Identity of the terminology system
2 communication.coding.version string Version of the system - if relevant
3 communication.coding.code code Symbol in syntax defined by the system
4 communication.coding.display string Representation defined by the system
5 communication.coding.userSelected boolean If this coding was chosen directly by the user
6 communication.text string Plain text representation of the concept
Row referralMethod
# path type required description
0 string * Subrow identifier. Must be string "referralMethod"
referralMethod CodeableConcept Ways that the service accepts referrals
referralMethod.coding Coding Code defined by a terminology system
1 referralMethod.coding.system uri Identity of the terminology system
2 referralMethod.coding.version string Version of the system - if relevant
3 referralMethod.coding.code code Symbol in syntax defined by the system
4 referralMethod.coding.display string Representation defined by the system
5 referralMethod.coding.userSelected boolean If this coding was chosen directly by the user
6 referralMethod.text string Plain text representation of the concept
Row availableTime
# path type required description
0 string * Subrow identifier. Must be string "availableTime"
availableTime Times the Service Site is available
1 availableTime.daysOfWeek code mon | tue | wed | thu | fri | sat | sun
2 availableTime.allDay boolean Always available? e.g. 24 hour service
3 availableTime.availableStartTime time Opening time of day (ignored if allDay = true)
4 availableTime.availableEndTime time Closing time of day (ignored if allDay = true)
Row notAvailable
# path type required description
0 string * Subrow identifier. Must be string "notAvailable"
notAvailable Not available during this time due to provided reason
1 notAvailable.description string Reason presented to the user explaining why time not available
notAvailable.during Period Service not available from this date
2 notAvailable.during.start dateTime Starting time with inclusive boundary
3 notAvailable.during.end dateTime End time with inclusive boundary, if not ongoing
Row endpoint
# path type required description
0 string * Subrow identifier. Must be string "endpoint"
endpoint Reference Technical endpoints providing access to electronic services operated for the healthcare service
1 endpoint.reference string Literal reference, Relative, internal or absolute URL
2 endpoint.type uri Type the reference refers to (e.g. "Patient")
endpoint.identifier Identifier Logical reference, when literal reference is not known
3 endpoint.identifier.use code usual | official | temp | secondary | old (If known)
endpoint.identifier.type CodeableConcept Description of identifier
endpoint.identifier.type.coding Coding Code defined by a terminology system
4 endpoint.identifier.type.coding.system uri Identity of the terminology system
5 endpoint.identifier.type.coding.version string Version of the system - if relevant
6 endpoint.identifier.type.coding.code code Symbol in syntax defined by the system
7 endpoint.identifier.type.coding.display string Representation defined by the system
8 endpoint.identifier.type.coding.userSelected boolean If this coding was chosen directly by the user
9 endpoint.identifier.type.text string Plain text representation of the concept
10 endpoint.identifier.system uri The namespace for the identifier value
11 endpoint.identifier.value string The value that is unique
endpoint.identifier.period Period Time period when id is/was valid for use
12 endpoint.identifier.period.start dateTime Starting time with inclusive boundary
13 endpoint.identifier.period.end dateTime End time with inclusive boundary, if not ongoing
14 endpoint.display string Text alternative for the resource

Examples

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