National Directory of Healthcare Providers & Services (NDH) Implementation Guide
2.0.0-current - ci-build

National Directory of Healthcare Providers & Services (NDH) Implementation Guide, published by HL7 International / Patient Administration. This guide is not an authorized publication; it is the continuous build for version 2.0.0-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-us-ndh/ and changes regularly. See the Directory of published versions

## Resource Profile: NDH HealthcareService Profile

Official URL: http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-HealthcareService | Version: 2.0.0-current
Standards status: Trial-use | Maturity Level: 4 | Computable Name: NdhHealthcareService

The HealthCareService resource typically describes services offered by an organization/practitioner at a location. The resource may be used to encompass a variety of services covering the entire healthcare spectrum, including promotion, prevention, diagnostics, pharmacy, hospital and ambulatory care, home care, long-term care, and other health-related and community services.

Usages:

- Refer to this Profile: NDH OrganizationAffiliation Profile and NDH PractitionerRole
- Examples for this Profile: HealthcareService/BurrClinicServices, HealthcareService/HansSoloService, HealthcareService/HartfordOrthopedicServices, HOPE INC... Show 3 more, Towson Food INC, Welcome Home and Pharmacy by PharmChain
- CapabilityStatements using this Profile: NDH Server Capability Statement

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

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

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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
HealthcareService |  | 0..* | HealthcareService | The details of a healthcare service available at a location
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:rating |  | 0..* | (Complex) | Evaluations or reviews for the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
extension:newpatients | C | 0..* | (Complex) | Is the service currently accepting new patients? URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients Constraints: new-patients-characteristics
extension:deliverymethod |  | 0..* | (Complex) | Method of providing the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-delivery-method
extension:paymentaccepted |  | 0..* | CodeableConcept | Forms of payment accepted. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted Binding: Hl7VSPaymentMethodCode (2.0.0) (required)
extension:requiredDocument |  | 0..* | (Complex) | Documents required for the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-requiredDocument
extension:fundingSource |  | 0..* | (Complex) | Funding source for the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource
extension:verification-status |  | 0..1 | CodeableConcept | Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible)
extension:network |  | 0..* | Reference(NDH Network Profile) | Network associated with social service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference
extension:social-service-requirement | C | 0..* | (Complex) | Social Service Requirement URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement Constraints: agerange-or-agegroup
extension:logo |  | 0..1 | Attachment | Service Logo URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | External identifiers for this item
Slices for extension |  |  |  | Content/Rules for all slices
extension:identifier-status |  | 0..1 | code | Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required)
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
assigner | Σ | 0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text)
active | ?!S Σ | 1..1 | boolean | Whether this HealthcareService record is in active use Required Pattern: true
providedBy | S Σ | 0..1 | Reference(NDH Organization Profile) | Organization that provides this service
Slices for category | S Σ | 1..* | CodeableConcept | Broad category of service being performed or delivered Slice: Unordered, Open by value:$this Binding: ServiceCategory (example): A category of the service(s) that could be provided.
category:HSC | S Σ | 0..1 | CodeableConcept | NDH HealthcareService Category Binding: Healthcare Service Category Value Set (required)
type | S Σ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: HealthcareService Type Value Set (extensible)
specialty | S Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: HealthcareProviderTaxonomy (20240606) (extensible)
location | S Σ | 0..* | Reference(NDH Location Profile) | Location(s) where service may be provided
name | S Σ | 0..1 | string | Description of service as presented to a consumer while searching
telecom |  | 0..* | ContactPoint | Contacts related to the healthcare service
Slices for extension |  |  |  | Content/Rules for all slices
extension:contactpoint-availabletime |  | 0..* | (Complex) | Availability Hours for the Contact Point URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
extension:via-intermediary |  | 0..1 | Reference(NDH PractitionerRole | NDH OrganizationAffiliation Profile | NDH Location Profile | NDH Organization Profile) | Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
extension:language-speak |  | 0..* | code | Language Speak URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak Binding: CommonLanguages (extensible)
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
coverageArea | S | 0..* | Reference(NDH Location Profile) | Location(s) service is intended for/available to
serviceProvisionCode |  | 0..* | CodeableConcept | Conditions under which service is available/offered Binding: ServiceProvisionConditions (extensible)
program |  | 0..* | CodeableConcept | Programs that this service is applicable to Binding: Program (extensible)
Slices for extension |  |  |  | Content/Rules for all slices
extension:program-requirement |  | 0..* | (Complex) | Program Requirement URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement
endpoint | S | 0..* | Reference(NDH Endpoint Profile) | Technical endpoints providing access to electronic services operated for the healthcare service
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
HealthcareService.identifier.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
HealthcareService.category | Base | example | Service category | 📍4.0.1 | FHIR Std.
HealthcareService.category:HSC | Base | required | Healthcare Service Category Value Set | 📦2.0.0-current | This IG
HealthcareService.type | Base | extensible | HealthcareService Type Value Set | 📦2.0.0-current | This IG
HealthcareService.specialty | Base | extensible | Healthcare Provider Taxonomy | 📍20240606 | VSAC v0.19
HealthcareService.telecom.​use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
HealthcareService.serviceProvisionCode | Base | extensible | ServiceProvisionConditions | 📦4.0.1 | FHIR Std.
HealthcareService.program | Base | extensible | Program | 📦4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
agerange-or-agegroup | error | HealthcareService.extension:social-service-requirement | a service or program only allow to have either age-range or age-group but not both | `extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-ndh-age-range').empty() or extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-ndh-age-group').empty() or (extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-ndh-age-range').empty() and extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-ndh-age-group').empty())`
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()`
new-patients-characteristics | error | HealthcareService.extension:newpatients | If no new patients are accepted, no characteristics are allowed | `extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients').value.coding.exists(code = 'nopt') implies extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients-characteristics').empty()`

This structure is derived from HealthcareService

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
HealthcareService |  | 0..* | HealthcareService | The details of a healthcare service available at a location
meta |  |  |  |
lastUpdated |  | 1..1 | instant | When the resource version last changed
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:rating |  | 0..* | (Complex) | Evaluations or reviews for the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
extension:newpatients |  | 0..* | (Complex) | Is the service currently accepting new patients? URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients
extension:deliverymethod |  | 0..* | (Complex) | Method of providing the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-delivery-method
extension:paymentaccepted |  | 0..* | CodeableConcept | Forms of payment accepted. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted Binding: Hl7VSPaymentMethodCode (2.0.0) (required)
extension:requiredDocument |  | 0..* | (Complex) | Documents required for the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-requiredDocument
extension:fundingSource |  | 0..* | (Complex) | Funding source for the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource
extension:verification-status |  | 0..1 | CodeableConcept | Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible)
extension:network |  | 0..* | Reference(NDH Network Profile) | Network associated with social service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference
extension:social-service-requirement |  | 0..* | (Complex) | Social Service Requirement URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement
extension:logo |  | 0..1 | Attachment | Service Logo URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo
identifier |  | 0..* | Identifier | External identifiers for this item
Slices for extension |  |  |  | Content/Rules for all slices
extension:identifier-status |  | 0..1 | code | Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required)
assigner |  | 0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text)
active | S | 1..1 | boolean | Whether this HealthcareService record is in active use Required Pattern: true
providedBy | S | 0..1 | Reference(NDH Organization Profile) | Organization that provides this service
Slices for category | S | 1..* | CodeableConcept | Broad category of service being performed or delivered Slice: Unordered, Open by value:$this
category:HSC | S | 0..1 | CodeableConcept | NDH HealthcareService Category Binding: Healthcare Service Category Value Set (required)
type | S | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: HealthcareService Type Value Set (extensible)
specialty | S | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: HealthcareProviderTaxonomy (20240606) (extensible)
location | S | 0..* | Reference(NDH Location Profile) | Location(s) where service may be provided
name | S | 0..1 | string | Description of service as presented to a consumer while searching
telecom |  | 0..* | ContactPoint | Contacts related to the healthcare service
Slices for extension |  |  |  | Content/Rules for all slices
extension:contactpoint-availabletime |  | 0..* | (Complex) | Availability Hours for the Contact Point URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
extension:via-intermediary |  | 0..1 | Reference(NDH PractitionerRole | NDH OrganizationAffiliation Profile | NDH Location Profile | NDH Organization Profile) | Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
extension:language-speak |  | 0..* | code | Language Speak URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak Binding: CommonLanguages (extensible)
coverageArea | S | 0..* | Reference(NDH Location Profile) | Location(s) service is intended for/available to
serviceProvisionCode |  | 0..* | CodeableConcept | Conditions under which service is available/offered Binding: ServiceProvisionConditions (extensible)
eligibility |  |  |  |
code |  | 0..1 | CodeableConcept | Coded value for the eligibility Binding: Healthcare Service Eligibility Code Value Set (extensible)
program |  | 0..* | CodeableConcept | Programs that this service is applicable to Binding: Program (extensible)
Slices for extension |  |  |  | Content/Rules for all slices
extension:program-requirement |  | 0..* | (Complex) | Program Requirement URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement
endpoint | S | 0..* | Reference(NDH Endpoint Profile) | Technical endpoints providing access to electronic services operated for the healthcare service
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
HealthcareService.category:HSC | Base | required | Healthcare Service Category Value Set | 📦2.0.0-current | This IG
HealthcareService.type | Base | extensible | HealthcareService Type Value Set | 📦2.0.0-current | This IG
HealthcareService.specialty | Base | extensible | Healthcare Provider Taxonomy | 📍20240606 | VSAC v0.19
HealthcareService.serviceProvisionCode | Base | extensible | ServiceProvisionConditions | 📦4.0.1 | FHIR Std.
HealthcareService.eligibility.​code | Base | extensible | Healthcare Service Eligibility Code Value Set | 📦2.0.0-current | This IG
HealthcareService.program | Base | extensible | Program | 📦4.0.1 | FHIR Std.

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
HealthcareService |  | 0..* | HealthcareService | The details of a healthcare service available at a location
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
versionId | Σ | 0..1 | id | Version specific identifier
lastUpdated | Σ | 1..1 | instant | When the resource version last changed
source | Σ | 0..1 | uri | Identifies where the resource comes from
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:rating |  | 0..* | (Complex) | Evaluations or reviews for the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
extension:newpatients | C | 0..* | (Complex) | Is the service currently accepting new patients? URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients Constraints: new-patients-characteristics
extension:deliverymethod |  | 0..* | (Complex) | Method of providing the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-delivery-method
extension:paymentaccepted |  | 0..* | CodeableConcept | Forms of payment accepted. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted Binding: Hl7VSPaymentMethodCode (2.0.0) (required)
extension:requiredDocument |  | 0..* | (Complex) | Documents required for the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-requiredDocument
extension:fundingSource |  | 0..* | (Complex) | Funding source for the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource
extension:verification-status |  | 0..1 | CodeableConcept | Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible)
extension:network |  | 0..* | Reference(NDH Network Profile) | Network associated with social service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference
extension:social-service-requirement | C | 0..* | (Complex) | Social Service Requirement URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement Constraints: agerange-or-agegroup
extension:logo |  | 0..1 | Attachment | Service Logo URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | External identifiers for this item
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:identifier-status |  | 0..1 | code | Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required)
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | Σ | 0..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text)
active | ?!S Σ | 1..1 | boolean | Whether this HealthcareService record is in active use Required Pattern: true
providedBy | S Σ | 0..1 | Reference(NDH Organization Profile) | Organization that provides this service
Slices for category | S Σ | 1..* | CodeableConcept | Broad category of service being performed or delivered Slice: Unordered, Open by value:$this Binding: ServiceCategory (example): A category of the service(s) that could be provided.
category:HSC | S Σ | 0..1 | CodeableConcept | NDH HealthcareService Category Binding: Healthcare Service Category Value Set (required)
type | S Σ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: HealthcareService Type Value Set (extensible)
specialty | S Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: HealthcareProviderTaxonomy (20240606) (extensible)
location | S Σ | 0..* | Reference(NDH Location Profile) | Location(s) where service may be provided
name | S Σ | 0..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
telecom |  | 0..* | ContactPoint | Contacts related to the healthcare service
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:contactpoint-availabletime |  | 0..* | (Complex) | Availability Hours for the Contact Point URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
extension:via-intermediary |  | 0..1 | Reference(NDH PractitionerRole | NDH OrganizationAffiliation Profile | NDH Location Profile | NDH Organization Profile) | Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
extension:language-speak |  | 0..* | code | Language Speak URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak Binding: CommonLanguages (extensible)
system | Σ C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | Σ | 0..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 | S | 0..* | Reference(NDH Location Profile) | Location(s) service is intended for/available to
serviceProvisionCode |  | 0..* | CodeableConcept | Conditions under which service is available/offered Binding: ServiceProvisionConditions (extensible)
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: Healthcare Service Eligibility Code Value Set (extensible)
comment |  | 0..1 | markdown | Describes the eligibility conditions for the service
program |  | 0..* | CodeableConcept | Programs that this service is applicable to Binding: Program (extensible)
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:program-requirement |  | 0..* | (Complex) | Program Requirement URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement
coding | Σ | 0..* | Coding | Code defined by a terminology system
text | Σ | 0..1 | string | Plain text representation of the concept
characteristic |  | 0..* | CodeableConcept | Collection of characteristics (attributes) Binding Description: (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
communication |  | 0..* | CodeableConcept | The language that this service is offered in Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
referralMethod |  | 0..* | CodeableConcept | Ways that the service accepts referrals Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthCareService resource.
appointmentRequired |  | 0..1 | boolean | If an appointment is required for access to this service
availableTime |  | 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 |  | 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 |  | 0..1 | string | Description of availability exceptions
endpoint | S | 0..* | Reference(NDH Endpoint Profile) | Technical endpoints providing access to electronic services operated for the healthcare service
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
HealthcareService.meta.​security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std.
HealthcareService.meta.​tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std.
HealthcareService.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
HealthcareService.identifier.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
HealthcareService.identifier.​type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
HealthcareService.category | Base | example | Service category | 📍4.0.1 | FHIR Std.
HealthcareService.category:HSC | Base | required | Healthcare Service Category Value Set | 📦2.0.0-current | This IG
HealthcareService.type | Base | extensible | HealthcareService Type Value Set | 📦2.0.0-current | This IG
HealthcareService.specialty | Base | extensible | Healthcare Provider Taxonomy | 📍20240606 | VSAC v0.19
HealthcareService.telecom.​system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
HealthcareService.telecom.​use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
HealthcareService.serviceProvisionCode | Base | extensible | ServiceProvisionConditions | 📦4.0.1 | FHIR Std.
HealthcareService.eligibility.​code | Base | extensible | Healthcare Service Eligibility Code Value Set | 📦2.0.0-current | This IG
HealthcareService.program | Base | extensible | Program | 📦4.0.1 | FHIR Std.
HealthcareService.characteristic | Base | example |  | Not State | Unknown
HealthcareService.communication | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
HealthcareService.referralMethod | Base | example | ReferralMethod | 📍4.0.1 | FHIR Std.
HealthcareService.availableTime.​daysOfWeek | Base | required | DaysOfWeek | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
agerange-or-agegroup | error | HealthcareService.extension:social-service-requirement | a service or program only allow to have either age-range or age-group but not both | `extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-ndh-age-range').empty() or extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-ndh-age-group').empty() or (extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-ndh-age-range').empty() and extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-ndh-age-group').empty())`
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()`
new-patients-characteristics | error | HealthcareService.extension:newpatients | If no new patients are accepted, no characteristics are allowed | `extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients').value.coding.exists(code = 'nopt') implies extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients-characteristics').empty()`

This structure is derived from HealthcareService

Summary

Mandatory: 2 elements(1 nested mandatory element)
Must-Support: 10 elements

Structures

This structure refers to these other structures:

- NDH Organization Profile (http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Organization)
- NDH Location Profile (http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Location)
- NDH Endpoint Profile (http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Endpoint)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-delivery-method
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-requiredDocument
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak

Slices

This structure defines the following Slices:

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

Maturity: 4

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
HealthcareService |  | 0..* | HealthcareService | The details of a healthcare service available at a location
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:rating |  | 0..* | (Complex) | Evaluations or reviews for the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
extension:newpatients | C | 0..* | (Complex) | Is the service currently accepting new patients? URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients Constraints: new-patients-characteristics
extension:deliverymethod |  | 0..* | (Complex) | Method of providing the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-delivery-method
extension:paymentaccepted |  | 0..* | CodeableConcept | Forms of payment accepted. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted Binding: Hl7VSPaymentMethodCode (2.0.0) (required)
extension:requiredDocument |  | 0..* | (Complex) | Documents required for the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-requiredDocument
extension:fundingSource |  | 0..* | (Complex) | Funding source for the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource
extension:verification-status |  | 0..1 | CodeableConcept | Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible)
extension:network |  | 0..* | Reference(NDH Network Profile) | Network associated with social service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference
extension:social-service-requirement | C | 0..* | (Complex) | Social Service Requirement URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement Constraints: agerange-or-agegroup
extension:logo |  | 0..1 | Attachment | Service Logo URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | External identifiers for this item
Slices for extension |  |  |  | Content/Rules for all slices
extension:identifier-status |  | 0..1 | code | Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required)
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
assigner | Σ | 0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text)
active | ?!S Σ | 1..1 | boolean | Whether this HealthcareService record is in active use Required Pattern: true
providedBy | S Σ | 0..1 | Reference(NDH Organization Profile) | Organization that provides this service
Slices for category | S Σ | 1..* | CodeableConcept | Broad category of service being performed or delivered Slice: Unordered, Open by value:$this Binding: ServiceCategory (example): A category of the service(s) that could be provided.
category:HSC | S Σ | 0..1 | CodeableConcept | NDH HealthcareService Category Binding: Healthcare Service Category Value Set (required)
type | S Σ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: HealthcareService Type Value Set (extensible)
specialty | S Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: HealthcareProviderTaxonomy (20240606) (extensible)
location | S Σ | 0..* | Reference(NDH Location Profile) | Location(s) where service may be provided
name | S Σ | 0..1 | string | Description of service as presented to a consumer while searching
telecom |  | 0..* | ContactPoint | Contacts related to the healthcare service
Slices for extension |  |  |  | Content/Rules for all slices
extension:contactpoint-availabletime |  | 0..* | (Complex) | Availability Hours for the Contact Point URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
extension:via-intermediary |  | 0..1 | Reference(NDH PractitionerRole | NDH OrganizationAffiliation Profile | NDH Location Profile | NDH Organization Profile) | Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
extension:language-speak |  | 0..* | code | Language Speak URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak Binding: CommonLanguages (extensible)
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
coverageArea | S | 0..* | Reference(NDH Location Profile) | Location(s) service is intended for/available to
serviceProvisionCode |  | 0..* | CodeableConcept | Conditions under which service is available/offered Binding: ServiceProvisionConditions (extensible)
program |  | 0..* | CodeableConcept | Programs that this service is applicable to Binding: Program (extensible)
Slices for extension |  |  |  | Content/Rules for all slices
extension:program-requirement |  | 0..* | (Complex) | Program Requirement URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement
endpoint | S | 0..* | Reference(NDH Endpoint Profile) | Technical endpoints providing access to electronic services operated for the healthcare service
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
HealthcareService.identifier.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
HealthcareService.category | Base | example | Service category | 📍4.0.1 | FHIR Std.
HealthcareService.category:HSC | Base | required | Healthcare Service Category Value Set | 📦2.0.0-current | This IG
HealthcareService.type | Base | extensible | HealthcareService Type Value Set | 📦2.0.0-current | This IG
HealthcareService.specialty | Base | extensible | Healthcare Provider Taxonomy | 📍20240606 | VSAC v0.19
HealthcareService.telecom.​use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
HealthcareService.serviceProvisionCode | Base | extensible | ServiceProvisionConditions | 📦4.0.1 | FHIR Std.
HealthcareService.program | Base | extensible | Program | 📦4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
agerange-or-agegroup | error | HealthcareService.extension:social-service-requirement | a service or program only allow to have either age-range or age-group but not both | `extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-ndh-age-range').empty() or extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-ndh-age-group').empty() or (extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-ndh-age-range').empty() and extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-ndh-age-group').empty())`
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()`
new-patients-characteristics | error | HealthcareService.extension:newpatients | If no new patients are accepted, no characteristics are allowed | `extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients').value.coding.exists(code = 'nopt') implies extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients-characteristics').empty()`

Differential View

This structure is derived from HealthcareService

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
HealthcareService |  | 0..* | HealthcareService | The details of a healthcare service available at a location
meta |  |  |  |
lastUpdated |  | 1..1 | instant | When the resource version last changed
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:rating |  | 0..* | (Complex) | Evaluations or reviews for the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
extension:newpatients |  | 0..* | (Complex) | Is the service currently accepting new patients? URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients
extension:deliverymethod |  | 0..* | (Complex) | Method of providing the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-delivery-method
extension:paymentaccepted |  | 0..* | CodeableConcept | Forms of payment accepted. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted Binding: Hl7VSPaymentMethodCode (2.0.0) (required)
extension:requiredDocument |  | 0..* | (Complex) | Documents required for the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-requiredDocument
extension:fundingSource |  | 0..* | (Complex) | Funding source for the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource
extension:verification-status |  | 0..1 | CodeableConcept | Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible)
extension:network |  | 0..* | Reference(NDH Network Profile) | Network associated with social service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference
extension:social-service-requirement |  | 0..* | (Complex) | Social Service Requirement URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement
extension:logo |  | 0..1 | Attachment | Service Logo URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo
identifier |  | 0..* | Identifier | External identifiers for this item
Slices for extension |  |  |  | Content/Rules for all slices
extension:identifier-status |  | 0..1 | code | Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required)
assigner |  | 0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text)
active | S | 1..1 | boolean | Whether this HealthcareService record is in active use Required Pattern: true
providedBy | S | 0..1 | Reference(NDH Organization Profile) | Organization that provides this service
Slices for category | S | 1..* | CodeableConcept | Broad category of service being performed or delivered Slice: Unordered, Open by value:$this
category:HSC | S | 0..1 | CodeableConcept | NDH HealthcareService Category Binding: Healthcare Service Category Value Set (required)
type | S | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: HealthcareService Type Value Set (extensible)
specialty | S | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: HealthcareProviderTaxonomy (20240606) (extensible)
location | S | 0..* | Reference(NDH Location Profile) | Location(s) where service may be provided
name | S | 0..1 | string | Description of service as presented to a consumer while searching
telecom |  | 0..* | ContactPoint | Contacts related to the healthcare service
Slices for extension |  |  |  | Content/Rules for all slices
extension:contactpoint-availabletime |  | 0..* | (Complex) | Availability Hours for the Contact Point URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
extension:via-intermediary |  | 0..1 | Reference(NDH PractitionerRole | NDH OrganizationAffiliation Profile | NDH Location Profile | NDH Organization Profile) | Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
extension:language-speak |  | 0..* | code | Language Speak URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak Binding: CommonLanguages (extensible)
coverageArea | S | 0..* | Reference(NDH Location Profile) | Location(s) service is intended for/available to
serviceProvisionCode |  | 0..* | CodeableConcept | Conditions under which service is available/offered Binding: ServiceProvisionConditions (extensible)
eligibility |  |  |  |
code |  | 0..1 | CodeableConcept | Coded value for the eligibility Binding: Healthcare Service Eligibility Code Value Set (extensible)
program |  | 0..* | CodeableConcept | Programs that this service is applicable to Binding: Program (extensible)
Slices for extension |  |  |  | Content/Rules for all slices
extension:program-requirement |  | 0..* | (Complex) | Program Requirement URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement
endpoint | S | 0..* | Reference(NDH Endpoint Profile) | Technical endpoints providing access to electronic services operated for the healthcare service
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
HealthcareService.category:HSC | Base | required | Healthcare Service Category Value Set | 📦2.0.0-current | This IG
HealthcareService.type | Base | extensible | HealthcareService Type Value Set | 📦2.0.0-current | This IG
HealthcareService.specialty | Base | extensible | Healthcare Provider Taxonomy | 📍20240606 | VSAC v0.19
HealthcareService.serviceProvisionCode | Base | extensible | ServiceProvisionConditions | 📦4.0.1 | FHIR Std.
HealthcareService.eligibility.​code | Base | extensible | Healthcare Service Eligibility Code Value Set | 📦2.0.0-current | This IG
HealthcareService.program | Base | extensible | Program | 📦4.0.1 | FHIR Std.

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
HealthcareService |  | 0..* | HealthcareService | The details of a healthcare service available at a location
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
versionId | Σ | 0..1 | id | Version specific identifier
lastUpdated | Σ | 1..1 | instant | When the resource version last changed
source | Σ | 0..1 | uri | Identifies where the resource comes from
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:rating |  | 0..* | (Complex) | Evaluations or reviews for the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
extension:newpatients | C | 0..* | (Complex) | Is the service currently accepting new patients? URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients Constraints: new-patients-characteristics
extension:deliverymethod |  | 0..* | (Complex) | Method of providing the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-delivery-method
extension:paymentaccepted |  | 0..* | CodeableConcept | Forms of payment accepted. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted Binding: Hl7VSPaymentMethodCode (2.0.0) (required)
extension:requiredDocument |  | 0..* | (Complex) | Documents required for the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-requiredDocument
extension:fundingSource |  | 0..* | (Complex) | Funding source for the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource
extension:verification-status |  | 0..1 | CodeableConcept | Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible)
extension:network |  | 0..* | Reference(NDH Network Profile) | Network associated with social service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference
extension:social-service-requirement | C | 0..* | (Complex) | Social Service Requirement URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement Constraints: agerange-or-agegroup
extension:logo |  | 0..1 | Attachment | Service Logo URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | External identifiers for this item
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:identifier-status |  | 0..1 | code | Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required)
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | Σ | 0..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(NDH Organization Profile) | Organization that issued id (may be just text)
active | ?!S Σ | 1..1 | boolean | Whether this HealthcareService record is in active use Required Pattern: true
providedBy | S Σ | 0..1 | Reference(NDH Organization Profile) | Organization that provides this service
Slices for category | S Σ | 1..* | CodeableConcept | Broad category of service being performed or delivered Slice: Unordered, Open by value:$this Binding: ServiceCategory (example): A category of the service(s) that could be provided.
category:HSC | S Σ | 0..1 | CodeableConcept | NDH HealthcareService Category Binding: Healthcare Service Category Value Set (required)
type | S Σ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: HealthcareService Type Value Set (extensible)
specialty | S Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: HealthcareProviderTaxonomy (20240606) (extensible)
location | S Σ | 0..* | Reference(NDH Location Profile) | Location(s) where service may be provided
name | S Σ | 0..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
telecom |  | 0..* | ContactPoint | Contacts related to the healthcare service
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:contactpoint-availabletime |  | 0..* | (Complex) | Availability Hours for the Contact Point URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
extension:via-intermediary |  | 0..1 | Reference(NDH PractitionerRole | NDH OrganizationAffiliation Profile | NDH Location Profile | NDH Organization Profile) | Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
extension:language-speak |  | 0..* | code | Language Speak URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak Binding: CommonLanguages (extensible)
system | Σ C | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value | Σ | 0..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 | S | 0..* | Reference(NDH Location Profile) | Location(s) service is intended for/available to
serviceProvisionCode |  | 0..* | CodeableConcept | Conditions under which service is available/offered Binding: ServiceProvisionConditions (extensible)
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: Healthcare Service Eligibility Code Value Set (extensible)
comment |  | 0..1 | markdown | Describes the eligibility conditions for the service
program |  | 0..* | CodeableConcept | Programs that this service is applicable to Binding: Program (extensible)
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:program-requirement |  | 0..* | (Complex) | Program Requirement URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement
coding | Σ | 0..* | Coding | Code defined by a terminology system
text | Σ | 0..1 | string | Plain text representation of the concept
characteristic |  | 0..* | CodeableConcept | Collection of characteristics (attributes) Binding Description: (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
communication |  | 0..* | CodeableConcept | The language that this service is offered in Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
referralMethod |  | 0..* | CodeableConcept | Ways that the service accepts referrals Binding: ReferralMethod (example): The methods of referral can be used when referring to a specific HealthCareService resource.
appointmentRequired |  | 0..1 | boolean | If an appointment is required for access to this service
availableTime |  | 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 |  | 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 |  | 0..1 | string | Description of availability exceptions
endpoint | S | 0..* | Reference(NDH Endpoint Profile) | Technical endpoints providing access to electronic services operated for the healthcare service
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
HealthcareService.meta.​security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std.
HealthcareService.meta.​tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std.
HealthcareService.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
HealthcareService.identifier.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
HealthcareService.identifier.​type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
HealthcareService.category | Base | example | Service category | 📍4.0.1 | FHIR Std.
HealthcareService.category:HSC | Base | required | Healthcare Service Category Value Set | 📦2.0.0-current | This IG
HealthcareService.type | Base | extensible | HealthcareService Type Value Set | 📦2.0.0-current | This IG
HealthcareService.specialty | Base | extensible | Healthcare Provider Taxonomy | 📍20240606 | VSAC v0.19
HealthcareService.telecom.​system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std.
HealthcareService.telecom.​use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std.
HealthcareService.serviceProvisionCode | Base | extensible | ServiceProvisionConditions | 📦4.0.1 | FHIR Std.
HealthcareService.eligibility.​code | Base | extensible | Healthcare Service Eligibility Code Value Set | 📦2.0.0-current | This IG
HealthcareService.program | Base | extensible | Program | 📦4.0.1 | FHIR Std.
HealthcareService.characteristic | Base | example |  | Not State | Unknown
HealthcareService.communication | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
HealthcareService.referralMethod | Base | example | ReferralMethod | 📍4.0.1 | FHIR Std.
HealthcareService.availableTime.​daysOfWeek | Base | required | DaysOfWeek | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
agerange-or-agegroup | error | HealthcareService.extension:social-service-requirement | a service or program only allow to have either age-range or age-group but not both | `extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-ndh-age-range').empty() or extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-ndh-age-group').empty() or (extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-ndh-age-range').empty() and extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-ndh-age-group').empty())`
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()`
new-patients-characteristics | error | HealthcareService.extension:newpatients | If no new patients are accepted, no characteristics are allowed | `extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients').value.coding.exists(code = 'nopt') implies extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients-characteristics').empty()`

This structure is derived from HealthcareService

Summary

Mandatory: 2 elements(1 nested mandatory element)
Must-Support: 10 elements

Structures

This structure refers to these other structures:

- NDH Organization Profile (http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Organization)
- NDH Location Profile (http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Location)
- NDH Endpoint Profile (http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Endpoint)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-delivery-method
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-requiredDocument
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak

Slices

This structure defines the following Slices:

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

Maturity: 4

Other representations of profile: CSV, Excel, Schematron

### Notes:

#### Search Parameters

##### Search Parameter defined by the NDH IG

SearchParameter Name | Type | Example
eligibility | token | `GET [base]/HealthcareService?eligibility=2403008`
new-patient | token | `GET [base]/HealthcareService?new-patient=newpt`
new-patient-from-network | reference | `GET [base]/HealthcareService?new-patient-from-network.type=ntwk&new-patient-from-network.address-state=CT`
verification-status | token | `GET [base]/HealthcareService?verification-status=complete`
network | reference | `GET [base]/HealthcareService?network.type=ntwk&network.address-state=CT`
social-service-age-group | token | `GET [base]/HealthcareService?social-service-age-group=teens&program=42`
social-service-birthsex | token | `GET [base]/HealthcareService?social-service-birthsex=F`
social-service-employment-status | token | `GET [base]/HealthcareService?social-service-employment-status=unemployed`
social-service-insurance-status | token | `GET [base]/HealthcareService?social-service-insurance-status=uninsured`
social-service-preferred-language | token | `GET [base]/HealthcareService?social-service-preferred-language=en`
social-service-va-status | token | `GET [base]/HealthcareService?social-service-va-status=true`
program-requirement-age-group | token | `GET [base]/HealthcareService?program-requirement-age-group=teens`
program-requirement-birthsex | token | `GET [base]/HealthcareService?program-requirement-birthsex=M`
program-requirement-employment-status | token | `GET [base]/HealthcareService?program-requirement-employment-status=employed`
program-requirement-insurance-status | token | `GET [base]/HealthcareService?program-requirement-insurance-status=uninsured`
program-requirement-preferred-language | token | `GET [base]/HealthcareService?program-requirement-preferred-language=sp`
program-requirement-va-status | token | `GET [base]/HealthcareService?program-requirement-va-status=false`
location | reference | `GET [base]/HealthcareService?location.address-state=CT`
organization | reference | `GET [base]/HealthcareService?organization.name=HOPE INC`
verification-status | token | `GET [base]/HealthcareService?verification-status=complete`

