SDOH Clinical Care
3.1.0 - STU 3.1 Draft United States of America flag

SDOH Clinical Care, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 3.1.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.1.0
Standards status: Trial-use Maturity Level: 2 Computable Name: SDOHCCHealthcareService
Other Identifiers: OID:2.16.840.1.113883.4.642.40.6.42.8

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:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
HealthcareService 0..* HealthcareService The details of a healthcare service available at a location
HealthcareService.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
HealthcareService.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
HealthcareService.active This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean Whether this HealthcareService record is in active use
Fixed Value: true (no extensions allowed)
HealthcareService.type This element is included in summaries. 0..* CodeableConcept Type of service that may be delivered or performed
Binding: SDOHCC ValueSet Healthcare Service Type (extensible)
HealthcareService.location This element must be supported. This element is included in summaries. 0..* Reference(SDOHCC Location) Location(s) where service may be provided
HealthcareService.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')

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
HealthcareService.Slices for telecom.telecom:AppointmentContact This element must be supported. 1..* ContactPoint Contacts related to the healthcare service
HealthcareService.Slices for telecom.telecom:AppointmentContact.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
HealthcareService.Slices for telecom.telecom:AppointmentContact.Slices for extension Content/Rules for all slices
HealthcareService.Slices for telecom.telecom:AppointmentContact.Slices for extension.extension:ForAppointment This element must be supported. 1..1 boolean Telecom is for making appointments
URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceTelecomAppointment
HealthcareService.Slices for telecom.telecom:AppointmentContact.system This element must be supported. This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
HealthcareService.Slices for telecom.telecom:AppointmentContact.value This element must be supported. This element is included in summaries. 1..1 string The actual contact point details
HealthcareService.Slices for telecom.telecom:AppointmentContact.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
HealthcareService.program 0..* CodeableConcept Programs that this service is applicable to
Binding: Social Determinants of Health Programs SNOMED CT (extensible)
HealthcareService.communication This element must be supported. 0..* CodeableConcept The language that this service is offered in
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

