National Healthcare Directory Query
1.0.0-ballot - ballot

National Healthcare Directory Query, published by HL7 International - Patient Administration Work Group. This is not an authorized publication; it is the continuous build for version 1.0.0-ballot). This version is based on the current content of https://github.com/HL7/fhir-directory-query/ and changes regularly. See the Directory of published versions

## Resource Profile: National Directory Endpoint Qry Exchange HealthcareService

Official URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/NatlDirEndpointQry-HealthcareService | Version: 1.0.0-ballot
Active as of 2022-12-08 | Computable Name: NatlDirEndpointQryHealthcareService

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.

Usage:

- Refer to this Resource Profile:
- Examples for this Resource Profile: HealthcareService/BurrClinicServices, HealthcareService/CancerClinicService, HealthcareService/HamiltonClinicServices, HealthcareService/HansSoloService, HealthcareService/HartfordOrthopedicServices, HealthcareService/HospERService, Compounding Pharmacy by OrgA, Mail Order Pharmacy by OrgA, Pharmacy by PharmChain, HealthcareService/VirtualCounselService

### Formal Views of Profile Content

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

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

This structure is derived from HealthcareService

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
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 |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
rating |  | 0..* | (Complex) | Rating URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/rating
newpatients |  | 0..* | (Complex) | New Patients URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/newpatients
deliverymethod |  | 1..* | (Complex) | Delivery Method URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/delivery-method
paymentaccepted |  | 0..* | CodeableConcept | Payment Accepted URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/paymentAccepted Binding: hl7VS-paymentMethodCode (required)
requiredDocument |  | 0..* | (Complex) | Required Document URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/requiredDocument
fundingSource |  | 0..* | (Complex) | Funding Source URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/fundingSource
active |  | 1..1 | boolean | Whether this HealthcareService record is in active use Required Pattern: true
providedBy | S | 0..1 | Reference(National Directory Endpoint Qry Exchange Organization) | Organization that provides this service
category | S | 1..1 | CodeableConcept | Broad category of service being performed or delivered Binding: Healthcare Service Category Value Set (extensible)
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: Specialties Value Set (required)
location | S | 0..* | Reference(National Directory Endpoint Qry Exchange Location) | Location(s) where service may be provided
name | S | 0..1 | string | Description of service as presented to a consumer while searching
telecom |  |  |  |
contactpoint-availabletime |  | 0..* | (Complex) | Contactpoint Availabletime URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/contactpoint-availabletime
via-intermediary |  | 0..* | Reference(National Directory Endpoint Qry Exchange PractitionerRole | National Directory Endpoint Qry Exchange OrganizationAffiliation | National Directory Endpoint Qry Exchange Location | National Directory Endpoint Qry Exchange Organization) | Via Intermediary URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/via-intermediary
coverageArea | S | 0..* | Reference(National Directory Endpoint Qry Exchange Location) | Location(s) service is intended for/available to
endpoint | S | 0..* | Reference(National Directory Endpoint Qry Exchange Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet
HealthcareService.category | extensible | HealthcareServiceCategoryVS (a valid code from Healthcare Service Category Code System)
HealthcareService.type | extensible | HealthcareServiceTypeVS
HealthcareService.specialty | required | SpecialtiesVS

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
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 |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
rating |  | 0..* | (Complex) | Rating URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/rating
newpatients | C | 0..* | (Complex) | New Patients URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/newpatients
deliverymethod |  | 1..* | (Complex) | Delivery Method URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/delivery-method
paymentaccepted |  | 0..* | CodeableConcept | Payment Accepted URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/paymentAccepted Binding: hl7VS-paymentMethodCode (required)
requiredDocument |  | 0..* | (Complex) | Required Document URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/requiredDocument
fundingSource |  | 0..* | (Complex) | Funding Source URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/fundingSource
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
active | ?!Σ | 1..1 | boolean | Whether this HealthcareService record is in active use Required Pattern: true
providedBy | S Σ | 0..1 | Reference(National Directory Endpoint Qry Exchange Organization) | Organization that provides this service
category | S Σ | 1..1 | CodeableConcept | Broad category of service being performed or delivered Binding: Healthcare Service Category Value Set (extensible)
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: Specialties Value Set (required)
location | S Σ | 0..* | Reference(National Directory Endpoint Qry Exchange Location) | Location(s) where service may be provided
name | S Σ | 0..1 | string | Description of service as presented to a consumer while searching
coverageArea | S | 0..* | Reference(National Directory Endpoint Qry Exchange Location) | Location(s) service is intended for/available to
endpoint | S | 0..* | Reference(National Directory Endpoint Qry Exchange Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
HealthcareService.category | extensible | HealthcareServiceCategoryVS (a valid code from Healthcare Service Category Code System)
HealthcareService.type | extensible | HealthcareServiceTypeVS
HealthcareService.specialty | required | SpecialtiesVS

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
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
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
rating |  | 0..* | (Complex) | Rating URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/rating
newpatients | C | 0..* | (Complex) | New Patients URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/newpatients
deliverymethod |  | 1..* | (Complex) | Delivery Method URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/delivery-method
paymentaccepted |  | 0..* | CodeableConcept | Payment Accepted URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/paymentAccepted Binding: hl7VS-paymentMethodCode (required)
requiredDocument |  | 0..* | (Complex) | Required Document URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/requiredDocument
fundingSource |  | 0..* | (Complex) | Funding Source URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/fundingSource
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | External identifiers for this item
active | ?!Σ | 1..1 | boolean | Whether this HealthcareService record is in active use Required Pattern: true
providedBy | S Σ | 0..1 | Reference(National Directory Endpoint Qry Exchange Organization) | Organization that provides this service
category | S Σ | 1..1 | CodeableConcept | Broad category of service being performed or delivered Binding: Healthcare Service Category Value Set (extensible)
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: Specialties Value Set (required)
location | S Σ | 0..* | Reference(National Directory Endpoint Qry Exchange Location) | 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
contactpoint-availabletime |  | 0..* | (Complex) | Contactpoint Availabletime URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/contactpoint-availabletime
via-intermediary |  | 0..* | Reference(National Directory Endpoint Qry Exchange PractitionerRole | National Directory Endpoint Qry Exchange OrganizationAffiliation | National Directory Endpoint Qry Exchange Location | National Directory Endpoint Qry Exchange Organization) | Via Intermediary URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/via-intermediary
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(National Directory Endpoint Qry Exchange Location) | Location(s) service is intended for/available to
serviceProvisionCode |  | 0..* | CodeableConcept | Conditions under which service is available/offered Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered.
eligibility |  | 0..* | BackboneElement | Specific eligibility requirements required to use the service
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code |  | 0..1 | CodeableConcept | Coded value for the eligibility Binding: (unbound) (example): Coded values underwhich a specific service is made available.
comment |  | 0..1 | markdown | Describes the eligibility conditions for the service
program |  | 0..* | CodeableConcept | Programs that this service is applicable to Binding: Program (example): Government or local programs that this service applies to.
characteristic |  | 0..* | CodeableConcept | Collection of characteristics (attributes) Binding: (unbound) (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(National Directory Endpoint Qry Exchange Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
HealthcareService.meta.security | extensible | All Security Labels
HealthcareService.meta.tag | example | CommonTags
HealthcareService.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
HealthcareService.category | extensible | HealthcareServiceCategoryVS (a valid code from Healthcare Service Category Code System)
HealthcareService.type | extensible | HealthcareServiceTypeVS
HealthcareService.specialty | required | SpecialtiesVS
HealthcareService.telecom.system | required | ContactPointSystem
HealthcareService.telecom.use | required | ContactPointUse
HealthcareService.serviceProvisionCode | example | ServiceProvisionConditions
HealthcareService.eligibility.code | example |
HealthcareService.program | example | Program
HealthcareService.characteristic | example |
HealthcareService.communication | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
HealthcareService.referralMethod | example | ReferralMethod
HealthcareService.availableTime.daysOfWeek | required | DaysOfWeek

This structure is derived from HealthcareService

Summary

Mandatory: 4 elements (1 nested mandatory element)
Must-Support: 8 elements

Structures

This structure refers to these other structures:

- National Directory Endpoint Qry Exchange Organization (http://hl7.org/fhir/us/directory-query/StructureDefinition/NatlDirEndpointQry-Organization)
- National Directory Endpoint Qry Exchange Location (http://hl7.org/fhir/us/directory-query/StructureDefinition/NatlDirEndpointQry-Location)
- National Directory Endpoint Qry Exchange Endpoint (http://hl7.org/fhir/us/directory-query/StructureDefinition/NatlDirEndpointQry-Endpoint)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/us/directory-query/StructureDefinition/rating
- http://hl7.org/fhir/us/directory-query/StructureDefinition/newpatients
- http://hl7.org/fhir/us/directory-query/StructureDefinition/delivery-method
- http://hl7.org/fhir/us/directory-query/StructureDefinition/paymentAccepted
- http://hl7.org/fhir/us/directory-query/StructureDefinition/requiredDocument
- http://hl7.org/fhir/us/directory-query/StructureDefinition/fundingSource
- http://hl7.org/fhir/us/directory-query/StructureDefinition/contactpoint-availabletime
- http://hl7.org/fhir/us/directory-query/StructureDefinition/via-intermediary

Differential View

This structure is derived from HealthcareService

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
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 |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
rating |  | 0..* | (Complex) | Rating URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/rating
newpatients |  | 0..* | (Complex) | New Patients URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/newpatients
deliverymethod |  | 1..* | (Complex) | Delivery Method URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/delivery-method
paymentaccepted |  | 0..* | CodeableConcept | Payment Accepted URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/paymentAccepted Binding: hl7VS-paymentMethodCode (required)
requiredDocument |  | 0..* | (Complex) | Required Document URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/requiredDocument
fundingSource |  | 0..* | (Complex) | Funding Source URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/fundingSource
active |  | 1..1 | boolean | Whether this HealthcareService record is in active use Required Pattern: true
providedBy | S | 0..1 | Reference(National Directory Endpoint Qry Exchange Organization) | Organization that provides this service
category | S | 1..1 | CodeableConcept | Broad category of service being performed or delivered Binding: Healthcare Service Category Value Set (extensible)
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: Specialties Value Set (required)
location | S | 0..* | Reference(National Directory Endpoint Qry Exchange Location) | Location(s) where service may be provided
name | S | 0..1 | string | Description of service as presented to a consumer while searching
telecom |  |  |  |
contactpoint-availabletime |  | 0..* | (Complex) | Contactpoint Availabletime URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/contactpoint-availabletime
via-intermediary |  | 0..* | Reference(National Directory Endpoint Qry Exchange PractitionerRole | National Directory Endpoint Qry Exchange OrganizationAffiliation | National Directory Endpoint Qry Exchange Location | National Directory Endpoint Qry Exchange Organization) | Via Intermediary URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/via-intermediary
coverageArea | S | 0..* | Reference(National Directory Endpoint Qry Exchange Location) | Location(s) service is intended for/available to
endpoint | S | 0..* | Reference(National Directory Endpoint Qry Exchange Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet
HealthcareService.category | extensible | HealthcareServiceCategoryVS (a valid code from Healthcare Service Category Code System)
HealthcareService.type | extensible | HealthcareServiceTypeVS
HealthcareService.specialty | required | SpecialtiesVS

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
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 |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
rating |  | 0..* | (Complex) | Rating URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/rating
newpatients | C | 0..* | (Complex) | New Patients URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/newpatients
deliverymethod |  | 1..* | (Complex) | Delivery Method URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/delivery-method
paymentaccepted |  | 0..* | CodeableConcept | Payment Accepted URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/paymentAccepted Binding: hl7VS-paymentMethodCode (required)
requiredDocument |  | 0..* | (Complex) | Required Document URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/requiredDocument
fundingSource |  | 0..* | (Complex) | Funding Source URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/fundingSource
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
active | ?!Σ | 1..1 | boolean | Whether this HealthcareService record is in active use Required Pattern: true
providedBy | S Σ | 0..1 | Reference(National Directory Endpoint Qry Exchange Organization) | Organization that provides this service
category | S Σ | 1..1 | CodeableConcept | Broad category of service being performed or delivered Binding: Healthcare Service Category Value Set (extensible)
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: Specialties Value Set (required)
location | S Σ | 0..* | Reference(National Directory Endpoint Qry Exchange Location) | Location(s) where service may be provided
name | S Σ | 0..1 | string | Description of service as presented to a consumer while searching
coverageArea | S | 0..* | Reference(National Directory Endpoint Qry Exchange Location) | Location(s) service is intended for/available to
endpoint | S | 0..* | Reference(National Directory Endpoint Qry Exchange Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
HealthcareService.category | extensible | HealthcareServiceCategoryVS (a valid code from Healthcare Service Category Code System)
HealthcareService.type | extensible | HealthcareServiceTypeVS
HealthcareService.specialty | required | SpecialtiesVS

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
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
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
rating |  | 0..* | (Complex) | Rating URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/rating
newpatients | C | 0..* | (Complex) | New Patients URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/newpatients
deliverymethod |  | 1..* | (Complex) | Delivery Method URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/delivery-method
paymentaccepted |  | 0..* | CodeableConcept | Payment Accepted URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/paymentAccepted Binding: hl7VS-paymentMethodCode (required)
requiredDocument |  | 0..* | (Complex) | Required Document URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/requiredDocument
fundingSource |  | 0..* | (Complex) | Funding Source URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/fundingSource
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | External identifiers for this item
active | ?!Σ | 1..1 | boolean | Whether this HealthcareService record is in active use Required Pattern: true
providedBy | S Σ | 0..1 | Reference(National Directory Endpoint Qry Exchange Organization) | Organization that provides this service
category | S Σ | 1..1 | CodeableConcept | Broad category of service being performed or delivered Binding: Healthcare Service Category Value Set (extensible)
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: Specialties Value Set (required)
location | S Σ | 0..* | Reference(National Directory Endpoint Qry Exchange Location) | 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
contactpoint-availabletime |  | 0..* | (Complex) | Contactpoint Availabletime URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/contactpoint-availabletime
via-intermediary |  | 0..* | Reference(National Directory Endpoint Qry Exchange PractitionerRole | National Directory Endpoint Qry Exchange OrganizationAffiliation | National Directory Endpoint Qry Exchange Location | National Directory Endpoint Qry Exchange Organization) | Via Intermediary URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/via-intermediary
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(National Directory Endpoint Qry Exchange Location) | Location(s) service is intended for/available to
serviceProvisionCode |  | 0..* | CodeableConcept | Conditions under which service is available/offered Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered.
eligibility |  | 0..* | BackboneElement | Specific eligibility requirements required to use the service
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code |  | 0..1 | CodeableConcept | Coded value for the eligibility Binding: (unbound) (example): Coded values underwhich a specific service is made available.
comment |  | 0..1 | markdown | Describes the eligibility conditions for the service
program |  | 0..* | CodeableConcept | Programs that this service is applicable to Binding: Program (example): Government or local programs that this service applies to.
characteristic |  | 0..* | CodeableConcept | Collection of characteristics (attributes) Binding: (unbound) (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(National Directory Endpoint Qry Exchange Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
HealthcareService.meta.security | extensible | All Security Labels
HealthcareService.meta.tag | example | CommonTags
HealthcareService.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
HealthcareService.category | extensible | HealthcareServiceCategoryVS (a valid code from Healthcare Service Category Code System)
HealthcareService.type | extensible | HealthcareServiceTypeVS
HealthcareService.specialty | required | SpecialtiesVS
HealthcareService.telecom.system | required | ContactPointSystem
HealthcareService.telecom.use | required | ContactPointUse
HealthcareService.serviceProvisionCode | example | ServiceProvisionConditions
HealthcareService.eligibility.code | example |
HealthcareService.program | example | Program
HealthcareService.characteristic | example |
HealthcareService.communication | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
HealthcareService.referralMethod | example | ReferralMethod
HealthcareService.availableTime.daysOfWeek | required | DaysOfWeek

This structure is derived from HealthcareService

Summary

Mandatory: 4 elements (1 nested mandatory element)
Must-Support: 8 elements

Structures

This structure refers to these other structures:

- National Directory Endpoint Qry Exchange Organization (http://hl7.org/fhir/us/directory-query/StructureDefinition/NatlDirEndpointQry-Organization)
- National Directory Endpoint Qry Exchange Location (http://hl7.org/fhir/us/directory-query/StructureDefinition/NatlDirEndpointQry-Location)
- National Directory Endpoint Qry Exchange Endpoint (http://hl7.org/fhir/us/directory-query/StructureDefinition/NatlDirEndpointQry-Endpoint)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/us/directory-query/StructureDefinition/rating
- http://hl7.org/fhir/us/directory-query/StructureDefinition/newpatients
- http://hl7.org/fhir/us/directory-query/StructureDefinition/delivery-method
- http://hl7.org/fhir/us/directory-query/StructureDefinition/paymentAccepted
- http://hl7.org/fhir/us/directory-query/StructureDefinition/requiredDocument
- http://hl7.org/fhir/us/directory-query/StructureDefinition/fundingSource
- http://hl7.org/fhir/us/directory-query/StructureDefinition/contactpoint-availabletime
- http://hl7.org/fhir/us/directory-query/StructureDefinition/via-intermediary

Other representations of profile: CSV, Excel, Schematron