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-draft 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
| Official URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-HealthcareService | Version: 3.0.0-draft | |||
| Standards status: Trial-use Active as of 2025-10-27 | Maturity Level: 2 | Computable Name: SDOHCCHealthcareService | ||
Profile that describes the means by which a healthcare service can be contacted.
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
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:   | ||||
|---|---|---|---|---|---|---|---|---|
  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 | ||||
| communication |
S | 0..* | CodeableConcept | The language that this service is offered in Binding: CommonLanguages (preferred): A human language.
| ||||
| 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 | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| HealthcareService.category | Base | example | Service category | 📍4.0.1 | FHIR Std. |
| HealthcareService.category.coding:ServiceCategory | Base | required | SDOHCC ValueSet Service Category | 📦3.0.0-draft | This IG |
| HealthcareService.category.coding:SDOHCC | Base | required | SDOHCC ValueSet SDOH Category | 📦3.0.0-draft | This IG |
| HealthcareService.type | Base | extensible | SDOHCC ValueSet Healthcare Service Type | 📦3.0.0-draft | 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 | example | Program | 📍4.0.1 | FHIR Std. |
| HealthcareService.characteristic | Base | required | US Core Procedure Codes | 📍7.0.0 | US Core v7.0 |
| HealthcareService.communication | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| 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()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 |
| 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 | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| HealthcareService.category.coding:ServiceCategory | Base | required | SDOHCC ValueSet Service Category | 📦3.0.0-draft | This IG |
| HealthcareService.category.coding:SDOHCC | Base | required | SDOHCC ValueSet SDOH Category | 📦3.0.0-draft | This IG |
| HealthcareService.type | Base | extensible | SDOHCC ValueSet Healthcare Service Type | 📦3.0.0-draft | This IG |
| HealthcareService.characteristic | Base | required | US Core Procedure Codes | 📍7.0.0 | US Core v7.0 |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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.
| |||||
| 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 | ||||
| communication |
S | 0..* | CodeableConcept | The language that this service is offered in Binding: CommonLanguages (preferred): A human language.
| ||||
| 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 | ||||||||
| 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.category.coding:ServiceCategory | Base | required | SDOHCC ValueSet Service Category | 📦3.0.0-draft | This IG |
| HealthcareService.category.coding:SDOHCC | Base | required | SDOHCC ValueSet SDOH Category | 📦3.0.0-draft | This IG |
| HealthcareService.type | Base | extensible | SDOHCC ValueSet Healthcare Service Type | 📦3.0.0-draft | 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 Stated | Unknown | |
| HealthcareService.program | Base | example | Program | 📍4.0.1 | FHIR Std. |
| HealthcareService.characteristic | Base | required | US Core Procedure Codes | 📍7.0.0 | US Core v7.0 |
| 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. |
| 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()
|
Summary
Mandatory: 12 elements
Must-Support: 19 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:
Maturity: 2
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | ||||
| communication |
S | 0..* | CodeableConcept | The language that this service is offered in Binding: CommonLanguages (preferred): A human language.
| ||||
| 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 | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| HealthcareService.category | Base | example | Service category | 📍4.0.1 | FHIR Std. |
| HealthcareService.category.coding:ServiceCategory | Base | required | SDOHCC ValueSet Service Category | 📦3.0.0-draft | This IG |
| HealthcareService.category.coding:SDOHCC | Base | required | SDOHCC ValueSet SDOH Category | 📦3.0.0-draft | This IG |
| HealthcareService.type | Base | extensible | SDOHCC ValueSet Healthcare Service Type | 📦3.0.0-draft | 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 | example | Program | 📍4.0.1 | FHIR Std. |
| HealthcareService.characteristic | Base | required | US Core Procedure Codes | 📍7.0.0 | US Core v7.0 |
| HealthcareService.communication | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 |
| 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 | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| HealthcareService.category.coding:ServiceCategory | Base | required | SDOHCC ValueSet Service Category | 📦3.0.0-draft | This IG |
| HealthcareService.category.coding:SDOHCC | Base | required | SDOHCC ValueSet SDOH Category | 📦3.0.0-draft | This IG |
| HealthcareService.type | Base | extensible | SDOHCC ValueSet Healthcare Service Type | 📦3.0.0-draft | This IG |
| HealthcareService.characteristic | Base | required | US Core Procedure Codes | 📍7.0.0 | US Core v7.0 |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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.
| |||||
| 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 | ||||
| communication |
S | 0..* | CodeableConcept | The language that this service is offered in Binding: CommonLanguages (preferred): A human language.
| ||||
| 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 | ||||||||
| 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.category.coding:ServiceCategory | Base | required | SDOHCC ValueSet Service Category | 📦3.0.0-draft | This IG |
| HealthcareService.category.coding:SDOHCC | Base | required | SDOHCC ValueSet SDOH Category | 📦3.0.0-draft | This IG |
| HealthcareService.type | Base | extensible | SDOHCC ValueSet Healthcare Service Type | 📦3.0.0-draft | 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 Stated | Unknown | |
| HealthcareService.program | Base | example | Program | 📍4.0.1 | FHIR Std. |
| HealthcareService.characteristic | Base | required | US Core Procedure Codes | 📍7.0.0 | US Core v7.0 |
| 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. |
| 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()
|
Summary
Mandatory: 12 elements
Must-Support: 19 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:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
IG © 2021+ HL7 International / Patient Care.
Package hl7.fhir.us.sdoh-clinicalcare#3.0.0-draft based on FHIR 4.0.1.
Generated 2025-10-27
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
