SDOH Clinical Care
2.1.0 - STU 2.1 United States of America flag

This page is part of the SDOH Clinical Care for Multiple Domains (v2.1.0: STU 2.1) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: SDOHCC Healthcare Service

Official URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-HealthcareService Version: 2.1.0
Draft as of 2023-07-27 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).

Usage:

Formal Views of Profile Content

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

This structure is derived from HealthcareService

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*HealthcareServiceThe details of a healthcare service available at a location
... active S1..1booleanWhether this HealthcareService record is in active use
Fixed Value: true
... location S0..*Reference(SDOHCC Location)Location(s) where service may be provided
... name S1..1stringDescription of service as presented to a consumer while searching
.... telecom:AppointmentContact S1..*ContactPointContacts related to the healthcare service
..... extension 1..*ExtensionExtension
..... ForAppointment S1..1booleanTelecom is for making appointments
URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceTelecomAppointment
..... system S1..1codephone | fax | email | pager | url | sms | other
..... value S1..1stringThe actual contact point details
... communication S0..*CodeableConceptThe language that this service is offered in
... appointmentRequired S0..1booleanIf an appointment is required for access to this service
... availableTime S0..*BackboneElementTimes the Service Site is available
... notAvailable S0..*BackboneElementNot available during this time due to provided reason
... availabilityExceptions S0..1stringDescription of availability exceptions

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*HealthcareServiceThe details of a healthcare service available at a location
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... active ?!SΣ1..1booleanWhether this HealthcareService record is in active use
Fixed Value: true
... name SΣ1..1stringDescription of service as presented to a consumer while searching
... Slices for telecom 1..*ContactPointContacts related to the healthcare service
Slice: Unordered, Open by exists:extension('http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceTelecomAppointment')
.... telecom:AppointmentContact S1..*ContactPointContacts related to the healthcare service
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... ForAppointment S1..1booleanTelecom is for making appointments
URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceTelecomAppointment
..... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... value SΣ1..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

... communication S0..*CodeableConceptThe language that this service is offered in
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

... appointmentRequired S0..1booleanIf an appointment is required for access to this service
... availableTime S0..*BackboneElementTimes the Service Site is available
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
... notAvailable S0..*BackboneElementNot available during this time due to provided reason
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 1..1stringReason presented to the user explaining why time not available
... availabilityExceptions S0..1stringDescription of availability exceptions

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
HealthcareService.telecom:AppointmentContact.systemrequiredContactPointSystem
HealthcareService.telecom:AppointmentContact.userequiredContactPointUse
HealthcareService.communicationpreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*HealthcareServiceThe details of a healthcare service available at a location
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal identifiers for this item
... active ?!SΣ1..1booleanWhether this HealthcareService record is in active use
Fixed Value: true
... providedBy Σ0..1Reference(Organization)Organization that provides this service
... category Σ0..*CodeableConceptBroad category of service being performed or delivered
Binding: ServiceCategory (example): A category of the service(s) that could be provided.


... type Σ0..*CodeableConceptType of service that may be delivered or performed
Binding: ServiceType (example): Additional details about where the content was created (e.g. clinical specialty).


... specialty Σ0..*CodeableConceptSpecialties 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..1stringDescription of service as presented to a consumer while searching
... comment Σ0..1stringAdditional description and/or any specific issues not covered elsewhere
... extraDetails 0..1markdownExtra details about the service that can't be placed in the other fields
... photo Σ0..1AttachmentFacilitates quick identification of the service
... Slices for telecom 1..*ContactPointContacts related to the healthcare service
Slice: Unordered, Open by exists:extension('http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceTelecomAppointment')
.... telecom:AppointmentContact S1..*ContactPointContacts related to the healthcare service
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... ForAppointment S1..1booleanTelecom is for making appointments
URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceTelecomAppointment
..... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... value SΣ1..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
... coverageArea 0..*Reference(Location)Location(s) service is intended for/available to
... serviceProvisionCode 0..*CodeableConceptConditions 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..*BackboneElementSpecific eligibility requirements required to use the service
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 0..1CodeableConceptCoded value for the eligibility
Binding: (unbound) (example): Coded values underwhich a specific service is made available.

.... comment 0..1markdownDescribes the eligibility conditions for the service
... program 0..*CodeableConceptPrograms that this service is applicable to
Binding: Program (example): Government or local programs that this service applies to.


... characteristic 0..*CodeableConceptCollection of characteristics (attributes)
Binding: (unbound) (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).


... communication S0..*CodeableConceptThe language that this service is offered in
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

... referralMethod 0..*CodeableConceptWays that the service accepts referrals
Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthCareService resource.


... appointmentRequired S0..1booleanIf an appointment is required for access to this service
... availableTime S0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
... notAvailable S0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not available from this date
... availabilityExceptions S0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to electronic services operated for the healthcare service

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
HealthcareService.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
HealthcareService.categoryexampleServiceCategory
HealthcareService.typeexampleServiceType
HealthcareService.specialtypreferredPracticeSettingCodeValueSet
HealthcareService.telecom:AppointmentContact.systemrequiredContactPointSystem
HealthcareService.telecom:AppointmentContact.userequiredContactPointUse
HealthcareService.serviceProvisionCodeexampleServiceProvisionConditions
HealthcareService.eligibility.codeexample
HealthcareService.programexampleProgram
HealthcareService.characteristicexample
HealthcareService.communicationpreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
HealthcareService.referralMethodexampleReferralMethod
HealthcareService.availableTime.daysOfWeekrequiredDaysOfWeek

This structure is derived from HealthcareService

Summary

