SDOH Clinical Care
3.0.0 - STU 3

SDOH Clinical Care, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 3.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-sdoh-clinicalcare/ and changes regularly. See the Directory of published versions

## Resource Profile: SDOHCC Healthcare Service

Official URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-HealthcareService | Version: 3.0.0
Standards status: Trial-use | Maturity Level: 2 | Computable Name: SDOHCCHealthcareService

Profile that describes the means by which a healthcare service can be contacted.

### Purpose

SDOHCC Healthcare Service is intended to provide the Healthcare Service address and the contact information for making an appointment. When a subject of care is referred to a Healthcare Service, SDOHCC Task For Patient (via `Task.input`) can reference SDOHCC Healthcare Service which can provide the Healthcare Service address (via HealthcareService.location) and contact information for making an appointment (via HealthcareService.telecom and SDOHCC Healthcare Service Telecom Appointment).

Usages:

- Refer to this Profile: SDOHCC Observation Enrollment Status, SDOHCC Task For Patient and SDOHCC Task For Referral Management
- Examples for this Profile: Family Counseling Services and HACC
- CapabilityStatements using this Profile: SDOHCC Coordination Platform, SDOHCC Patient Application, SDOHCC Referral Recipient, SDOHCC Referral Recipient - Light and SDOHCC Referral Source

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
HealthcareService |  | 0..* | HealthcareService | The details of a healthcare service available at a location
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:capacity-status |  | 0..1 | (Complex) | Is the service currently at capacity? URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceCapacityStatus
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
active | ?!S Σ | 1..1 | boolean | Whether this HealthcareService record is in active use Fixed Value: true
category | S Σ | 1..* | CodeableConcept | Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided.
Slices for coding | S Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this
coding:ServiceCategory | S Σ | 1..1 | Coding | Code defined by a terminology system Binding: SDOHCC ValueSet Service Category (required)
coding:SDOHCC | S Σ | 0..* | Coding | e.g., food-insecurity | transportation-insecurity Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories.
type | S Σ | 1..1 | CodeableConcept | Type of service that may be delivered or performed Binding: SDOHCC ValueSet Healthcare Service Type (extensible)
location | S Σ | 0..* | Reference(SDOHCC Location) | Location(s) where service may be provided
name | S Σ | 1..1 | string | Description of service as presented to a consumer while searching
Slices for telecom |  | 1..* | ContactPoint | Contacts related to the healthcare service Slice: Unordered, Open by exists:extension('http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceTelecomAppointment')
telecom:AppointmentContact | S | 1..* | ContactPoint | Contacts related to the healthcare service
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:ForAppointment | S | 1..1 | boolean | Telecom is for making appointments URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceTelecomAppointment
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 1..1 | string | The actual contact point details
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
program | S | 0..* | CodeableConcept | Programs that this service is applicable to Binding: Program (example): Government or local programs that this service applies to.
characteristic | S | 0..* | CodeableConcept | Collection of characteristics (attributes) Binding: USCoreProcedureCodes (7.0.0) (required): Codes describing the type of Procedure
Additional Bindings | Purpose | Usage
USCoreProcedureCodes (7.0.0) | Current |
DigitalAccessProcedures (20240615) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = digital-access
DigitalLiteracyProcedures (20240628) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = digital-literacy
LessThanHighSchoolEducationProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = educational-attainment
ElderAbuseProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = elder-abuse
UnemploymentProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = employment-status
FinancialInsecurityProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = financial-insecurity
FoodInsecurityProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = food-insecurity
HealthInsuranceCoverageStatusProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = health-insurance-coverage-status
HomelessnessProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = homelessness
HousingInstabilityProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = housing-instability
InadequateHousingProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = inadequate-housing
Incarceration Status Procedures | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = incarceration-status
IntimatePartnerViolenceProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = intimate-partner-violence
Language Access Procedures | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = language-access
MaterialHardshipProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = material-hardship
MedicalCostBurdenProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = medical-cost-burden
HealthLiteracyProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = personal-health-literacy
SocialConnectionProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = social-connection
StressProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = stress
TransportationInsecurityProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = transportation-insecurity
UtilityInsecurityProcedures (20240524) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = utility-insecurity
VeteranStatusProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = veteran-status
USCoreProcedureCodes (7.0.0) | Required | SDOHCCHealthcareService#`HealthcareService.category` = sdoh-category-unspecified
communication | S | 0..* | CodeableConcept | The language that this service is offered in Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
appointmentRequired | S | 0..1 | boolean | If an appointment is required for access to this service
availableTime | S | 0..* | BackboneElement | Times the Service Site is available
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
notAvailable | S | 0..* | BackboneElement | Not available during this time due to provided reason
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
description |  | 1..1 | string | Reason presented to the user explaining why time not available
availabilityExceptions | S | 0..1 | string | Description of availability exceptions
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
HealthcareService.category | example | ServiceCategory `http://hl7.org/fhir/ValueSet/service-category|4.0.1` From the FHIR Standard
HealthcareService.category.coding:ServiceCategory | required | SDOHCCValueSetServiceCategory `http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetServiceCategory` From this IG
HealthcareService.category.coding:SDOHCC | required | SDOHCCValueSetSDOHCategory `http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategory` From this IG
HealthcareService.type | extensible | SDOHCCValueSetHealthcareServiceType `http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetHealthcareServiceType` From this IG
HealthcareService.telecom:AppointmentContact.system | required | ContactPointSystem `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` From the FHIR Standard
HealthcareService.telecom:AppointmentContact.use | required | ContactPointUse `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` From the FHIR Standard
HealthcareService.program | example | Program `http://hl7.org/fhir/ValueSet/program|4.0.1` From the FHIR Standard
HealthcareService.characteristic | required | USCoreProcedureCodes `http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code|7.0.0`
HealthcareService.communication | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages|4.0.1` From the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | HealthcareService | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | HealthcareService | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | HealthcareService | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

This structure is derived from HealthcareService

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
HealthcareService |  | 0..* | HealthcareService | The details of a healthcare service available at a location
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:capacity-status |  | 0..1 | (Complex) | Is the service currently at capacity? URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceCapacityStatus
active | S | 1..1 | boolean | Whether this HealthcareService record is in active use Fixed Value: true
category | S | 1..* | CodeableConcept | Broad category of service being performed or delivered
Slices for coding | S | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this
coding:ServiceCategory | S | 1..1 | Coding | Code defined by a terminology system Binding: SDOHCC ValueSet Service Category (required)
coding:SDOHCC | S | 0..* | Coding | e.g., food-insecurity | transportation-insecurity Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories.
type | S | 1..1 | CodeableConcept | Type of service that may be delivered or performed Binding: SDOHCC ValueSet Healthcare Service Type (extensible)
location | S | 0..* | Reference(SDOHCC Location) | Location(s) where service may be provided
name | S | 1..1 | string | Description of service as presented to a consumer while searching
Slices for telecom |  | 1..* | ContactPoint | Contacts related to the healthcare service Slice: Unordered, Open by exists:extension('http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceTelecomAppointment')
telecom:AppointmentContact | S | 1..* | ContactPoint | Contacts related to the healthcare service
extension |  | 1..* | Extension | Extension
Slices for extension |  |  |  | Content/Rules for all slices
extension:ForAppointment | S | 1..1 | boolean | Telecom is for making appointments URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceTelecomAppointment
system | S | 1..1 | code | phone | fax | email | pager | url | sms | other
value | S | 1..1 | string | The actual contact point details
program | S | 0..* | CodeableConcept | Programs that this service is applicable to
characteristic | S | 0..* | CodeableConcept | Collection of characteristics (attributes) Binding: USCoreProcedureCodes (7.0.0) (required): Codes describing the type of Procedure
Additional Bindings | Purpose | Usage
USCoreProcedureCodes (7.0.0) | Current |
DigitalAccessProcedures (20240615) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = digital-access
DigitalLiteracyProcedures (20240628) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = digital-literacy
LessThanHighSchoolEducationProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = educational-attainment
ElderAbuseProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = elder-abuse
UnemploymentProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = employment-status
FinancialInsecurityProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = financial-insecurity
FoodInsecurityProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = food-insecurity
HealthInsuranceCoverageStatusProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = health-insurance-coverage-status
HomelessnessProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = homelessness
HousingInstabilityProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = housing-instability
InadequateHousingProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = inadequate-housing
Incarceration Status Procedures | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = incarceration-status
IntimatePartnerViolenceProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = intimate-partner-violence
Language Access Procedures | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = language-access
MaterialHardshipProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = material-hardship
MedicalCostBurdenProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = medical-cost-burden
HealthLiteracyProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = personal-health-literacy
SocialConnectionProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = social-connection
StressProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = stress
TransportationInsecurityProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = transportation-insecurity
UtilityInsecurityProcedures (20240524) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = utility-insecurity
VeteranStatusProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = veteran-status
USCoreProcedureCodes (7.0.0) | Required | SDOHCCHealthcareService#`HealthcareService.category` = sdoh-category-unspecified
communication | S | 0..* | CodeableConcept | The language that this service is offered in
appointmentRequired | S | 0..1 | boolean | If an appointment is required for access to this service
availableTime | S | 0..* | BackboneElement | Times the Service Site is available
notAvailable | S | 0..* | BackboneElement | Not available during this time due to provided reason
availabilityExceptions | S | 0..1 | string | Description of availability exceptions
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
HealthcareService.category.coding:ServiceCategory | required | SDOHCCValueSetServiceCategory `http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetServiceCategory` From this IG
HealthcareService.category.coding:SDOHCC | required | SDOHCCValueSetSDOHCategory `http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategory` From this IG
HealthcareService.type | extensible | SDOHCCValueSetHealthcareServiceType `http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetHealthcareServiceType` From this IG
HealthcareService.characteristic | required | USCoreProcedureCodes `http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code|7.0.0`

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
HealthcareService |  | 0..* | HealthcareService | The details of a healthcare service available at a location
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:capacity-status |  | 0..1 | (Complex) | Is the service currently at capacity? URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceCapacityStatus
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | External identifiers for this item
active | ?!S Σ | 1..1 | boolean | Whether this HealthcareService record is in active use Fixed Value: true
providedBy | Σ | 0..1 | Reference(Organization) | Organization that provides this service
category | S Σ | 1..* | CodeableConcept | Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding | S Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this
coding:ServiceCategory | S Σ | 1..1 | Coding | Code defined by a terminology system Binding: SDOHCC ValueSet Service Category (required)
coding:SDOHCC | S Σ | 0..* | Coding | e.g., food-insecurity | transportation-insecurity Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories.
text | Σ | 0..1 | string | Plain text representation of the concept
type | S Σ | 1..1 | CodeableConcept | Type of service that may be delivered or performed Binding: SDOHCC ValueSet Healthcare Service Type (extensible)
specialty | Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide.
location | S Σ | 0..* | Reference(SDOHCC Location) | Location(s) where service may be provided
name | S Σ | 1..1 | string | Description of service as presented to a consumer while searching
comment | Σ | 0..1 | string | Additional description and/or any specific issues not covered elsewhere
extraDetails |  | 0..1 | markdown | Extra details about the service that can't be placed in the other fields
photo | Σ | 0..1 | Attachment | Facilitates quick identification of the service
Slices for telecom |  | 1..* | ContactPoint | Contacts related to the healthcare service Slice: Unordered, Open by exists:extension('http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceTelecomAppointment')
telecom:AppointmentContact | S | 1..* | ContactPoint | Contacts related to the healthcare service
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:ForAppointment | S | 1..1 | boolean | Telecom is for making appointments URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceTelecomAppointment
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 1..1 | string | The actual contact point details
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | Σ | 0..1 | Period | Time period when the contact point was/is in use
coverageArea |  | 0..* | Reference(Location) | Location(s) service is intended for/available to
serviceProvisionCode |  | 0..* | CodeableConcept | Conditions under which service is available/offered Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered.
eligibility |  | 0..* | BackboneElement | Specific eligibility requirements required to use the service
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code |  | 0..1 | CodeableConcept | Coded value for the eligibility Binding Description: (example): Coded values underwhich a specific service is made available.
comment |  | 0..1 | markdown | Describes the eligibility conditions for the service
program | S | 0..* | CodeableConcept | Programs that this service is applicable to Binding: Program (example): Government or local programs that this service applies to.
characteristic | S | 0..* | CodeableConcept | Collection of characteristics (attributes) Binding: USCoreProcedureCodes (7.0.0) (required): Codes describing the type of Procedure
Additional Bindings | Purpose | Usage
USCoreProcedureCodes (7.0.0) | Current |
DigitalAccessProcedures (20240615) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = digital-access
DigitalLiteracyProcedures (20240628) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = digital-literacy
LessThanHighSchoolEducationProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = educational-attainment
ElderAbuseProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = elder-abuse
UnemploymentProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = employment-status
FinancialInsecurityProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = financial-insecurity
FoodInsecurityProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = food-insecurity
HealthInsuranceCoverageStatusProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = health-insurance-coverage-status
HomelessnessProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = homelessness
HousingInstabilityProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = housing-instability
InadequateHousingProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = inadequate-housing
Incarceration Status Procedures | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = incarceration-status
IntimatePartnerViolenceProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = intimate-partner-violence
Language Access Procedures | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = language-access
MaterialHardshipProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = material-hardship
MedicalCostBurdenProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = medical-cost-burden
HealthLiteracyProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = personal-health-literacy
SocialConnectionProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = social-connection
StressProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = stress
TransportationInsecurityProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = transportation-insecurity
UtilityInsecurityProcedures (20240524) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = utility-insecurity
VeteranStatusProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = veteran-status
USCoreProcedureCodes (7.0.0) | Required | SDOHCCHealthcareService#`HealthcareService.category` = sdoh-category-unspecified
communication | S | 0..* | CodeableConcept | The language that this service is offered in Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
referralMethod |  | 0..* | CodeableConcept | Ways that the service accepts referrals Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthCareService resource.
appointmentRequired | S | 0..1 | boolean | If an appointment is required for access to this service
availableTime | S | 0..* | BackboneElement | Times the Service Site is available
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
daysOfWeek |  | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay |  | 0..1 | boolean | Always available? e.g. 24 hour service
availableStartTime |  | 0..1 | time | Opening time of day (ignored if allDay = true)
availableEndTime |  | 0..1 | time | Closing time of day (ignored if allDay = true)
notAvailable | S | 0..* | BackboneElement | Not available during this time due to provided reason
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
description |  | 1..1 | string | Reason presented to the user explaining why time not available
during |  | 0..1 | Period | Service not available from this date
availabilityExceptions | S | 0..1 | string | Description of availability exceptions
endpoint |  | 0..* | Reference(Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
HealthcareService.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages|4.0.1` From the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
HealthcareService.category | example | ServiceCategory `http://hl7.org/fhir/ValueSet/service-category|4.0.1` From the FHIR Standard
HealthcareService.category.coding:ServiceCategory | required | SDOHCCValueSetServiceCategory `http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetServiceCategory` From this IG
HealthcareService.category.coding:SDOHCC | required | SDOHCCValueSetSDOHCategory `http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategory` From this IG
HealthcareService.type | extensible | SDOHCCValueSetHealthcareServiceType `http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetHealthcareServiceType` From this IG
HealthcareService.specialty | preferred | PracticeSettingCodeValueSet `http://hl7.org/fhir/ValueSet/c80-practice-codes|4.0.1` From the FHIR Standard
HealthcareService.telecom:AppointmentContact.system | required | ContactPointSystem `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` From the FHIR Standard
HealthcareService.telecom:AppointmentContact.use | required | ContactPointUse `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` From the FHIR Standard
HealthcareService.serviceProvisionCode | example | ServiceProvisionConditions `http://hl7.org/fhir/ValueSet/service-provision-conditions|4.0.1` From the FHIR Standard
HealthcareService.eligibility.code | example |
HealthcareService.program | example | Program `http://hl7.org/fhir/ValueSet/program|4.0.1` From the FHIR Standard
HealthcareService.characteristic | required | USCoreProcedureCodes `http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code|7.0.0`
HealthcareService.communication | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages|4.0.1` From the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
HealthcareService.referralMethod | example | ReferralMethod `http://hl7.org/fhir/ValueSet/service-referral-method|4.0.1` From the FHIR Standard
HealthcareService.availableTime.daysOfWeek | required | DaysOfWeek `http://hl7.org/fhir/ValueSet/days-of-week|4.0.1` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | HealthcareService | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | HealthcareService | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | HealthcareService | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