##### Search Parameter defined by FHIR Search Parameter Registry and used by the NDH IG

Since there is no direct individual url for each Search Parameter defined by FHIR Serach Parameter Registry, we have provided the following links for you to access more information about them.

- Search Parameter Registry
- Healthcareservice Search Parameter from Registry

SearchParameter Name | Type | Example
--- | --- | ---
active | token | `GET [base]/HealthcareService?active=true`
coverage-area | reference | `GET [base]/HealthcareService?coverage-area.address-state=CT`
endpoint | reference | `GET [base]/HealthcareService?endpoint.connection-type=hl7-fhir-rest`
identifier | token | `GET [base]/HealthcareService?identifier=1234567`
name | string | `GET [base]/HealthcareService?name=HOPE INC`
program | token | `GET [base]/HealthcareService?prgram=6`
service-category | token | `GET [base]/HealthcareService?service-category=behav`
service-type | token | `GET [base]/HealthcareService?service-type=230`
specialty | token | `GET [base]/HealthcareService?specialty=101YS0200X`

##### _include Search Parameter

_include | Example
--- | ---
HealthcareService:coverage-area | `GET [base]/HealthcareService?_include=HealthcareService:coverage-area`
HealthcareService:endpoint | `GET [base]/HealthcareService?_include=HealthcareService:endpoint`
HealthcareService:location | `GET [base]/HealthcareService?_id=BurrClinicServices&_include=HealthcareService:location`
HealthcareService:new-patient-from-network | `GET [base]/HealthcareService?_include=HealthcareService:new-patient-from-network`
HealthcareService:organization | `GET [base]/HealthcareService?_id=BurrClinicServices&_include=HealthcareService:organization`