Mandatory: 8 elements
Must-Support: 12 elements
Fixed Value: 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 HealthcareService.telecom is sliced based on the value of exists:extension('http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceTelecomAppointment')

Differential View

This structure is derived from HealthcareService

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*HealthcareServiceThe details of a healthcare service available at a location
... active S1..1booleanWhether this HealthcareService record is in active use
Fixed Value: true
... location S0..*Reference(SDOHCC Location)Location(s) where service may be provided
... name S1..1stringDescription of service as presented to a consumer while searching
.... telecom:AppointmentContact S1..*ContactPointContacts related to the healthcare service
..... extension 1..*ExtensionExtension
..... ForAppointment S1..1booleanTelecom is for making appointments
URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceTelecomAppointment
..... system S1..1codephone | fax | email | pager | url | sms | other
..... value S1..1stringThe actual contact point details
... communication S0..*CodeableConceptThe language that this service is offered in
... appointmentRequired S0..1booleanIf an appointment is required for access to this service
... availableTime S0..*BackboneElementTimes the Service Site is available
... notAvailable S0..*BackboneElementNot available during this time due to provided reason
... availabilityExceptions S0..1stringDescription of availability exceptions

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*HealthcareServiceThe details of a healthcare service available at a location
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... active ?!SΣ1..1booleanWhether this HealthcareService record is in active use
Fixed Value: true
... name SΣ1..1stringDescription of service as presented to a consumer while searching
... Slices for telecom 1..*ContactPointContacts related to the healthcare service
Slice: Unordered, Open by exists:extension('http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceTelecomAppointment')
.... telecom:AppointmentContact S1..*ContactPointContacts related to the healthcare service
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... ForAppointment S1..1booleanTelecom is for making appointments
URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceTelecomAppointment
..... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... value SΣ1..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

... communication S0..*CodeableConceptThe language that this service is offered in
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

... appointmentRequired S0..1booleanIf an appointment is required for access to this service
... availableTime S0..*BackboneElementTimes the Service Site is available
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
... notAvailable S0..*BackboneElementNot available during this time due to provided reason
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 1..1stringReason presented to the user explaining why time not available
... availabilityExceptions S0..1stringDescription of availability exceptions

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
HealthcareService.telecom:AppointmentContact.systemrequiredContactPointSystem
HealthcareService.telecom:AppointmentContact.userequiredContactPointUse
HealthcareService.communicationpreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..*HealthcareServiceThe details of a healthcare service available at a location
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal identifiers for this item
... active ?!SΣ1..1booleanWhether this HealthcareService record is in active use
Fixed Value: true
... providedBy Σ0..1Reference(Organization)Organization that provides this service
... category Σ0..*CodeableConceptBroad category of service being performed or delivered
Binding: ServiceCategory (example): A category of the service(s) that could be provided.


... type Σ0..*CodeableConceptType of service that may be delivered or performed
Binding: ServiceType (example): Additional details about where the content was created (e.g. clinical specialty).


... specialty Σ0..*CodeableConceptSpecialties 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..1stringDescription of service as presented to a consumer while searching
... comment Σ0..1stringAdditional description and/or any specific issues not covered elsewhere
... extraDetails 0..1markdownExtra details about the service that can't be placed in the other fields
... photo Σ0..1AttachmentFacilitates quick identification of the service
... Slices for telecom 1..*ContactPointContacts related to the healthcare service
Slice: Unordered, Open by exists:extension('http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceTelecomAppointment')
.... telecom:AppointmentContact S1..*ContactPointContacts related to the healthcare service
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... ForAppointment S1..1booleanTelecom is for making appointments
URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceTelecomAppointment
..... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... value SΣ1..1stringThe actual contact point details
..... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
..... period Σ0..1PeriodTime period when the contact point was/is in use
... coverageArea 0..*Reference(Location)Location(s) service is intended for/available to
... serviceProvisionCode 0..*CodeableConceptConditions 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..*BackboneElementSpecific eligibility requirements required to use the service
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 0..1CodeableConceptCoded value for the eligibility
Binding: (unbound) (example): Coded values underwhich a specific service is made available.

.... comment 0..1markdownDescribes the eligibility conditions for the service
... program 0..*CodeableConceptPrograms that this service is applicable to
Binding: Program (example): Government or local programs that this service applies to.


... characteristic 0..*CodeableConceptCollection of characteristics (attributes)
Binding: (unbound) (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).


... communication S0..*CodeableConceptThe language that this service is offered in
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

... referralMethod 0..*CodeableConceptWays that the service accepts referrals
Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthCareService resource.


... appointmentRequired S0..1booleanIf an appointment is required for access to this service
... availableTime S0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
... notAvailable S0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not available from this date
... availabilityExceptions S0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to electronic services operated for the healthcare service

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
HealthcareService.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
HealthcareService.categoryexampleServiceCategory
HealthcareService.typeexampleServiceType
HealthcareService.specialtypreferredPracticeSettingCodeValueSet
HealthcareService.telecom:AppointmentContact.systemrequiredContactPointSystem
HealthcareService.telecom:AppointmentContact.userequiredContactPointUse
HealthcareService.serviceProvisionCodeexampleServiceProvisionConditions
HealthcareService.eligibility.codeexample
HealthcareService.programexampleProgram
HealthcareService.characteristicexample
HealthcareService.communicationpreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
HealthcareService.referralMethodexampleReferralMethod
HealthcareService.availableTime.daysOfWeekrequiredDaysOfWeek

This structure is derived from HealthcareService

Summary

Mandatory: 8 elements
Must-Support: 12 elements
Fixed Value: 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 HealthcareService.telecom is sliced based on the value of exists:extension('http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceTelecomAppointment')

 

Other representations of profile: CSV, Excel, Schematron