National Directory of Healthcare Providers & Services (NDH) Implementation Guide
2.0.0-current - ci-build
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
| 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 | |||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.43.42.42 | |||||
This profile enables NDH to represent healthcare and community services in a consistent, searchable way so consumers can identify what is offered, where and how it is delivered, and who can access it; it adds extensions for ratings, new-patient intake, delivery method, funding, required documents, network linkage, and verification, and strengthens interoperability with ValueSet-constrained categories, types, specialties, provision conditions, eligibility codes, and programs.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:  | ||||
|---|---|---|---|---|---|---|---|---|
  HealthcareService |
0..* | HealthcareService | The details of a healthcare service available at a location | |||||
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
   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 |
1..1 | boolean | Whether this HealthcareService record is in active use Required Pattern: true (extensions allowed) | |||||
| providedBy |
0..1 | Reference(NDH Organization Profile) | Organization that provides this service | |||||
| Slices for category |
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. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| category:HSC |
0..1 | CodeableConcept | NDH HealthcareService Category Binding: Healthcare Service Category Value Set (required) | |||||
| type |
0..* | CodeableConcept | Type of service that may be delivered or performed Binding: HealthcareService Type Value Set (extensible) | |||||
| specialty |
0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: HealthcareProviderTaxonomy (20240606)  (extensible) | |||||
| location |
0..* | Reference(NDH Location Profile) | Location(s) where service may be provided | |||||
| name |
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 | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| 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 |
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 | |||||
| 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) | |||||
| 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 | |||||
| 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.
| |||||
| 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 | |||||
| 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 | |||||
| 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 |
0..* | Reference(NDH Endpoint Profile) | Technical endpoints providing access to electronic services operated for the healthcare service | |||||
| Documentation for this format | ||||||||
| 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.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. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from HealthcareService
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| 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 |
1..1 | boolean | Whether this HealthcareService record is in active use Required Pattern: true (extensions allowed) | |
| providedBy |
0..1 | Reference(NDH Organization Profile) | Organization that provides this service | |
| Slices for category |
1..* | CodeableConcept | Broad category of service being performed or delivered Slice: Unordered, Open by value:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| category:HSC |
0..1 | CodeableConcept | NDH HealthcareService Category Binding: Healthcare Service Category Value Set (required) | |
| type |
0..* | CodeableConcept | Type of service that may be delivered or performed Binding: HealthcareService Type Value Set (extensible) | |
| specialty |
0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: HealthcareProviderTaxonomy (20240606) (extensible) | |
| location |
0..* | Reference(NDH Location Profile) | Location(s) where service may be provided | |
| name |
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 | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:language-speak |
0..* | code | Language Speak URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak Binding: CommonLanguages (extensible) | |
| coverageArea |
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 | |
| 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 | |
| characteristic |
0..* | CodeableConcept | Collection of characteristics (attributes) | |
| communication |
0..* | CodeableConcept | The language that this service is offered in | |
| referralMethod |
0..* | CodeableConcept | Ways that the service accepts referrals | |
| appointmentRequired |
0..1 | boolean | If an appointment is required for access to this service | |
| availableTime |
0..* | BackboneElement | Times the Service Site is available | |
| daysOfWeek |
0..* | code | mon | tue | wed | thu | fri | sat | sun | |
| 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 | |
| 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 |
0..* | Reference(NDH Endpoint Profile) | Technical endpoints providing access to electronic services operated for the healthcare service | |
| Documentation for this format | ||||
| 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: | ||||
|---|---|---|---|---|---|---|---|---|
| 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.
| |||||
| 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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| 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 |
1..1 | boolean | Whether this HealthcareService record is in active use Required Pattern: true (extensions allowed) | |||||
| providedBy |
0..1 | Reference(NDH Organization Profile) | Organization that provides this service | |||||
| Slices for category |
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. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| category:HSC |
0..1 | CodeableConcept | NDH HealthcareService Category Binding: Healthcare Service Category Value Set (required) | |||||
| type |
0..* | CodeableConcept | Type of service that may be delivered or performed Binding: HealthcareService Type Value Set (extensible) | |||||
| specialty |
0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: HealthcareProviderTaxonomy (20240606) (extensible) | |||||
| location |
0..* | Reference(NDH Location Profile) | Location(s) where service may be provided | |||||
| name |
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: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 |
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.
| |||||
| 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 |
0..* | Reference(NDH Endpoint Profile) | Technical endpoints providing access to electronic services operated for the healthcare service | |||||
| Documentation for this format | ||||||||
| 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. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from HealthcareService
Summary
Mandatory: 2 elements(1 nested mandatory element)
Must-Support: 12 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 4
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| HealthcareService |
0..* | HealthcareService | The details of a healthcare service available at a location | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| 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 |
1..1 | boolean | Whether this HealthcareService record is in active use Required Pattern: true (extensions allowed) | |||||
| providedBy |
0..1 | Reference(NDH Organization Profile) | Organization that provides this service | |||||
| Slices for category |
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. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| category:HSC |
0..1 | CodeableConcept | NDH HealthcareService Category Binding: Healthcare Service Category Value Set (required) | |||||
| type |
0..* | CodeableConcept | Type of service that may be delivered or performed Binding: HealthcareService Type Value Set (extensible) | |||||
| specialty |
0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: HealthcareProviderTaxonomy (20240606) (extensible) | |||||
| location |
0..* | Reference(NDH Location Profile) | Location(s) where service may be provided | |||||
| name |
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 | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| 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 |
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 | |||||
| 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) | |||||
| 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 | |||||
| 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.
| |||||
| 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 | |||||
| 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 | |||||
| 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 |
0..* | Reference(NDH Endpoint Profile) | Technical endpoints providing access to electronic services operated for the healthcare service | |||||
| Documentation for this format | ||||||||
| 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.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. |
| Id | Grade | Path(s) | Description | Expression |
Differential View
This structure is derived from HealthcareService
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| 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 |
1..1 | boolean | Whether this HealthcareService record is in active use Required Pattern: true (extensions allowed) | |
| providedBy |
0..1 | Reference(NDH Organization Profile) | Organization that provides this service | |
| Slices for category |
1..* | CodeableConcept | Broad category of service being performed or delivered Slice: Unordered, Open by value:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| category:HSC |
0..1 | CodeableConcept | NDH HealthcareService Category Binding: Healthcare Service Category Value Set (required) | |
| type |
0..* | CodeableConcept | Type of service that may be delivered or performed Binding: HealthcareService Type Value Set (extensible) | |
| specialty |
0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: HealthcareProviderTaxonomy (20240606) (extensible) | |
| location |
0..* | Reference(NDH Location Profile) | Location(s) where service may be provided | |
| name |
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 | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:language-speak |
0..* | code | Language Speak URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak Binding: CommonLanguages (extensible) | |
| coverageArea |
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 | |
| 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 | |
| characteristic |
0..* | CodeableConcept | Collection of characteristics (attributes) | |
| communication |
0..* | CodeableConcept | The language that this service is offered in | |
| referralMethod |
0..* | CodeableConcept | Ways that the service accepts referrals | |
| appointmentRequired |
0..1 | boolean | If an appointment is required for access to this service | |
| availableTime |
0..* | BackboneElement | Times the Service Site is available | |
| daysOfWeek |
0..* | code | mon | tue | wed | thu | fri | sat | sun | |
| 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 | |
| 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 |
0..* | Reference(NDH Endpoint Profile) | Technical endpoints providing access to electronic services operated for the healthcare service | |
| Documentation for this format | ||||
| 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 ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| HealthcareService |
0..* | HealthcareService | The details of a healthcare service available at a location | |||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| 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.
| |||||
| 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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| 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 |
1..1 | boolean | Whether this HealthcareService record is in active use Required Pattern: true (extensions allowed) | |||||
| providedBy |
0..1 | Reference(NDH Organization Profile) | Organization that provides this service | |||||
| Slices for category |
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. Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| category:HSC |
0..1 | CodeableConcept | NDH HealthcareService Category Binding: Healthcare Service Category Value Set (required) | |||||
| type |
0..* | CodeableConcept | Type of service that may be delivered or performed Binding: HealthcareService Type Value Set (extensible) | |||||
| specialty |
0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: HealthcareProviderTaxonomy (20240606) (extensible) | |||||
| location |
0..* | Reference(NDH Location Profile) | Location(s) where service may be provided | |||||
| name |
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: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 |
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.
| |||||
| 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 |
0..* | Reference(NDH Endpoint Profile) | Technical endpoints providing access to electronic services operated for the healthcare service | |||||
| Documentation for this format | ||||||||
| 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. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from HealthcareService
Summary
Mandatory: 2 elements(1 nested mandatory element)
Must-Support: 12 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 4
Other representations of profile: CSV, Excel, Schematron
| Name | Type | Description | Expression |
| active | token |
The Healthcare Service is currently marked as active |
HealthcareService.active
|
| characteristic | token |
One of the HealthcareService's characteristics |
HealthcareService.characteristic
|
| coverage-area | reference |
Location(s) service is intended for/available to |
HealthcareService.coverageArea
|
| delivery-method | token |
Select HealthcareServices based on the delivery method type |
HealthcareService.extension.where(url='http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/delivery-method').extension.where(url='type')
|
| eligibility | token |
Use this search parameter to find HealthcareService records with the specified eligibility. Applies to HealthcareService records. |
HealthcareService.eligibility.code
|
| endpoint | reference |
Select HealthcareServices with the specified endpoint |
HealthcareService.endpoint
|
| identifier | token |
External identifiers for this item |
HealthcareService.identifier
|
| location | reference |
Use this search parameter to find HealthcareService records with the specified location. Applies to HealthcareService records. |
HealthcareService.location
|
| name | string |
A portion of the Healthcare service name |
HealthcareService.name
|
| network | reference |
Use this search parameter to find records linked to specific networks to evaluate in-network participation and coverage pathways. Applies to HealthcareService records. |
HealthcareService.extension.where(url='http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference').value.ofType(Reference)
|
| new-patient | token |
Use this search parameter to find where new patients are being accepted to identify available access points for care. Applies to HealthcareService records. |
HealthcareService.extension.where(url='http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients').extension.where(url='acceptingPatients').value.ofType(CodeableConcept)
|
| new-patient-and-from-network | composite |
Use this search parameter to find HealthcareService records with specified new-patient acceptance and network criteria. Applies to HealthcareService records. |
HealthcareService.extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients')
|
| new-patient-from-network | reference |
Use this search parameter to find where new-patient acceptance is tied to a specific network so coverage-based access can be evaluated. Applies to HealthcareService records. |
HealthcareService.extension.where(url='http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients').extension.where(url='fromNetwork').value.ofType(Reference)
|
| organization | reference |
Use this search parameter to find HealthcareService records with the specified organization. Applies to HealthcareService records. |
HealthcareService.providedBy
|
| program | token |
One of the Programs supported by this HealthcareService |
HealthcareService.program
|
| program-requirement-age-group | token |
Use this search parameter to find services or programs by age-group eligibility to match offerings to age-based participation needs. Applies to HealthcareService records. |
HealthcareService.program.extension.where(url='http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement').extension.where(url='http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-ndh-age-group').value.ofType(CodeableConcept)
|
| program-requirement-birthsex | token |
Use this search parameter to find services or programs using birth-sex eligibility criteria to screen for population-specific participation rules. Applies to HealthcareService records. |
HealthcareService.program.extension.where(url='http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement').extension.where(url='birthsex').value.ofType(code)
|
| program-requirement-employment-status | token |
Use this search parameter to find services or programs by employment-status criteria to identify offerings aligned to employment-based eligibility. Applies to HealthcareService records. |
HealthcareService.program.extension.where(url='http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement').extension.where(url='employment-status').value.ofType(CodeableConcept)
|
| program-requirement-insurance-status | token |
Use this search parameter to find services or programs by insurance-status criteria to identify offerings aligned to coverage circumstances. Applies to HealthcareService records. |
HealthcareService.program.extension.where(url='http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement').extension.where(url='insurance-status').value.ofType(CodeableConcept)
|
| program-requirement-preferred-language | token |
Use this search parameter to find services or programs by preferred-language criteria to locate linguistically appropriate options. Applies to HealthcareService records. |
HealthcareService.program.extension.where(url='http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement').extension.where(url='preferred-language').value.ofType(CodeableConcept)
|
| program-requirement-va-status | token |
Use this search parameter to find services or programs by veteran-status criteria to identify offerings intended for veteran populations. Applies to HealthcareService records. |
HealthcareService.program.extension.where(url='http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement').extension.where(url='va-status').value.ofType(boolean)
|
| service-category | token |
Service Category of the Healthcare Service |
HealthcareService.category
|
| service-type | token |
The type of service provided by this healthcare service |
HealthcareService.type
|
| social-service-age-group | token |
Use this search parameter to find services or programs by age-group eligibility to match offerings to age-based participation needs. Applies to HealthcareService records. |
HealthcareService.extension.where(url='http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement').extension.where(url='http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-ndh-age-group').value.ofType(CodeableConcept)
|
| social-service-birthsex | token |
Use this search parameter to find services or programs using birth-sex eligibility criteria to screen for population-specific participation rules. Applies to HealthcareService records. |
HealthcareService.extension.where(url='http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement').extension.where(url='birthsex').value.ofType(code)
|
| social-service-employment-status | token |
Use this search parameter to find services or programs by employment-status criteria to identify offerings aligned to employment-based eligibility. Applies to HealthcareService records. |
HealthcareService.extension.where(url='http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement').extension.where(url='employment-status').value.ofType(CodeableConcept)
|
| social-service-insurance-status | token |
Use this search parameter to find services or programs by insurance-status criteria to identify offerings aligned to coverage circumstances. Applies to HealthcareService records. |
HealthcareService.extension.where(url='http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement').extension.where(url='insurance-status').value.ofType(CodeableConcept)
|
| social-service-preferred-language | token |
Use this search parameter to find services or programs by preferred-language criteria to locate linguistically appropriate options. Applies to HealthcareService records. |
HealthcareService.extension.where(url='http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement').extension.where(url='preferred-language').value.ofType(CodeableConcept)
|
| social-service-va-status | token |
Use this search parameter to find services or programs by veteran-status criteria to identify offerings intended for veteran populations. Applies to HealthcareService records. |
HealthcareService.extension.where(url='http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement').extension.where(url='va-status').value.ofType(boolean)
|
| specialty | token |
The specialty of the service provided by this healthcare service |
HealthcareService.specialty
|
| verification-status | token |
Use this search parameter to find records by verification standing to prioritize trusted and current directory data. Applies to Endpoint, HealthcareService, Organization, Location, Practitioner, PractitionerRole, InsurancePlan, OrganizationAffiliation, and Group records. |
extension('http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status').value
|
| _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 |
|---|
| OrganizationAffiliation:service |
| PractitionerRole:service |
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.
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
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.
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.
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.
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.
IG © 2023+ HL7 International / Patient Administration.
Package hl7.fhir.us.ndh#2.0.0-current based on FHIR 4.0.1.
Generated
2026-10-19
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change