##### _revinclude Search parameter

_revinclude
OrganizationAffiliation:service
PractitionerRole:service

#### Special Search Parameters

The search parameters outlined above are straightforward for basic scenarios but have limitations in handling complex combination queries. To enhance these capabilities, employing the special search parameters _filter is recommended.

##### Search use cases

###### Search for all organizations and locations provide a given HealthcareService

If you run the search below for the HealthcareService called `BurrClinicServices`, it should return a search bundle that includes the `BurrClinicServices` resource, as well as the associated `BurrClinic` Organization resource and the `HospLoc1` Location resource. This indicates that the `BurrClinic` organization provides the `BurrClinicServices` healthcare service at the `HospLoc1` location.

`GET [base]/HealthcareService?_id=BurrClinicServices&_include=HealthcareService:organization&_include=HealthcareService:location`

or `GET [base]/OrganizationAffiliation?service:HealthcareService._id=BurrClinicServices`

To search for a specific OrganizationAffiliation and its associated resources, you can use the following query:

`GET [base]/OrganizationAffiliation?_id=BurrClinicAffil&_include=OrganizationAffiliation:service&_include=OrganizationAffiliation:location&_include=OrganizationAffiliation:participating-organization&_include=OrganizationAffiliation:network`

#### Usage

##### Network extension

The primary intention for the network extension of the HealthcareService is to cater to services related to social services. Typically, healthcare service networks are tied to insurance plans. However, in the realm of social services, the delivery or subscription of services often occurs through a hub. This hub embodies a similar concept to a network, but without an insurance plan attached. To simplify the process of locating such hubs (networks), NDH offers a connection from the healthcare server to the network. For instance, the Welcome Home organization provides housing services at the Welcome Home location. This service is subscribed to through the Social Service Housing Network.

##### Healthcare Service and Program Requirement extensions

The extension for Healthcare Service or Program Requirement is applied at both the Service and Program levels. Each Service or Program can have multiple requirements, and each requirement can have several constraints. For instance, one service could be specifically for teens, another for females, or even one designed exclusively for teenage girls.

##### Language Speak extension

If a service supports multiple languages, up to six for example, it's unlikely that these would be restricted within this extension. Instead, the languages spoken should be documented under the "healthcareService.communication" field.

##### User requests a healthcare service delivered by an organization at a location

The recommended approach for a user requesting a healthcare service provided by an organization at a location is to use the healthcare service resource. This depends on whether the nature of the service is offered at a single location or across multiple locations.

If a healthcare service is available at multiple locations, each location may have unique endpoints, operating hours, and telecom. The specific data for each location concerning endpoints, operating hours, and telecom (HealthcareService.location => Location.endpoint, Location.hoursOfOperation, Location.telecom …) will supersede the general data provided at the healthcare service resource instance level (HealthcareService.endpoint, HealthcareService.availableTime, HealthcareService.telecom …). This approach provides flexibility: it permits the use of unified endpoints, operating hours, and telephones for the healthcare service when the information is consistent across all locations, while also allowing for differences in endpoints and operating hours at various locations.