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-ballot 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-HealthcareServiceForReferralManagement | Version: 3.0.0-ballot | |||
| Standards status: Trial-use Active as of 2025-12-12 | Maturity Level: 2 | Computable Name: SDOHCCHealthcareServiceForReferralManagement | ||
Profile that extends SDOHCC HealthcareService to support capacity status queries, allowing referral sources to determine if a CBO has capacity before initiating a referral. Includes the capacity-status extension and elements for describing services, programs, and contact information.
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: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | SDOHCCHealthcareService | The details of a healthcare service available at a location | |||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
1..1 | (Complex) | Is the service currently at capacity? URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceCapacityStatus | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
?!SΣ | 1..1 | boolean | Whether this HealthcareService record is in active use Fixed Value: true | ||||
![]() ![]() |
SΣ | 1..* | CodeableConcept | Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided. | ||||
![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Coding | Code defined by a terminology system Binding: SDOHCC ValueSet Service Category (required) | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | e.g., food-insecurity | transportation-insecurity Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories. | ||||
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Type of service that may be delivered or performed Binding: SDOHCC ValueSet Healthcare Service Type (extensible) | ||||
![]() ![]() |
SΣ | 0..* | Reference(SDOHCC Location) | Location(s) where service may be provided | ||||
![]() ![]() |
SΣ | 1..1 | string | Description of service as presented to a consumer while searching | ||||
![]() ![]() |
1..* | ContactPoint | Contacts related to the healthcare service Slice: Unordered, Open by exists:extension('http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceTelecomAppointment') | |||||
![]() ![]() ![]() |
S | 1..* | ContactPoint | Contacts related to the healthcare service | ||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | boolean | Telecom is for making appointments URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceTelecomAppointment | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() |
S | 0..* | CodeableConcept | Programs that this service is applicable to Binding: Social Determinants of Health Programs SNOMED CT (extensible) | ||||
![]() ![]() |
S | 0..* | CodeableConcept | The language that this service is offered in Binding: CommonLanguages (preferred): A human language.
| ||||
![]() ![]() |
S | 0..1 | boolean | If an appointment is required for access to this service | ||||
![]() ![]() |
S | 0..* | BackboneElement | Times the Service Site is available | ||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() |
S | 0..* | BackboneElement | Not available during this time due to provided reason | ||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | string | Reason presented to the user explaining why time not available | |||||
![]() ![]() |
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-ballot | This IG |
| HealthcareService.category.coding:SDOHCC | Base | required | SDOHCC ValueSet SDOH Category | 📦3.0.0-ballot | This IG |
| HealthcareService.type | Base | extensible | SDOHCC ValueSet Healthcare Service Type | 📦3.0.0-ballot | 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. |
| 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: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | SDOHCCHealthcareService | The details of a healthcare service available at a location | |
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
1..1 | (Complex) | Is the service currently at capacity? URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceCapacityStatus | |
![]() ![]() |
S | 1..* | CodeableConcept | Broad category of service being performed or delivered |
![]() ![]() ![]() |
S | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this |
![]() ![]() ![]() ![]() |
S | 1..1 | Coding | Code defined by a terminology system Binding: SDOHCC ValueSet Service Category (required) |
![]() ![]() ![]() ![]() |
S | 0..* | Coding | e.g., food-insecurity | transportation-insecurity Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories. |
![]() ![]() |
S | 1..1 | CodeableConcept | Type of service that may be delivered or performed |
![]() ![]() |
S | 1..1 | string | Description of service as presented to a consumer while searching |
![]() ![]() |
S | 0..* | CodeableConcept | Programs that this service is applicable to |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| HealthcareService.category.coding:ServiceCategory | Base | required | SDOHCC ValueSet Service Category | 📦3.0.0-ballot | This IG |
| HealthcareService.category.coding:SDOHCC | Base | required | SDOHCC ValueSet SDOH Category | 📦3.0.0-ballot | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | SDOHCCHealthcareService | The details of a healthcare service available at a location | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
1..1 | (Complex) | Is the service currently at capacity? URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceCapacityStatus | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..* | Identifier | External identifiers for this item | ||||
![]() ![]() |
?!SΣ | 1..1 | boolean | Whether this HealthcareService record is in active use Fixed Value: true | ||||
![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that provides this service | ||||
![]() ![]() |
SΣ | 1..* | CodeableConcept | Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided. | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Coding | Code defined by a terminology system Binding: SDOHCC ValueSet Service Category (required) | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | e.g., food-insecurity | transportation-insecurity Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories. | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Type of service that may be delivered or performed Binding: SDOHCC ValueSet Healthcare Service Type (extensible) | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide. | ||||
![]() ![]() |
SΣ | 0..* | Reference(SDOHCC Location) | Location(s) where service may be provided | ||||
![]() ![]() |
SΣ | 1..1 | string | Description of service as presented to a consumer while searching | ||||
![]() ![]() |
Σ | 0..1 | string | Additional description and/or any specific issues not covered elsewhere | ||||
![]() ![]() |
0..1 | markdown | Extra details about the service that can't be placed in the other fields | |||||
![]() ![]() |
Σ | 0..1 | Attachment | Facilitates quick identification of the service | ||||
![]() ![]() |
1..* | ContactPoint | Contacts related to the healthcare service Slice: Unordered, Open by exists:extension('http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceTelecomAppointment') | |||||
![]() ![]() ![]() |
S | 1..* | ContactPoint | Contacts related to the healthcare service | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | boolean | Telecom is for making appointments URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceTelecomAppointment | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() |
0..* | Reference(Location) | Location(s) service is intended for/available to | |||||
![]() ![]() |
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. | |||||
![]() ![]() |
0..* | BackboneElement | Specific eligibility requirements required to use the service | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Coded value for the eligibility Binding Description: (example): Coded values underwhich a specific service is made available. | |||||
![]() ![]() ![]() |
0..1 | markdown | Describes the eligibility conditions for the service | |||||
![]() ![]() |
S | 0..* | CodeableConcept | Programs that this service is applicable to Binding: Social Determinants of Health Programs SNOMED CT (extensible) | ||||
![]() ![]() |
0..* | CodeableConcept | Collection of characteristics (attributes) Binding Description: (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | |||||
![]() ![]() |
S | 0..* | CodeableConcept | The language that this service is offered in Binding: CommonLanguages (preferred): A human language.
| ||||
![]() ![]() |
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. | |||||
![]() ![]() |
S | 0..1 | boolean | If an appointment is required for access to this service | ||||
![]() ![]() |
S | 0..* | BackboneElement | Times the Service Site is available | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
![]() ![]() ![]() |
0..1 | boolean | Always available? e.g. 24 hour service | |||||
![]() ![]() ![]() |
0..1 | time | Opening time of day (ignored if allDay = true) | |||||
![]() ![]() ![]() |
0..1 | time | Closing time of day (ignored if allDay = true) | |||||
![]() ![]() |
S | 0..* | BackboneElement | Not available during this time due to provided reason | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | string | Reason presented to the user explaining why time not available | |||||
![]() ![]() ![]() |
0..1 | Period | Service not available from this date | |||||
![]() ![]() |
S | 0..1 | string | Description of availability exceptions | ||||
![]() ![]() |
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-ballot | This IG |
| HealthcareService.category.coding:SDOHCC | Base | required | SDOHCC ValueSet SDOH Category | 📦3.0.0-ballot | This IG |
| HealthcareService.type | Base | extensible | SDOHCC ValueSet Healthcare Service Type | 📦3.0.0-ballot | 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. |
| 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()
|
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | SDOHCCHealthcareService | The details of a healthcare service available at a location | |||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
1..1 | (Complex) | Is the service currently at capacity? URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceCapacityStatus | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
?!SΣ | 1..1 | boolean | Whether this HealthcareService record is in active use Fixed Value: true | ||||
![]() ![]() |
SΣ | 1..* | CodeableConcept | Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided. | ||||
![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Coding | Code defined by a terminology system Binding: SDOHCC ValueSet Service Category (required) | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | e.g., food-insecurity | transportation-insecurity Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories. | ||||
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Type of service that may be delivered or performed Binding: SDOHCC ValueSet Healthcare Service Type (extensible) | ||||
![]() ![]() |
SΣ | 0..* | Reference(SDOHCC Location) | Location(s) where service may be provided | ||||
![]() ![]() |
SΣ | 1..1 | string | Description of service as presented to a consumer while searching | ||||
![]() ![]() |
1..* | ContactPoint | Contacts related to the healthcare service Slice: Unordered, Open by exists:extension('http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceTelecomAppointment') | |||||
![]() ![]() ![]() |
S | 1..* | ContactPoint | Contacts related to the healthcare service | ||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | boolean | Telecom is for making appointments URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceTelecomAppointment | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() |
S | 0..* | CodeableConcept | Programs that this service is applicable to Binding: Social Determinants of Health Programs SNOMED CT (extensible) | ||||
![]() ![]() |
S | 0..* | CodeableConcept | The language that this service is offered in Binding: CommonLanguages (preferred): A human language.
| ||||
![]() ![]() |
S | 0..1 | boolean | If an appointment is required for access to this service | ||||
![]() ![]() |
S | 0..* | BackboneElement | Times the Service Site is available | ||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() |
S | 0..* | BackboneElement | Not available during this time due to provided reason | ||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | string | Reason presented to the user explaining why time not available | |||||
![]() ![]() |
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-ballot | This IG |
| HealthcareService.category.coding:SDOHCC | Base | required | SDOHCC ValueSet SDOH Category | 📦3.0.0-ballot | This IG |
| HealthcareService.type | Base | extensible | SDOHCC ValueSet Healthcare Service Type | 📦3.0.0-ballot | 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. |
| 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: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | SDOHCCHealthcareService | The details of a healthcare service available at a location | |
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
1..1 | (Complex) | Is the service currently at capacity? URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceCapacityStatus | |
![]() ![]() |
S | 1..* | CodeableConcept | Broad category of service being performed or delivered |
![]() ![]() ![]() |
S | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this |
![]() ![]() ![]() ![]() |
S | 1..1 | Coding | Code defined by a terminology system Binding: SDOHCC ValueSet Service Category (required) |
![]() ![]() ![]() ![]() |
S | 0..* | Coding | e.g., food-insecurity | transportation-insecurity Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories. |
![]() ![]() |
S | 1..1 | CodeableConcept | Type of service that may be delivered or performed |
![]() ![]() |
S | 1..1 | string | Description of service as presented to a consumer while searching |
![]() ![]() |
S | 0..* | CodeableConcept | Programs that this service is applicable to |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| HealthcareService.category.coding:ServiceCategory | Base | required | SDOHCC ValueSet Service Category | 📦3.0.0-ballot | This IG |
| HealthcareService.category.coding:SDOHCC | Base | required | SDOHCC ValueSet SDOH Category | 📦3.0.0-ballot | This IG |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | SDOHCCHealthcareService | The details of a healthcare service available at a location | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
1..1 | (Complex) | Is the service currently at capacity? URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceCapacityStatus | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..* | Identifier | External identifiers for this item | ||||
![]() ![]() |
?!SΣ | 1..1 | boolean | Whether this HealthcareService record is in active use Fixed Value: true | ||||
![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that provides this service | ||||
![]() ![]() |
SΣ | 1..* | CodeableConcept | Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided. | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Coding | Code defined by a terminology system Binding: SDOHCC ValueSet Service Category (required) | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | e.g., food-insecurity | transportation-insecurity Binding: SDOHCC ValueSet SDOH Category (required): Codes for high-level SDOH categories. | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Type of service that may be delivered or performed Binding: SDOHCC ValueSet Healthcare Service Type (extensible) | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide. | ||||
![]() ![]() |
SΣ | 0..* | Reference(SDOHCC Location) | Location(s) where service may be provided | ||||
![]() ![]() |
SΣ | 1..1 | string | Description of service as presented to a consumer while searching | ||||
![]() ![]() |
Σ | 0..1 | string | Additional description and/or any specific issues not covered elsewhere | ||||
![]() ![]() |
0..1 | markdown | Extra details about the service that can't be placed in the other fields | |||||
![]() ![]() |
Σ | 0..1 | Attachment | Facilitates quick identification of the service | ||||
![]() ![]() |
1..* | ContactPoint | Contacts related to the healthcare service Slice: Unordered, Open by exists:extension('http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceTelecomAppointment') | |||||
![]() ![]() ![]() |
S | 1..* | ContactPoint | Contacts related to the healthcare service | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | boolean | Telecom is for making appointments URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ExtensionHealthcareServiceTelecomAppointment | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The actual contact point details | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
![]() ![]() |
0..* | Reference(Location) | Location(s) service is intended for/available to | |||||
![]() ![]() |
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. | |||||
![]() ![]() |
0..* | BackboneElement | Specific eligibility requirements required to use the service | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Coded value for the eligibility Binding Description: (example): Coded values underwhich a specific service is made available. | |||||
![]() ![]() ![]() |
0..1 | markdown | Describes the eligibility conditions for the service | |||||
![]() ![]() |
S | 0..* | CodeableConcept | Programs that this service is applicable to Binding: Social Determinants of Health Programs SNOMED CT (extensible) | ||||
![]() ![]() |
0..* | CodeableConcept | Collection of characteristics (attributes) Binding Description: (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | |||||
![]() ![]() |
S | 0..* | CodeableConcept | The language that this service is offered in Binding: CommonLanguages (preferred): A human language.
| ||||
![]() ![]() |
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. | |||||
![]() ![]() |
S | 0..1 | boolean | If an appointment is required for access to this service | ||||
![]() ![]() |
S | 0..* | BackboneElement | Times the Service Site is available | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
![]() ![]() ![]() |
0..1 | boolean | Always available? e.g. 24 hour service | |||||
![]() ![]() ![]() |
0..1 | time | Opening time of day (ignored if allDay = true) | |||||
![]() ![]() ![]() |
0..1 | time | Closing time of day (ignored if allDay = true) | |||||
![]() ![]() |
S | 0..* | BackboneElement | Not available during this time due to provided reason | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | string | Reason presented to the user explaining why time not available | |||||
![]() ![]() ![]() |
0..1 | Period | Service not available from this date | |||||
![]() ![]() |
S | 0..1 | string | Description of availability exceptions | ||||
![]() ![]() |
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-ballot | This IG |
| HealthcareService.category.coding:SDOHCC | Base | required | SDOHCC ValueSet SDOH Category | 📦3.0.0-ballot | This IG |
| HealthcareService.type | Base | extensible | SDOHCC ValueSet Healthcare Service Type | 📦3.0.0-ballot | 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. |
| 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()
|
Other representations of profile: CSV, Excel, Schematron