Structure Definition: HealthcareService Profile


Canonical URL: https://signalbhn.org/fhir/StructureDefinition/healthcareservice

Simplifier project page: https://simplifier.net/signal-mso-fhir-profiles/signalhealthcareservice

Derived from: HealthcareService (R4)

Module: Organization Services Module


Formal profile content

identifierΣ0..*Identifier
activeΣ ?!0..1boolean
providedByΣ I0..1Reference(Organization)
categoryΣ0..*CodeableConceptBinding
servicesΣ1..*CodeableConceptBinding
procedureΣ0..*CodeableConceptBinding
specialtyΣ0..*CodeableConceptBinding
locationΣ I0..*Reference(Location)
nameΣ0..1string
commentΣ0..1string
extraDetails0..1markdown
photoΣ I0..1Attachment
telecomI0..*ContactPoint
coverageAreaI0..*Reference(Location)
serviceProvisionCode0..*CodeableConcept
code0..1CodeableConcept
comment0..1markdown
program1..*CodeableConceptBinding
characteristic0..*CodeableConcept
communication0..*CodeableConceptBinding
referralMethod0..*CodeableConcept
appointmentRequired0..1boolean
daysOfWeek0..*codeBinding
allDay0..1boolean
availableStartTime0..1time
availableEndTime0..1time
description1..1string
duringI0..1Period
availabilityExceptions0..1string
endpointI0..*Reference(Endpoint)
identifierΣ0..*Identifier
activeΣ ?!0..1boolean
providedByΣ I0..1Reference(Organization)
categoryΣ0..*CodeableConceptBinding
servicesΣ1..*CodeableConceptBinding
procedureΣ0..*CodeableConceptBinding
specialtyΣ0..*CodeableConceptBinding
locationΣ I0..*Reference(Location)
nameΣ0..1string
commentΣ0..1string
extraDetails0..1markdown
photoΣ I0..1Attachment
telecomI0..*ContactPoint
coverageAreaI0..*Reference(Location)
serviceProvisionCode0..*CodeableConcept
code0..1CodeableConcept
comment0..1markdown
program1..*CodeableConceptBinding
characteristic0..*CodeableConcept
communication0..*CodeableConceptBinding
referralMethod0..*CodeableConcept
appointmentRequired0..1boolean
daysOfWeek0..*codeBinding
allDay0..1boolean
availableStartTime0..1time
availableEndTime0..1time
description1..1string
duringI0..1Period
availabilityExceptions0..1string
endpointI0..*Reference(Endpoint)
{
    "resourceType": "StructureDefinition",
    "id": "signal-healthcareservice",
    "url": "https://signalbhn.org/fhir/StructureDefinition/healthcareservice",
    "name": "SignalHealthcareService",
    "title": "HealthcareService Profile",
    "status": "draft",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "HealthcareService",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/HealthcareService",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "HealthcareService.category",
                "path": "HealthcareService.category",
                "binding": {
                    "strength": "required",
                    "valueSet": "https://signalbhn.org/fhir/ValueSet/signal-healthcare-service-category"
                }
            },
            {
                "id": "HealthcareService.type",
                "path": "HealthcareService.type",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "coding.system"
                        }
                    ],
                    "description": "Each slice represents a different coding system/valueset",
                    "rules": "open"
                }
            },
            {
                "id": "HealthcareService.type:services",
                "path": "HealthcareService.type",
                "sliceName": "services",
                "definition": "Each CPT code falls into one of ten primary categories of service, or 'Service categories'",
                "min": 1,
                "binding": {
                    "strength": "required",
                    "description": "Service types allowed in healthcare service",
                    "valueSet": "https://signalbhn.org/fhir/ValueSet/signal-healthcare-service-type"
                }
            },
            {
                "id": "HealthcareService.type:procedure",
                "path": "HealthcareService.type",
                "sliceName": "procedure",
                "definition": "CPT procedure code associated with serviceCategory(ies)",
                "binding": {
                    "strength": "required",
                    "description": "CPT procedure codes allowed in healthcare service.",
                    "valueSet": "https://signalbhn.org/fhir/ValueSet/healthcare-service-procedure-code-cpt"
                }
            },
            {
                "id": "HealthcareService.program",
                "path": "HealthcareService.program",
                "min": 1,
                "binding": {
                    "strength": "required",
                    "valueSet": "https://signalbhn.org/fhir/ValueSet/signal-program"
                }
            }
        ]
    }
}

Profile usage

The HealthcareService resource is used to describe healthcare services offered by an organization (called a provider) within a given context defined by OrganizationAffiliation. This resource contains many business-specific elements including offered programs, service types (modalities), service categories, procedure codes, and more. HealthcareService is meant to be a reusable resource, relating the aforementioned business elements to providers.

Profile element notes

.program

  • SHALL be used to group services offered by one or more organizations under a formal "program" label; e.g. SUD, CYMHTA, CCS.
  • Programs are relatively static within the organization and create the main taxonomy for the service categories and procedures available.

.category

  • SHALL be used to facilitate groupings of procedures to be offered; e.g. Prevention/Eearly Intervention Services, Screening, Crisis
  • Definitions from Colorado BHA USCS Manual and a catch-all Other for business-specific definitions
    • will also include an "Other" code for non-Colorado BHA procedures
  • Procedure codes will directly fall into one of these categories
  • Secondary level to program, used as a hierarchical relationship to programs; e.g. SUD ASAM-0.5, SUD Differential Assessment, Crisis mobile, CYMHTA treatment.
  • Previously referred to as modality

.type

  • Will remain FHIR default (example) but will be unused at this time (see slices)

.type:services

  • Custom code system for Signal that represents the "services" or "service type" codes that are available based on Organization qualifications; e.g. asam-0.5, da, crisis-mobile, etc.

.type:procedure -- Tentative use, this is likely to change

  • SHOULD be populated with with procedure codes (HCPCS, CPT) that are applicable to this service category
  • Definitions come from Colorado BHA USCS Manual

Examples