This structure is derived from HealthcareService

Summary

Mandatory: 12 elements
Must-Support: 19 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

- SDOHCC Location (http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Location)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceCapacityStatus
- http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceTelecomAppointment

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of HealthcareService.category.coding
- The element 1 is sliced based on the value of HealthcareService.telecom

Maturity: 2

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
HealthcareService |  | 0..* | HealthcareService | The details of a healthcare service available at a location
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:capacity-status |  | 0..1 | (Complex) | Is the service currently at capacity? URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceCapacityStatus
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
active | ?!S Σ | 1..1 | boolean | Whether this HealthcareService record is in active use Fixed Value: true
category | S Σ | 1..* | CodeableConcept | Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided.
Slices for coding | S Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this
coding:ServiceCategory | S Σ | 1..1 | Coding | Code defined by a terminology system Binding: SDOHCC ValueSet Service Category (required)
coding:SDOHCC | S Σ | 0..* | Coding | e.g., food-insecurity | transportation-insecurity Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories.
type | S Σ | 1..1 | CodeableConcept | Type of service that may be delivered or performed Binding: SDOHCC ValueSet Healthcare Service Type (extensible)
location | S Σ | 0..* | Reference(SDOHCC Location) | Location(s) where service may be provided
name | S Σ | 1..1 | string | Description of service as presented to a consumer while searching
Slices for telecom |  | 1..* | ContactPoint | Contacts related to the healthcare service Slice: Unordered, Open by exists:extension('http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceTelecomAppointment')
telecom:AppointmentContact | S | 1..* | ContactPoint | Contacts related to the healthcare service
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:ForAppointment | S | 1..1 | boolean | Telecom is for making appointments URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceTelecomAppointment
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 1..1 | string | The actual contact point details
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
program | S | 0..* | CodeableConcept | Programs that this service is applicable to Binding: Program (example): Government or local programs that this service applies to.
characteristic | S | 0..* | CodeableConcept | Collection of characteristics (attributes) Binding: USCoreProcedureCodes (7.0.0) (required): Codes describing the type of Procedure
Additional Bindings | Purpose | Usage
USCoreProcedureCodes (7.0.0) | Current |
DigitalAccessProcedures (20240615) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = digital-access
DigitalLiteracyProcedures (20240628) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = digital-literacy
LessThanHighSchoolEducationProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = educational-attainment
ElderAbuseProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = elder-abuse
UnemploymentProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = employment-status
FinancialInsecurityProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = financial-insecurity
FoodInsecurityProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = food-insecurity
HealthInsuranceCoverageStatusProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = health-insurance-coverage-status
HomelessnessProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = homelessness
HousingInstabilityProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = housing-instability
InadequateHousingProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = inadequate-housing
Incarceration Status Procedures | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = incarceration-status
IntimatePartnerViolenceProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = intimate-partner-violence
Language Access Procedures | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = language-access
MaterialHardshipProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = material-hardship
MedicalCostBurdenProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = medical-cost-burden
HealthLiteracyProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = personal-health-literacy
SocialConnectionProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = social-connection
StressProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = stress
TransportationInsecurityProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = transportation-insecurity
UtilityInsecurityProcedures (20240524) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = utility-insecurity
VeteranStatusProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = veteran-status
USCoreProcedureCodes (7.0.0) | Required | SDOHCCHealthcareService#`HealthcareService.category` = sdoh-category-unspecified
communication | S | 0..* | CodeableConcept | The language that this service is offered in Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
appointmentRequired | S | 0..1 | boolean | If an appointment is required for access to this service
availableTime | S | 0..* | BackboneElement | Times the Service Site is available
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
notAvailable | S | 0..* | BackboneElement | Not available during this time due to provided reason
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
description |  | 1..1 | string | Reason presented to the user explaining why time not available
availabilityExceptions | S | 0..1 | string | Description of availability exceptions
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
HealthcareService.category | example | ServiceCategory `http://hl7.org/fhir/ValueSet/service-category|4.0.1` From the FHIR Standard
HealthcareService.category.coding:ServiceCategory | required | SDOHCCValueSetServiceCategory `http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetServiceCategory` From this IG
HealthcareService.category.coding:SDOHCC | required | SDOHCCValueSetSDOHCategory `http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategory` From this IG
HealthcareService.type | extensible | SDOHCCValueSetHealthcareServiceType `http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetHealthcareServiceType` From this IG
HealthcareService.telecom:AppointmentContact.system | required | ContactPointSystem `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` From the FHIR Standard
HealthcareService.telecom:AppointmentContact.use | required | ContactPointUse `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` From the FHIR Standard
HealthcareService.program | example | Program `http://hl7.org/fhir/ValueSet/program|4.0.1` From the FHIR Standard
HealthcareService.characteristic | required | USCoreProcedureCodes `http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code|7.0.0`
HealthcareService.communication | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages|4.0.1` From the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | HealthcareService | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | HealthcareService | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | HealthcareService | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

Differential View

This structure is derived from HealthcareService

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
HealthcareService |  | 0..* | HealthcareService | The details of a healthcare service available at a location
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:capacity-status |  | 0..1 | (Complex) | Is the service currently at capacity? URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceCapacityStatus
active | S | 1..1 | boolean | Whether this HealthcareService record is in active use Fixed Value: true
category | S | 1..* | CodeableConcept | Broad category of service being performed or delivered
Slices for coding | S | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this
coding:ServiceCategory | S | 1..1 | Coding | Code defined by a terminology system Binding: SDOHCC ValueSet Service Category (required)
coding:SDOHCC | S | 0..* | Coding | e.g., food-insecurity | transportation-insecurity Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories.
type | S | 1..1 | CodeableConcept | Type of service that may be delivered or performed Binding: SDOHCC ValueSet Healthcare Service Type (extensible)
location | S | 0..* | Reference(SDOHCC Location) | Location(s) where service may be provided
name | S | 1..1 | string | Description of service as presented to a consumer while searching
Slices for telecom |  | 1..* | ContactPoint | Contacts related to the healthcare service Slice: Unordered, Open by exists:extension('http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceTelecomAppointment')
telecom:AppointmentContact | S | 1..* | ContactPoint | Contacts related to the healthcare service
extension |  | 1..* | Extension | Extension
Slices for extension |  |  |  | Content/Rules for all slices
extension:ForAppointment | S | 1..1 | boolean | Telecom is for making appointments URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceTelecomAppointment
system | S | 1..1 | code | phone | fax | email | pager | url | sms | other
value | S | 1..1 | string | The actual contact point details
program | S | 0..* | CodeableConcept | Programs that this service is applicable to
characteristic | S | 0..* | CodeableConcept | Collection of characteristics (attributes) Binding: USCoreProcedureCodes (7.0.0) (required): Codes describing the type of Procedure
Additional Bindings | Purpose | Usage
USCoreProcedureCodes (7.0.0) | Current |
DigitalAccessProcedures (20240615) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = digital-access
DigitalLiteracyProcedures (20240628) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = digital-literacy
LessThanHighSchoolEducationProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = educational-attainment
ElderAbuseProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = elder-abuse
UnemploymentProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = employment-status
FinancialInsecurityProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = financial-insecurity
FoodInsecurityProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = food-insecurity
HealthInsuranceCoverageStatusProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = health-insurance-coverage-status
HomelessnessProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = homelessness
HousingInstabilityProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = housing-instability
InadequateHousingProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = inadequate-housing
Incarceration Status Procedures | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = incarceration-status
IntimatePartnerViolenceProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = intimate-partner-violence
Language Access Procedures | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = language-access
MaterialHardshipProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = material-hardship
MedicalCostBurdenProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = medical-cost-burden
HealthLiteracyProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = personal-health-literacy
SocialConnectionProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = social-connection
StressProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = stress
TransportationInsecurityProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = transportation-insecurity
UtilityInsecurityProcedures (20240524) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = utility-insecurity
VeteranStatusProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = veteran-status
USCoreProcedureCodes (7.0.0) | Required | SDOHCCHealthcareService#`HealthcareService.category` = sdoh-category-unspecified
communication | S | 0..* | CodeableConcept | The language that this service is offered in
appointmentRequired | S | 0..1 | boolean | If an appointment is required for access to this service
availableTime | S | 0..* | BackboneElement | Times the Service Site is available
notAvailable | S | 0..* | BackboneElement | Not available during this time due to provided reason
availabilityExceptions | S | 0..1 | string | Description of availability exceptions
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
HealthcareService.category.coding:ServiceCategory | required | SDOHCCValueSetServiceCategory `http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetServiceCategory` From this IG
HealthcareService.category.coding:SDOHCC | required | SDOHCCValueSetSDOHCategory `http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategory` From this IG
HealthcareService.type | extensible | SDOHCCValueSetHealthcareServiceType `http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetHealthcareServiceType` From this IG
HealthcareService.characteristic | required | USCoreProcedureCodes `http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code|7.0.0`

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
HealthcareService |  | 0..* | HealthcareService | The details of a healthcare service available at a location
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:capacity-status |  | 0..1 | (Complex) | Is the service currently at capacity? URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceCapacityStatus
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | External identifiers for this item
active | ?!S Σ | 1..1 | boolean | Whether this HealthcareService record is in active use Fixed Value: true
providedBy | Σ | 0..1 | Reference(Organization) | Organization that provides this service
category | S Σ | 1..* | CodeableConcept | Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided.
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding | S Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this
coding:ServiceCategory | S Σ | 1..1 | Coding | Code defined by a terminology system Binding: SDOHCC ValueSet Service Category (required)
coding:SDOHCC | S Σ | 0..* | Coding | e.g., food-insecurity | transportation-insecurity Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories.
text | Σ | 0..1 | string | Plain text representation of the concept
type | S Σ | 1..1 | CodeableConcept | Type of service that may be delivered or performed Binding: SDOHCC ValueSet Healthcare Service Type (extensible)
specialty | Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide.
location | S Σ | 0..* | Reference(SDOHCC Location) | Location(s) where service may be provided
name | S Σ | 1..1 | string | Description of service as presented to a consumer while searching
comment | Σ | 0..1 | string | Additional description and/or any specific issues not covered elsewhere
extraDetails |  | 0..1 | markdown | Extra details about the service that can't be placed in the other fields
photo | Σ | 0..1 | Attachment | Facilitates quick identification of the service
Slices for telecom |  | 1..* | ContactPoint | Contacts related to the healthcare service Slice: Unordered, Open by exists:extension('http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceTelecomAppointment')
telecom:AppointmentContact | S | 1..* | ContactPoint | Contacts related to the healthcare service
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:ForAppointment | S | 1..1 | boolean | Telecom is for making appointments URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceTelecomAppointment
system | S Σ C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | S Σ | 1..1 | string | The actual contact point details
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest)
period | Σ | 0..1 | Period | Time period when the contact point was/is in use
coverageArea |  | 0..* | Reference(Location) | Location(s) service is intended for/available to
serviceProvisionCode |  | 0..* | CodeableConcept | Conditions under which service is available/offered Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered.
eligibility |  | 0..* | BackboneElement | Specific eligibility requirements required to use the service
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code |  | 0..1 | CodeableConcept | Coded value for the eligibility Binding Description: (example): Coded values underwhich a specific service is made available.
comment |  | 0..1 | markdown | Describes the eligibility conditions for the service
program | S | 0..* | CodeableConcept | Programs that this service is applicable to Binding: Program (example): Government or local programs that this service applies to.
characteristic | S | 0..* | CodeableConcept | Collection of characteristics (attributes) Binding: USCoreProcedureCodes (7.0.0) (required): Codes describing the type of Procedure
Additional Bindings | Purpose | Usage
USCoreProcedureCodes (7.0.0) | Current |
DigitalAccessProcedures (20240615) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = digital-access
DigitalLiteracyProcedures (20240628) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = digital-literacy
LessThanHighSchoolEducationProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = educational-attainment
ElderAbuseProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = elder-abuse
UnemploymentProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = employment-status
FinancialInsecurityProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = financial-insecurity
FoodInsecurityProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = food-insecurity
HealthInsuranceCoverageStatusProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = health-insurance-coverage-status
HomelessnessProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = homelessness
HousingInstabilityProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = housing-instability
InadequateHousingProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = inadequate-housing
Incarceration Status Procedures | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = incarceration-status
IntimatePartnerViolenceProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = intimate-partner-violence
Language Access Procedures | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = language-access
MaterialHardshipProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = material-hardship
MedicalCostBurdenProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = medical-cost-burden
HealthLiteracyProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = personal-health-literacy
SocialConnectionProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = social-connection
StressProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = stress
TransportationInsecurityProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = transportation-insecurity
UtilityInsecurityProcedures (20240524) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = utility-insecurity
VeteranStatusProcedures (20240604) | Extensible | SDOHCCHealthcareService#`HealthcareService.category` = veteran-status
USCoreProcedureCodes (7.0.0) | Required | SDOHCCHealthcareService#`HealthcareService.category` = sdoh-category-unspecified
communication | S | 0..* | CodeableConcept | The language that this service is offered in Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
referralMethod |  | 0..* | CodeableConcept | Ways that the service accepts referrals Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthCareService resource.
appointmentRequired | S | 0..1 | boolean | If an appointment is required for access to this service
availableTime | S | 0..* | BackboneElement | Times the Service Site is available
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
daysOfWeek |  | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay |  | 0..1 | boolean | Always available? e.g. 24 hour service
availableStartTime |  | 0..1 | time | Opening time of day (ignored if allDay = true)
availableEndTime |  | 0..1 | time | Closing time of day (ignored if allDay = true)
notAvailable | S | 0..* | BackboneElement | Not available during this time due to provided reason
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
description |  | 1..1 | string | Reason presented to the user explaining why time not available
during |  | 0..1 | Period | Service not available from this date
availabilityExceptions | S | 0..1 | string | Description of availability exceptions
endpoint |  | 0..* | Reference(Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
HealthcareService.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages|4.0.1` From the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
HealthcareService.category | example | ServiceCategory `http://hl7.org/fhir/ValueSet/service-category|4.0.1` From the FHIR Standard
HealthcareService.category.coding:ServiceCategory | required | SDOHCCValueSetServiceCategory `http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetServiceCategory` From this IG
HealthcareService.category.coding:SDOHCC | required | SDOHCCValueSetSDOHCategory `http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetSDOHCategory` From this IG
HealthcareService.type | extensible | SDOHCCValueSetHealthcareServiceType `http://hl7.org/fhir/us/sdoh-clinicalcare/ValueSet/SDOHCC-ValueSetHealthcareServiceType` From this IG
HealthcareService.specialty | preferred | PracticeSettingCodeValueSet `http://hl7.org/fhir/ValueSet/c80-practice-codes|4.0.1` From the FHIR Standard
HealthcareService.telecom:AppointmentContact.system | required | ContactPointSystem `http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1` From the FHIR Standard
HealthcareService.telecom:AppointmentContact.use | required | ContactPointUse `http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1` From the FHIR Standard
HealthcareService.serviceProvisionCode | example | ServiceProvisionConditions `http://hl7.org/fhir/ValueSet/service-provision-conditions|4.0.1` From the FHIR Standard
HealthcareService.eligibility.code | example |
HealthcareService.program | example | Program `http://hl7.org/fhir/ValueSet/program|4.0.1` From the FHIR Standard
HealthcareService.characteristic | required | USCoreProcedureCodes `http://hl7.org/fhir/us/core/ValueSet/us-core-procedure-code|7.0.0`
HealthcareService.communication | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages|4.0.1` From the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
HealthcareService.referralMethod | example | ReferralMethod `http://hl7.org/fhir/ValueSet/service-referral-method|4.0.1` From the FHIR Standard
HealthcareService.availableTime.daysOfWeek | required | DaysOfWeek `http://hl7.org/fhir/ValueSet/days-of-week|4.0.1` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | HealthcareService | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | HealthcareService | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | HealthcareService | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |

This structure is derived from HealthcareService

Summary

Mandatory: 12 elements
Must-Support: 19 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

- SDOHCC Location (http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Location)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceCapacityStatus
- http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceTelecomAppointment

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of HealthcareService.category.coding
- The element 1 is sliced based on the value of HealthcareService.telecom

Maturity: 2

Other representations of profile: CSV, Excel, Schematron