Scope and Usage

The HealthcareService resource is commonly used to describe the range of services offered by an organization or practitioner at a specific location. This resource can cover a diverse range of services across the entire healthcare spectrum, including but not limited to promotion, prevention, diagnostics, hospital and ambulatory care, home care, long-term care, and other health-related and community services.

The primary intention for the network extension of the HealthcareService is to cater to services related to social services.

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. Restrictions should be utilized only when there are particular limitations, such as services solely for females or veterans.

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.

• 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		0..*	Extension	Extension Slice: Unordered, Open by value:url
rating		0..*	(Complex)	NDH Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
newpatients		0..*	(Complex)	New Patients URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients
deliverymethod		0..*	(Complex)	Delivery Method URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-delivery-method
paymentaccepted		0..*	CodeableConcept	NDH Payment Accepted URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted Binding: hl7VS-paymentMethodCode (required)
requiredDocument		0..*	(Complex)	NDH Required Document URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-requiredDocument
fundingSource		0..*	(Complex)	NDH Funding Source URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource
usage-restriction		0..*	Reference(NDH Base Restriction) {c}	Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
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)
network		0..*	Reference(NDH Base Network Profile)	Network Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference
social-service-requirement		0..*	(Complex)	Social Service Requirement URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement
logo		0..1	Attachment	NDH Logo URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo
identifier
identifier-status		0..1	code	NDH 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 Base Organization Profile)	Organization that issued id (may be just text)
active	S	1..1	boolean	Whether this HealthcareService record is in active use Required Pattern: true
providedBy	S	0..1	Reference(NDH Base Organization Profile)	Organization that provides this service
Slices for category	S	1..*	CodeableConcept	Broad category of service being performed or delivered Slice: Unordered, Open by pattern:$this
category:HSC	S	0..1	CodeableConcept	NDH HealthcareService Category Binding: Healthcare Service Category Value Set (required)
type	S	0..*	CodeableConcept	Type of service that may be delivered or performed Binding: HealthcareService Type Value Set (extensible)
specialty	S	0..*	CodeableConcept	Specialties handled by the HealthcareService Binding: Specialties Value Set (extensible)
location	S	0..*	Reference(NDH Base Location Profile)	Location(s) where service may be provided
name	S	0..1	string	Description of service as presented to a consumer while searching
telecom
contactpoint-availabletime		0..*	(Complex)	NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
via-intermediary		0..1	Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)	Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
language-speak		0..*	code	Language Speak URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak Binding: CommonLanguages (extensible)
coverageArea	S	0..*	Reference(NDH Base Location Profile)	Location(s) service is intended for/available to
serviceProvisionCode		0..*	CodeableConcept	Conditions under which service is available/offered Binding: ServiceProvisionConditions (extensible)
eligibility
code		0..1	CodeableConcept	Coded value for the eligibility Binding: Healthcare Service Eligibility Code Value Set (extensible)
program		0..*	CodeableConcept	Programs that this service is applicable to Binding: Healthcare Service Program Value Set (extensible)
program-requirement		0..*	(Complex)	Program Requirement URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement
referralMethod		0..*	CodeableConcept	Ways that the service accepts referrals Binding: Healthcare Service Referral Method Value Set (extensible)
endpoint	S	0..*	Reference(NDH Base Endpoint Profile)	Technical endpoints providing access to electronic services operated for the healthcare service
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
HealthcareService.category:HSC	required	HealthcareServiceCategoryVS (a valid code from Healthcare Service Category Code System)
HealthcareService.type	extensible	HealthcareServiceTypeVS (a valid code from HealthcareServiceTypeCS)
HealthcareService.specialty	extensible	SpecialtiesVS
HealthcareService.serviceProvisionCode	extensible	ServiceProvisionConditions
HealthcareService.eligibility.code	extensible	HealthcareServiceEligibilityCodeVS
HealthcareService.program	extensible	HealthcareServiceProgramVS (a valid code from Healthcare Program)
HealthcareService.referralMethod	extensible	HealthcareServiceReferralMethodVS (a valid code from Healthcare Service Referral Method Code System)

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		0..*	Extension	Extension Slice: Unordered, Open by value:url
rating		0..*	(Complex)	NDH Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
newpatients	C	0..*	(Complex)	New Patients URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients
deliverymethod		0..*	(Complex)	Delivery Method URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-delivery-method
paymentaccepted		0..*	CodeableConcept	NDH Payment Accepted URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted Binding: hl7VS-paymentMethodCode (required)
requiredDocument		0..*	(Complex)	NDH Required Document URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-requiredDocument
fundingSource		0..*	(Complex)	NDH Funding Source URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource
usage-restriction		0..*	Reference(NDH Base Restriction) {c}	Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
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)
network		0..*	Reference(NDH Base Network Profile)	Network Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference
social-service-requirement	C	0..*	(Complex)	Social Service Requirement URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement
logo		0..1	Attachment	NDH Logo URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
active	?!SΣ	1..1	boolean	Whether this HealthcareService record is in active use Required Pattern: true
providedBy	SΣ	0..1	Reference(NDH Base Organization Profile)	Organization that provides this service
Slices for category	SΣ	1..*	CodeableConcept	Broad category of service being performed or delivered Slice: Unordered, Open by pattern:$this Binding: ServiceCategory (example): A category of the service(s) that could be provided.
category:HSC	SΣ	0..1	CodeableConcept	NDH HealthcareService Category Binding: Healthcare Service Category Value Set (required)
type	SΣ	0..*	CodeableConcept	Type of service that may be delivered or performed Binding: HealthcareService Type Value Set (extensible)
specialty	SΣ	0..*	CodeableConcept	Specialties handled by the HealthcareService Binding: Specialties Value Set (extensible)
location	SΣ	0..*	Reference(NDH Base Location Profile)	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(NDH Base Location Profile)	Location(s) service is intended for/available to
serviceProvisionCode		0..*	CodeableConcept	Conditions under which service is available/offered Binding: ServiceProvisionConditions (extensible)
program		0..*	CodeableConcept	Programs that this service is applicable to Binding: Healthcare Service Program Value Set (extensible)
program-requirement		0..*	(Complex)	Program Requirement URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement
referralMethod		0..*	CodeableConcept	Ways that the service accepts referrals Binding: Healthcare Service Referral Method Value Set (extensible)
endpoint	S	0..*	Reference(NDH Base Endpoint Profile)	Technical endpoints providing access to electronic services operated for the healthcare service
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
HealthcareService.category	example	ServiceCategory
HealthcareService.category:HSC	required	HealthcareServiceCategoryVS (a valid code from Healthcare Service Category Code System)
HealthcareService.type	extensible	HealthcareServiceTypeVS (a valid code from HealthcareServiceTypeCS)
HealthcareService.specialty	extensible	SpecialtiesVS
HealthcareService.serviceProvisionCode	extensible	ServiceProvisionConditions
HealthcareService.program	extensible	HealthcareServiceProgramVS (a valid code from Healthcare Program)
HealthcareService.referralMethod	extensible	HealthcareServiceReferralMethodVS (a valid code from Healthcare Service Referral Method Code System)

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		0..*	Extension	Extension Slice: Unordered, Open by value:url
rating		0..*	(Complex)	NDH Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
newpatients	C	0..*	(Complex)	New Patients URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients
deliverymethod		0..*	(Complex)	Delivery Method URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-delivery-method
paymentaccepted		0..*	CodeableConcept	NDH Payment Accepted URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted Binding: hl7VS-paymentMethodCode (required)
requiredDocument		0..*	(Complex)	NDH Required Document URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-requiredDocument
fundingSource		0..*	(Complex)	NDH Funding Source URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource
usage-restriction		0..*	Reference(NDH Base Restriction) {c}	Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
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)
network		0..*	Reference(NDH Base Network Profile)	Network Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference
social-service-requirement	C	0..*	(Complex)	Social Service Requirement URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement
logo		0..1	Attachment	NDH 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
identifier-status		0..1	code	NDH 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 Base Organization Profile)	Organization that issued id (may be just text)
active	?!SΣ	1..1	boolean	Whether this HealthcareService record is in active use Required Pattern: true
providedBy	SΣ	0..1	Reference(NDH Base Organization Profile)	Organization that provides this service
Slices for category	SΣ	1..*	CodeableConcept	Broad category of service being performed or delivered Slice: Unordered, Open by pattern:$this Binding: ServiceCategory (example): A category of the service(s) that could be provided.
category:HSC	SΣ	0..1	CodeableConcept	NDH HealthcareService Category Binding: Healthcare Service Category Value Set (required)
type	SΣ	0..*	CodeableConcept	Type of service that may be delivered or performed Binding: HealthcareService Type Value Set (extensible)
specialty	SΣ	0..*	CodeableConcept	Specialties handled by the HealthcareService Binding: Specialties Value Set (extensible)
location	SΣ	0..*	Reference(NDH Base Location Profile)	Location(s) where service may be provided
name	SΣ	0..1	string	Description of service as presented to a consumer while searching
comment	Σ	0..1	string	Additional description and/or any specific issues not covered elsewhere
extraDetails		0..1	markdown	Extra details about the service that can't be placed in the other fields
photo	Σ	0..1	Attachment	Facilitates quick identification of the service
telecom		0..*	ContactPoint	Contacts related to the healthcare service
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
contactpoint-availabletime		0..*	(Complex)	NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
via-intermediary		0..1	Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)	Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
language-speak		0..*	code	Language Speak URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak Binding: CommonLanguages (extensible)
system	ΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	Σ	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
coverageArea	S	0..*	Reference(NDH Base 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: Healthcare Service Program Value Set (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
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: (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: Healthcare Service Referral Method Value Set (extensible)
appointmentRequired		0..1	boolean	If an appointment is required for access to this service
availableTime		0..*	BackboneElement	Times the Service Site is available
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
daysOfWeek		0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay		0..1	boolean	Always available? e.g. 24 hour service
availableStartTime		0..1	time	Opening time of day (ignored if allDay = true)
availableEndTime		0..1	time	Closing time of day (ignored if allDay = true)
notAvailable		0..*	BackboneElement	Not available during this time due to provided reason
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
description		1..1	string	Reason presented to the user explaining why time not available
during		0..1	Period	Service not available from this date
availabilityExceptions		0..1	string	Description of availability exceptions
endpoint	S	0..*	Reference(NDH Base Endpoint Profile)	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.identifier.use	required	IdentifierUse
HealthcareService.identifier.type	extensible	Identifier Type Codes
HealthcareService.category	example	ServiceCategory
HealthcareService.category:HSC	required	HealthcareServiceCategoryVS (a valid code from Healthcare Service Category Code System)
HealthcareService.type	extensible	HealthcareServiceTypeVS (a valid code from HealthcareServiceTypeCS)
HealthcareService.specialty	extensible	SpecialtiesVS
HealthcareService.telecom.system	required	ContactPointSystem
HealthcareService.telecom.use	required	ContactPointUse
HealthcareService.serviceProvisionCode	extensible	ServiceProvisionConditions
HealthcareService.eligibility.code	extensible	HealthcareServiceEligibilityCodeVS
HealthcareService.program	extensible	HealthcareServiceProgramVS (a valid code from Healthcare Program)
HealthcareService.characteristic	example
HealthcareService.communication	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
HealthcareService.referralMethod	extensible	HealthcareServiceReferralMethodVS (a valid code from Healthcare Service Referral Method Code System)
HealthcareService.availableTime.daysOfWeek	required	DaysOfWeek

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		0..*	Extension	Extension Slice: Unordered, Open by value:url
rating		0..*	(Complex)	NDH Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
newpatients		0..*	(Complex)	New Patients URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients
deliverymethod		0..*	(Complex)	Delivery Method URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-delivery-method
paymentaccepted		0..*	CodeableConcept	NDH Payment Accepted URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted Binding: hl7VS-paymentMethodCode (required)
requiredDocument		0..*	(Complex)	NDH Required Document URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-requiredDocument
fundingSource		0..*	(Complex)	NDH Funding Source URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource
usage-restriction		0..*	Reference(NDH Base Restriction) {c}	Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
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)
network		0..*	Reference(NDH Base Network Profile)	Network Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference
social-service-requirement		0..*	(Complex)	Social Service Requirement URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement
logo		0..1	Attachment	NDH Logo URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo
identifier
identifier-status		0..1	code	NDH 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 Base Organization Profile)	Organization that issued id (may be just text)
active	S	1..1	boolean	Whether this HealthcareService record is in active use Required Pattern: true
providedBy	S	0..1	Reference(NDH Base Organization Profile)	Organization that provides this service
Slices for category	S	1..*	CodeableConcept	Broad category of service being performed or delivered Slice: Unordered, Open by pattern:$this
category:HSC	S	0..1	CodeableConcept	NDH HealthcareService Category Binding: Healthcare Service Category Value Set (required)
type	S	0..*	CodeableConcept	Type of service that may be delivered or performed Binding: HealthcareService Type Value Set (extensible)
specialty	S	0..*	CodeableConcept	Specialties handled by the HealthcareService Binding: Specialties Value Set (extensible)
location	S	0..*	Reference(NDH Base Location Profile)	Location(s) where service may be provided
name	S	0..1	string	Description of service as presented to a consumer while searching
telecom
contactpoint-availabletime		0..*	(Complex)	NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
via-intermediary		0..1	Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)	Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
language-speak		0..*	code	Language Speak URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak Binding: CommonLanguages (extensible)
coverageArea	S	0..*	Reference(NDH Base Location Profile)	Location(s) service is intended for/available to
serviceProvisionCode		0..*	CodeableConcept	Conditions under which service is available/offered Binding: ServiceProvisionConditions (extensible)
eligibility
code		0..1	CodeableConcept	Coded value for the eligibility Binding: Healthcare Service Eligibility Code Value Set (extensible)
program		0..*	CodeableConcept	Programs that this service is applicable to Binding: Healthcare Service Program Value Set (extensible)
program-requirement		0..*	(Complex)	Program Requirement URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement
referralMethod		0..*	CodeableConcept	Ways that the service accepts referrals Binding: Healthcare Service Referral Method Value Set (extensible)
endpoint	S	0..*	Reference(NDH Base Endpoint Profile)	Technical endpoints providing access to electronic services operated for the healthcare service
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
HealthcareService.category:HSC	required	HealthcareServiceCategoryVS (a valid code from Healthcare Service Category Code System)
HealthcareService.type	extensible	HealthcareServiceTypeVS (a valid code from HealthcareServiceTypeCS)
HealthcareService.specialty	extensible	SpecialtiesVS
HealthcareService.serviceProvisionCode	extensible	ServiceProvisionConditions
HealthcareService.eligibility.code	extensible	HealthcareServiceEligibilityCodeVS
HealthcareService.program	extensible	HealthcareServiceProgramVS (a valid code from Healthcare Program)
HealthcareService.referralMethod	extensible	HealthcareServiceReferralMethodVS (a valid code from Healthcare Service Referral Method Code System)

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		0..*	Extension	Extension Slice: Unordered, Open by value:url
rating		0..*	(Complex)	NDH Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
newpatients	C	0..*	(Complex)	New Patients URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients
deliverymethod		0..*	(Complex)	Delivery Method URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-delivery-method
paymentaccepted		0..*	CodeableConcept	NDH Payment Accepted URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted Binding: hl7VS-paymentMethodCode (required)
requiredDocument		0..*	(Complex)	NDH Required Document URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-requiredDocument
fundingSource		0..*	(Complex)	NDH Funding Source URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource
usage-restriction		0..*	Reference(NDH Base Restriction) {c}	Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
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)
network		0..*	Reference(NDH Base Network Profile)	Network Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference
social-service-requirement	C	0..*	(Complex)	Social Service Requirement URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement
logo		0..1	Attachment	NDH Logo URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
active	?!SΣ	1..1	boolean	Whether this HealthcareService record is in active use Required Pattern: true
providedBy	SΣ	0..1	Reference(NDH Base Organization Profile)	Organization that provides this service
Slices for category	SΣ	1..*	CodeableConcept	Broad category of service being performed or delivered Slice: Unordered, Open by pattern:$this Binding: ServiceCategory (example): A category of the service(s) that could be provided.
category:HSC	SΣ	0..1	CodeableConcept	NDH HealthcareService Category Binding: Healthcare Service Category Value Set (required)
type	SΣ	0..*	CodeableConcept	Type of service that may be delivered or performed Binding: HealthcareService Type Value Set (extensible)
specialty	SΣ	0..*	CodeableConcept	Specialties handled by the HealthcareService Binding: Specialties Value Set (extensible)
location	SΣ	0..*	Reference(NDH Base Location Profile)	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(NDH Base Location Profile)	Location(s) service is intended for/available to
serviceProvisionCode		0..*	CodeableConcept	Conditions under which service is available/offered Binding: ServiceProvisionConditions (extensible)
program		0..*	CodeableConcept	Programs that this service is applicable to Binding: Healthcare Service Program Value Set (extensible)
program-requirement		0..*	(Complex)	Program Requirement URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement
referralMethod		0..*	CodeableConcept	Ways that the service accepts referrals Binding: Healthcare Service Referral Method Value Set (extensible)
endpoint	S	0..*	Reference(NDH Base Endpoint Profile)	Technical endpoints providing access to electronic services operated for the healthcare service
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
HealthcareService.category	example	ServiceCategory
HealthcareService.category:HSC	required	HealthcareServiceCategoryVS (a valid code from Healthcare Service Category Code System)
HealthcareService.type	extensible	HealthcareServiceTypeVS (a valid code from HealthcareServiceTypeCS)
HealthcareService.specialty	extensible	SpecialtiesVS
HealthcareService.serviceProvisionCode	extensible	ServiceProvisionConditions
HealthcareService.program	extensible	HealthcareServiceProgramVS (a valid code from Healthcare Program)
HealthcareService.referralMethod	extensible	HealthcareServiceReferralMethodVS (a valid code from Healthcare Service Referral Method Code System)

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		0..*	Extension	Extension Slice: Unordered, Open by value:url
rating		0..*	(Complex)	NDH Rating URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
newpatients	C	0..*	(Complex)	New Patients URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients
deliverymethod		0..*	(Complex)	Delivery Method URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-delivery-method
paymentaccepted		0..*	CodeableConcept	NDH Payment Accepted URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted Binding: hl7VS-paymentMethodCode (required)
requiredDocument		0..*	(Complex)	NDH Required Document URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-requiredDocument
fundingSource		0..*	(Complex)	NDH Funding Source URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource
usage-restriction		0..*	Reference(NDH Base Restriction) {c}	Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
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)
network		0..*	Reference(NDH Base Network Profile)	Network Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference
social-service-requirement	C	0..*	(Complex)	Social Service Requirement URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement
logo		0..1	Attachment	NDH 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
identifier-status		0..1	code	NDH 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 Base Organization Profile)	Organization that issued id (may be just text)
active	?!SΣ	1..1	boolean	Whether this HealthcareService record is in active use Required Pattern: true
providedBy	SΣ	0..1	Reference(NDH Base Organization Profile)	Organization that provides this service
Slices for category	SΣ	1..*	CodeableConcept	Broad category of service being performed or delivered Slice: Unordered, Open by pattern:$this Binding: ServiceCategory (example): A category of the service(s) that could be provided.
category:HSC	SΣ	0..1	CodeableConcept	NDH HealthcareService Category Binding: Healthcare Service Category Value Set (required)
type	SΣ	0..*	CodeableConcept	Type of service that may be delivered or performed Binding: HealthcareService Type Value Set (extensible)
specialty	SΣ	0..*	CodeableConcept	Specialties handled by the HealthcareService Binding: Specialties Value Set (extensible)
location	SΣ	0..*	Reference(NDH Base Location Profile)	Location(s) where service may be provided
name	SΣ	0..1	string	Description of service as presented to a consumer while searching
comment	Σ	0..1	string	Additional description and/or any specific issues not covered elsewhere
extraDetails		0..1	markdown	Extra details about the service that can't be placed in the other fields
photo	Σ	0..1	Attachment	Facilitates quick identification of the service
telecom		0..*	ContactPoint	Contacts related to the healthcare service
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
contactpoint-availabletime		0..*	(Complex)	NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
via-intermediary		0..1	Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)	Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
language-speak		0..*	code	Language Speak URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak Binding: CommonLanguages (extensible)
system	ΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	Σ	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
coverageArea	S	0..*	Reference(NDH Base 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: Healthcare Service Program Value Set (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
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: (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: Healthcare Service Referral Method Value Set (extensible)
appointmentRequired		0..1	boolean	If an appointment is required for access to this service
availableTime		0..*	BackboneElement	Times the Service Site is available
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
daysOfWeek		0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay		0..1	boolean	Always available? e.g. 24 hour service
availableStartTime		0..1	time	Opening time of day (ignored if allDay = true)
availableEndTime		0..1	time	Closing time of day (ignored if allDay = true)
notAvailable		0..*	BackboneElement	Not available during this time due to provided reason
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
description		1..1	string	Reason presented to the user explaining why time not available
during		0..1	Period	Service not available from this date
availabilityExceptions		0..1	string	Description of availability exceptions
endpoint	S	0..*	Reference(NDH Base Endpoint Profile)	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.identifier.use	required	IdentifierUse
HealthcareService.identifier.type	extensible	Identifier Type Codes
HealthcareService.category	example	ServiceCategory
HealthcareService.category:HSC	required	HealthcareServiceCategoryVS (a valid code from Healthcare Service Category Code System)
HealthcareService.type	extensible	HealthcareServiceTypeVS (a valid code from HealthcareServiceTypeCS)
HealthcareService.specialty	extensible	SpecialtiesVS
HealthcareService.telecom.system	required	ContactPointSystem
HealthcareService.telecom.use	required	ContactPointUse
HealthcareService.serviceProvisionCode	extensible	ServiceProvisionConditions
HealthcareService.eligibility.code	extensible	HealthcareServiceEligibilityCodeVS
HealthcareService.program	extensible	HealthcareServiceProgramVS (a valid code from Healthcare Program)
HealthcareService.characteristic	example
HealthcareService.communication	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
HealthcareService.referralMethod	extensible	HealthcareServiceReferralMethodVS (a valid code from Healthcare Service Referral Method Code System)
HealthcareService.availableTime.daysOfWeek	required	DaysOfWeek

This structure is derived from HealthcareService

Summary

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

Structures

This structure refers to these other structures:

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

Extensions

This structure refers to these extensions:

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

Slices

This structure defines the following Slices:

• The element HealthcareService.category is sliced based on the value of pattern:$this

Search Parameters

Search Parameter defined by the NDH IG

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

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

• Search Parameter Registry
• Healthcareservice Search Parameter from Registry

_include Search Parameter

_revinclude Search parameter

Search use cases

Search for all organizations and locations provide a given HealthcareService

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

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

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

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

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