HealthcareService.appointmentRequired This element must be supported. 0..1 boolean If an appointment is required for access to this service
HealthcareService.availableTime This element must be supported. 0..* BackboneElement Times the Service Site is available
HealthcareService.availableTime.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
HealthcareService.notAvailable This element must be supported. 0..* BackboneElement Not available during this time due to provided reason
HealthcareService.notAvailable.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
HealthcareService.notAvailable.description 1..1 string Reason presented to the user explaining why time not available
HealthcareService.availabilityExceptions This element must be supported. 0..1 string Description of availability exceptions

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
HealthcareService.type Base extensible SDOHCC ValueSet Healthcare Service Type 📦3.1.0 This IG
HealthcareService.telecom:AppointmentContact.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
HealthcareService.telecom:AppointmentContact.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
HealthcareService.program Base extensible Social Determinants of Health Programs SNOMED CT 📦20251018 VSAC v0.24
HealthcareService.communication Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
HealthcareService 0..* HealthcareService The details of a healthcare service available at a location
HealthcareService.active This element must be supported. 1..1 boolean Whether this HealthcareService record is in active use
Fixed Value: true (no extensions allowed)
HealthcareService.type 0..* CodeableConcept Type of service that may be delivered or performed
Binding: SDOHCC ValueSet Healthcare Service Type (extensible)
HealthcareService.location This element must be supported. 0..* Reference(SDOHCC Location) Location(s) where service may be provided
HealthcareService.Slices for telecom.telecom:AppointmentContact This element must be supported. 1..* ContactPoint Contacts related to the healthcare service
HealthcareService.Slices for telecom.telecom:AppointmentContact.extension 1..* Extension Extension
HealthcareService.Slices for telecom.telecom:AppointmentContact.Slices for extension Content/Rules for all slices
HealthcareService.Slices for telecom.telecom:AppointmentContact.Slices for extension.extension:ForAppointment This element must be supported. 1..1 boolean Telecom is for making appointments
URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceTelecomAppointment
HealthcareService.Slices for telecom.telecom:AppointmentContact.system This element must be supported. 1..1 code phone | fax | email | pager | url | sms | other
HealthcareService.Slices for telecom.telecom:AppointmentContact.value This element must be supported. 1..1 string The actual contact point details
HealthcareService.program 0..* CodeableConcept Programs that this service is applicable to
Binding: Social Determinants of Health Programs SNOMED CT (extensible)
HealthcareService.communication This element must be supported. 0..* CodeableConcept The language that this service is offered in
HealthcareService.appointmentRequired This element must be supported. 0..1 boolean If an appointment is required for access to this service
HealthcareService.availableTime This element must be supported. 0..* BackboneElement Times the Service Site is available
HealthcareService.notAvailable This element must be supported. 0..* BackboneElement Not available during this time due to provided reason
HealthcareService.availabilityExceptions This element must be supported. 0..1 string Description of availability exceptions

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
HealthcareService.type Base extensible SDOHCC ValueSet Healthcare Service Type 📦3.1.0 This IG
HealthcareService.program Base extensible Social Determinants of Health Programs SNOMED CT 📦20251018 VSAC v0.24
NameFlagsCard.TypeDescription & Constraints    Filter: doco
HealthcareService 0..* HealthcareService The details of a healthcare service available at a location
HealthcareService.id This element is included in summaries. 0..1 id Logical id of this artifact
HealthcareService.meta This element is included in summaries. 0..1 Meta Metadata about the resource
HealthcareService.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
HealthcareService.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
HealthcareService.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
HealthcareService.contained 0..* Resource Contained, inline Resources
HealthcareService.extension 0..* Extension Additional content defined by implementations
HealthcareService.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
HealthcareService.identifier This element is included in summaries. 0..* Identifier External identifiers for this item
HealthcareService.active This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean Whether this HealthcareService record is in active use
Fixed Value: true (no extensions allowed)
HealthcareService.providedBy This element is included in summaries. 0..1 Reference(Organization) Organization that provides this service
HealthcareService.category This element is included in summaries. 0..* CodeableConcept Broad category of service being performed or delivered
Binding: ServiceCategory (example): A category of the service(s) that could be provided.
HealthcareService.type This element is included in summaries. 0..* CodeableConcept Type of service that may be delivered or performed
Binding: SDOHCC ValueSet Healthcare Service Type (extensible)
HealthcareService.specialty This element is included in summaries. 0..* CodeableConcept Specialties handled by the HealthcareService
Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide.
HealthcareService.location This element must be supported. This element is included in summaries. 0..* Reference(SDOHCC Location) Location(s) where service may be provided
HealthcareService.name This element is included in summaries. 0..1 string Description of service as presented to a consumer while searching
HealthcareService.comment This element is included in summaries. 0..1 string Additional description and/or any specific issues not covered elsewhere
HealthcareService.extraDetails 0..1 markdown Extra details about the service that can't be placed in the other fields
HealthcareService.photo This element is included in summaries. 0..1 Attachment Facilitates quick identification of the service
HealthcareService.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')

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
HealthcareService.Slices for telecom.telecom:AppointmentContact This element must be supported. 1..* ContactPoint Contacts related to the healthcare service
HealthcareService.Slices for telecom.telecom:AppointmentContact.id 0..1 string Unique id for inter-element referencing
HealthcareService.Slices for telecom.telecom:AppointmentContact.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
HealthcareService.Slices for telecom.telecom:AppointmentContact.Slices for extension Content/Rules for all slices
HealthcareService.Slices for telecom.telecom:AppointmentContact.Slices for extension.extension:ForAppointment This element must be supported. 1..1 boolean Telecom is for making appointments
URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceTelecomAppointment
HealthcareService.Slices for telecom.telecom:AppointmentContact.system This element must be supported. This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
HealthcareService.Slices for telecom.telecom:AppointmentContact.value This element must be supported. This element is included in summaries. 1..1 string The actual contact point details
HealthcareService.Slices for telecom.telecom:AppointmentContact.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
HealthcareService.Slices for telecom.telecom:AppointmentContact.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
HealthcareService.Slices for telecom.telecom:AppointmentContact.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
HealthcareService.coverageArea 0..* Reference(Location) Location(s) service is intended for/available to
HealthcareService.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.
HealthcareService.eligibility 0..* BackboneElement Specific eligibility requirements required to use the service
HealthcareService.eligibility.id 0..1 string Unique id for inter-element referencing
HealthcareService.eligibility.extension 0..* Extension Additional content defined by implementations
HealthcareService.eligibility.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
HealthcareService.eligibility.code 0..1 CodeableConcept Coded value for the eligibility
Binding Description: (example): Coded values underwhich a specific service is made available.
HealthcareService.eligibility.comment 0..1 markdown Describes the eligibility conditions for the service
HealthcareService.program 0..* CodeableConcept Programs that this service is applicable to
Binding: Social Determinants of Health Programs SNOMED CT (extensible)
HealthcareService.characteristic 0..* CodeableConcept Collection of characteristics (attributes)
Binding Description: (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
HealthcareService.communication This element must be supported. 0..* CodeableConcept The language that this service is offered in
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

HealthcareService.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.
HealthcareService.appointmentRequired This element must be supported. 0..1 boolean If an appointment is required for access to this service
HealthcareService.availableTime This element must be supported. 0..* BackboneElement Times the Service Site is available
HealthcareService.availableTime.id 0..1 string Unique id for inter-element referencing
HealthcareService.availableTime.extension 0..* Extension Additional content defined by implementations
HealthcareService.availableTime.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
HealthcareService.availableTime.daysOfWeek 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.
HealthcareService.availableTime.allDay 0..1 boolean Always available? e.g. 24 hour service
HealthcareService.availableTime.availableStartTime 0..1 time Opening time of day (ignored if allDay = true)
HealthcareService.availableTime.availableEndTime 0..1 time Closing time of day (ignored if allDay = true)
HealthcareService.notAvailable This element must be supported. 0..* BackboneElement Not available during this time due to provided reason
HealthcareService.notAvailable.id 0..1 string Unique id for inter-element referencing
HealthcareService.notAvailable.extension 0..* Extension Additional content defined by implementations
HealthcareService.notAvailable.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
HealthcareService.notAvailable.description 1..1 string Reason presented to the user explaining why time not available
HealthcareService.notAvailable.during 0..1 Period Service not available from this date
HealthcareService.availabilityExceptions This element must be supported. 0..1 string Description of availability exceptions
HealthcareService.endpoint 0..* Reference(Endpoint) Technical endpoints providing access to electronic services operated for the healthcare service

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
HealthcareService.language Base preferred Common Languages 📍4.0.1 FHIR Std.
HealthcareService.category Base example Service category 📍4.0.1 FHIR Std.
HealthcareService.type Base extensible SDOHCC ValueSet Healthcare Service Type 📦3.1.0 This IG
HealthcareService.specialty Base preferred Practice Setting Code Value Set 📍4.0.1 FHIR Std.
HealthcareService.telecom:AppointmentContact.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
HealthcareService.telecom:AppointmentContact.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
HealthcareService.serviceProvisionCode Base example ServiceProvisionConditions 📍4.0.1 FHIR Std.
HealthcareService.eligibility.​code Base example Not State Unknown
HealthcareService.program Base extensible Social Determinants of Health Programs SNOMED CT 📦20251018 VSAC v0.24
HealthcareService.characteristic Base example Not State Unknown
HealthcareService.communication Base preferred Common Languages 📍4.0.1 FHIR Std.
HealthcareService.referralMethod Base example ReferralMethod 📍4.0.1 FHIR Std.
HealthcareService.availableTime.​daysOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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: 7 elements
Must-Support: 11 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of HealthcareService.telecom

Maturity: 2

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
HealthcareService 0..* HealthcareService The details of a healthcare service available at a location
HealthcareService.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
HealthcareService.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
HealthcareService.active This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean Whether this HealthcareService record is in active use
Fixed Value: true (no extensions allowed)
HealthcareService.type This element is included in summaries. 0..* CodeableConcept Type of service that may be delivered or performed
Binding: SDOHCC ValueSet Healthcare Service Type (extensible)
HealthcareService.location This element must be supported. This element is included in summaries. 0..* Reference(SDOHCC Location) Location(s) where service may be provided
HealthcareService.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')

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
HealthcareService.Slices for telecom.telecom:AppointmentContact This element must be supported. 1..* ContactPoint Contacts related to the healthcare service
HealthcareService.Slices for telecom.telecom:AppointmentContact.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
HealthcareService.Slices for telecom.telecom:AppointmentContact.Slices for extension Content/Rules for all slices
HealthcareService.Slices for telecom.telecom:AppointmentContact.Slices for extension.extension:ForAppointment This element must be supported. 1..1 boolean Telecom is for making appointments
URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceTelecomAppointment
HealthcareService.Slices for telecom.telecom:AppointmentContact.system This element must be supported. This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
HealthcareService.Slices for telecom.telecom:AppointmentContact.value This element must be supported. This element is included in summaries. 1..1 string The actual contact point details
HealthcareService.Slices for telecom.telecom:AppointmentContact.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
HealthcareService.program 0..* CodeableConcept Programs that this service is applicable to
Binding: Social Determinants of Health Programs SNOMED CT (extensible)
HealthcareService.communication This element must be supported. 0..* CodeableConcept The language that this service is offered in
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

HealthcareService.appointmentRequired This element must be supported. 0..1 boolean If an appointment is required for access to this service
HealthcareService.availableTime This element must be supported. 0..* BackboneElement Times the Service Site is available
HealthcareService.availableTime.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
HealthcareService.notAvailable This element must be supported. 0..* BackboneElement Not available during this time due to provided reason
HealthcareService.notAvailable.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
HealthcareService.notAvailable.description 1..1 string Reason presented to the user explaining why time not available
HealthcareService.availabilityExceptions This element must be supported. 0..1 string Description of availability exceptions

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
HealthcareService.type Base extensible SDOHCC ValueSet Healthcare Service Type 📦3.1.0 This IG
HealthcareService.telecom:AppointmentContact.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
HealthcareService.telecom:AppointmentContact.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
HealthcareService.program Base extensible Social Determinants of Health Programs SNOMED CT 📦20251018 VSAC v0.24
HealthcareService.communication Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
HealthcareService 0..* HealthcareService The details of a healthcare service available at a location
HealthcareService.active This element must be supported. 1..1 boolean Whether this HealthcareService record is in active use
Fixed Value: true (no extensions allowed)
HealthcareService.type 0..* CodeableConcept Type of service that may be delivered or performed
Binding: SDOHCC ValueSet Healthcare Service Type (extensible)
HealthcareService.location This element must be supported. 0..* Reference(SDOHCC Location) Location(s) where service may be provided
HealthcareService.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')
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
HealthcareService.Slices for telecom.telecom:AppointmentContact This element must be supported. 1..* ContactPoint Contacts related to the healthcare service
HealthcareService.Slices for telecom.telecom:AppointmentContact.extension 1..* Extension Extension
HealthcareService.Slices for telecom.telecom:AppointmentContact.Slices for extension Content/Rules for all slices
HealthcareService.Slices for telecom.telecom:AppointmentContact.Slices for extension.extension:ForAppointment This element must be supported. 1..1 boolean Telecom is for making appointments
URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceTelecomAppointment
HealthcareService.Slices for telecom.telecom:AppointmentContact.system This element must be supported. 1..1 code phone | fax | email | pager | url | sms | other
HealthcareService.Slices for telecom.telecom:AppointmentContact.value This element must be supported. 1..1 string The actual contact point details
HealthcareService.program 0..* CodeableConcept Programs that this service is applicable to
Binding: Social Determinants of Health Programs SNOMED CT (extensible)
HealthcareService.communication This element must be supported. 0..* CodeableConcept The language that this service is offered in
HealthcareService.appointmentRequired This element must be supported. 0..1 boolean If an appointment is required for access to this service
HealthcareService.availableTime This element must be supported. 0..* BackboneElement Times the Service Site is available
HealthcareService.notAvailable This element must be supported. 0..* BackboneElement Not available during this time due to provided reason
HealthcareService.availabilityExceptions This element must be supported. 0..1 string Description of availability exceptions

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
HealthcareService.type Base extensible SDOHCC ValueSet Healthcare Service Type 📦3.1.0 This IG
HealthcareService.program Base extensible Social Determinants of Health Programs SNOMED CT 📦20251018 VSAC v0.24

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
HealthcareService 0..* HealthcareService The details of a healthcare service available at a location
HealthcareService.id This element is included in summaries. 0..1 id Logical id of this artifact
HealthcareService.meta This element is included in summaries. 0..1 Meta Metadata about the resource
HealthcareService.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
HealthcareService.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
HealthcareService.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
HealthcareService.contained 0..* Resource Contained, inline Resources
HealthcareService.extension 0..* Extension Additional content defined by implementations
HealthcareService.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
HealthcareService.identifier This element is included in summaries. 0..* Identifier External identifiers for this item
HealthcareService.active This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean Whether this HealthcareService record is in active use
Fixed Value: true (no extensions allowed)
HealthcareService.providedBy This element is included in summaries. 0..1 Reference(Organization) Organization that provides this service
HealthcareService.category This element is included in summaries. 0..* CodeableConcept Broad category of service being performed or delivered
Binding: ServiceCategory (example): A category of the service(s) that could be provided.
HealthcareService.type This element is included in summaries. 0..* CodeableConcept Type of service that may be delivered or performed
Binding: SDOHCC ValueSet Healthcare Service Type (extensible)
HealthcareService.specialty This element is included in summaries. 0..* CodeableConcept Specialties handled by the HealthcareService
Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide.
HealthcareService.location This element must be supported. This element is included in summaries. 0..* Reference(SDOHCC Location) Location(s) where service may be provided
HealthcareService.name This element is included in summaries. 0..1 string Description of service as presented to a consumer while searching
HealthcareService.comment This element is included in summaries. 0..1 string Additional description and/or any specific issues not covered elsewhere
HealthcareService.extraDetails 0..1 markdown Extra details about the service that can't be placed in the other fields
HealthcareService.photo This element is included in summaries. 0..1 Attachment Facilitates quick identification of the service
HealthcareService.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')

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
HealthcareService.Slices for telecom.telecom:AppointmentContact This element must be supported. 1..* ContactPoint Contacts related to the healthcare service
HealthcareService.Slices for telecom.telecom:AppointmentContact.id 0..1 string Unique id for inter-element referencing
HealthcareService.Slices for telecom.telecom:AppointmentContact.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
HealthcareService.Slices for telecom.telecom:AppointmentContact.Slices for extension Content/Rules for all slices
HealthcareService.Slices for telecom.telecom:AppointmentContact.Slices for extension.extension:ForAppointment This element must be supported. 1..1 boolean Telecom is for making appointments
URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceTelecomAppointment
HealthcareService.Slices for telecom.telecom:AppointmentContact.system This element must be supported. This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
HealthcareService.Slices for telecom.telecom:AppointmentContact.value This element must be supported. This element is included in summaries. 1..1 string The actual contact point details
HealthcareService.Slices for telecom.telecom:AppointmentContact.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
HealthcareService.Slices for telecom.telecom:AppointmentContact.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
HealthcareService.Slices for telecom.telecom:AppointmentContact.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
HealthcareService.coverageArea 0..* Reference(Location) Location(s) service is intended for/available to
HealthcareService.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.
HealthcareService.eligibility 0..* BackboneElement Specific eligibility requirements required to use the service
HealthcareService.eligibility.id 0..1 string Unique id for inter-element referencing
HealthcareService.eligibility.extension 0..* Extension Additional content defined by implementations
HealthcareService.eligibility.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
HealthcareService.eligibility.code 0..1 CodeableConcept Coded value for the eligibility
Binding Description: (example): Coded values underwhich a specific service is made available.
HealthcareService.eligibility.comment 0..1 markdown Describes the eligibility conditions for the service
HealthcareService.program 0..* CodeableConcept Programs that this service is applicable to
Binding: Social Determinants of Health Programs SNOMED CT (extensible)
HealthcareService.characteristic 0..* CodeableConcept Collection of characteristics (attributes)
Binding Description: (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
HealthcareService.communication This element must be supported. 0..* CodeableConcept The language that this service is offered in
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

HealthcareService.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.
HealthcareService.appointmentRequired This element must be supported. 0..1 boolean If an appointment is required for access to this service
HealthcareService.availableTime This element must be supported. 0..* BackboneElement Times the Service Site is available
HealthcareService.availableTime.id 0..1 string Unique id for inter-element referencing
HealthcareService.availableTime.extension 0..* Extension Additional content defined by implementations
HealthcareService.availableTime.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
HealthcareService.availableTime.daysOfWeek 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.
HealthcareService.availableTime.allDay 0..1 boolean Always available? e.g. 24 hour service
HealthcareService.availableTime.availableStartTime 0..1 time Opening time of day (ignored if allDay = true)
HealthcareService.availableTime.availableEndTime 0..1 time Closing time of day (ignored if allDay = true)
HealthcareService.notAvailable This element must be supported. 0..* BackboneElement Not available during this time due to provided reason
HealthcareService.notAvailable.id 0..1 string Unique id for inter-element referencing
HealthcareService.notAvailable.extension 0..* Extension Additional content defined by implementations
HealthcareService.notAvailable.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
HealthcareService.notAvailable.description 1..1 string Reason presented to the user explaining why time not available
HealthcareService.notAvailable.during 0..1 Period Service not available from this date
HealthcareService.availabilityExceptions This element must be supported. 0..1 string Description of availability exceptions
HealthcareService.endpoint 0..* Reference(Endpoint) Technical endpoints providing access to electronic services operated for the healthcare service

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
HealthcareService.language Base preferred Common Languages 📍4.0.1 FHIR Std.
HealthcareService.category Base example Service category 📍4.0.1 FHIR Std.
HealthcareService.type Base extensible SDOHCC ValueSet Healthcare Service Type 📦3.1.0 This IG
HealthcareService.specialty Base preferred Practice Setting Code Value Set 📍4.0.1 FHIR Std.
HealthcareService.telecom:AppointmentContact.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
HealthcareService.telecom:AppointmentContact.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
HealthcareService.serviceProvisionCode Base example ServiceProvisionConditions 📍4.0.1 FHIR Std.
HealthcareService.eligibility.​code Base example Not State Unknown
HealthcareService.program Base extensible Social Determinants of Health Programs SNOMED CT 📦20251018 VSAC v0.24
HealthcareService.characteristic Base example Not State Unknown
HealthcareService.communication Base preferred Common Languages 📍4.0.1 FHIR Std.
HealthcareService.referralMethod Base example ReferralMethod 📍4.0.1 FHIR Std.
HealthcareService.availableTime.​daysOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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: 7 elements
Must-Support: 11 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of HealthcareService.telecom

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron