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 1.0.0 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

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: National Directory API HealthcareService Profile

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: National Directory API CareTeam Profile, National Directory API OrganizationAffiliation Profile and National Directory API PractitionerRole
• Examples for this Resource Profile: HealthcareService/BurrClinicServices, HOPE INC, Towson Food INC, Welcome Home... Show 2 more, Womens shelter and Womens shelter
• CapabilityStatements using this Resource Profile: National Directory API Base Expanded Server Capability Statement, National Directory API Base Server Capability Statement, National Directory API Capability Statement and NDH Attestation Server Capability Statement

Formal Views of Profile Content

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

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

Name	Flags	Card.	Type	Description & Constraints
HealthcareService		0..*	NdhHealthcareService	The details of a healthcare service available at a location dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
meta	SΣ	0..1	Meta	Metadata about the resource ele-1: All FHIR elements must have a @value or children
lastUpdated	Σ	1..1	instant	When the resource version last changed ele-1: All FHIR elements must have a @value or children
profile	Σ	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to ele-1: All FHIR elements must have a @value or children
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:rating		0..*	(Complex)	Evaluations or reviews for the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:newpatients	SC	0..*	(Complex)	NDH New Patients URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both new-patients-characteristics: If no new patients are accepted, no characteristics are allowed
extension:deliverymethod	S	0..*	(Complex)	NDH Delivery Method URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-delivery-method ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:paymentaccepted		0..*	CodeableConcept	Forms of payment accepted. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted Binding: hl7VS-paymentMethodCode (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:requiredDocument		0..*	(Complex)	Documents required for the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-requiredDocument ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:fundingSource		0..*	(Complex)	Funding source for the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:usage-restriction		0..*	Reference(NDH Base Restriction) {c}	Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:verification-status	S	1..1	CodeableConcept	NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:network		0..*	(Complex)	NDH Network Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference"
value[x]	S	1..1	Reference(National Directory API Network Profile)	Value of extension ele-1: All FHIR elements must have a @value or children
extension:social-service-requirement	C	0..*	(Complex)	Social Service Requirement URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both agerange-or-agegroup: a service or program only allow to have either age-range or age-group but not both
extension:logo		0..1	Attachment	Service Logo URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	SΣ	0..*	Identifier	External identifiers for this item ele-1: All FHIR elements must have a @value or children
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:identifier-status	S	1..1	code	NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
use	?!SΣ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
type	SΣ	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. ele-1: All FHIR elements must have a @value or children
system	SΣ	0..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient
value	SΣ	0..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
assigner	SΣ	0..1	Reference(National Directory API Organization Profile)	Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children
active	?!SΣ	1..1	boolean	Whether this HealthcareService record is in active use ele-1: All FHIR elements must have a @value or children Required Pattern: true
providedBy	SΣ	0..1	Reference(National Directory API Organization Profile)	Organization that provides this service ele-1: All FHIR elements must have a @value or children
Slices for category	SΣ	1..*	CodeableConcept	Broad category of service being performed or delivered Slice: Unordered, Open by value:$this Binding: ServiceCategory (example): A category of the service(s) that could be provided. ele-1: All FHIR elements must have a @value or children
category:HSC	SΣ	0..1	CodeableConcept	NDH HealthcareService Category Binding: Healthcare Service Category Value Set (required) ele-1: All FHIR elements must have a @value or children
type	SΣ	0..*	CodeableConcept	Type of service that may be delivered or performed Binding: HealthcareService Type Value Set (extensible) ele-1: All FHIR elements must have a @value or children
specialty	SΣ	0..*	CodeableConcept	Specialties handled by the HealthcareService Binding: Healthcare Provider Taxonomy (extensible) ele-1: All FHIR elements must have a @value or children
location	SΣ	0..*	Reference(National Directory API Location Profile)	Location(s) where service may be provided ele-1: All FHIR elements must have a @value or children
name	SΣ	0..1	string	Description of service as presented to a consumer while searching ele-1: All FHIR elements must have a @value or children
comment	SΣ	0..1	string	Additional description and/or any specific issues not covered elsewhere ele-1: All FHIR elements must have a @value or children
telecom	S	0..*	ContactPoint	Contacts related to the healthcare service ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
extension:contactpoint-availabletime	S	0..*	(Complex)	NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:via-intermediary	S	0..1	Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)	NDH Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:language-speak		0..*	code	Language Speak URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak Binding: CommonLanguages (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
system	SΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children
value	SΣ	0..1	string	The actual contact point details ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children
coverageArea	S	0..*	Reference(National Directory API Location Profile)	Location(s) service is intended for/available to ele-1: All FHIR elements must have a @value or children
serviceProvisionCode	S	0..*	CodeableConcept	Conditions under which service is available/offered Binding: ServiceProvisionConditions (extensible) ele-1: All FHIR elements must have a @value or children
eligibility	S	0..*	BackboneElement	Specific eligibility requirements required to use the service ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
code	S	0..1	CodeableConcept	Coded value for the eligibility Binding: Healthcare Service Eligibility Code Value Set (extensible) ele-1: All FHIR elements must have a @value or children
comment	S	0..1	markdown	Describes the eligibility conditions for the service ele-1: All FHIR elements must have a @value or children
program	S	0..*	CodeableConcept	Programs that this service is applicable to Binding: Program (extensible) ele-1: All FHIR elements must have a @value or children
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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
characteristic	S	0..*	CodeableConcept	Collection of characteristics (attributes) Binding Description (No ValueSet): (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). ele-1: All FHIR elements must have a @value or children
referralMethod	S	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. ele-1: All FHIR elements must have a @value or children
appointmentRequired	S	0..1	boolean	If an appointment is required for access to this service ele-1: All FHIR elements must have a @value or children
availableTime	S	0..*	BackboneElement	Times the Service Site is available ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
daysOfWeek	S	0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. ele-1: All FHIR elements must have a @value or children
allDay	S	0..1	boolean	Always available? e.g. 24 hour service ele-1: All FHIR elements must have a @value or children
availableStartTime	S	0..1	time	Opening time of day (ignored if allDay = true) ele-1: All FHIR elements must have a @value or children
availableEndTime	S	0..1	time	Closing time of day (ignored if allDay = true) ele-1: All FHIR elements must have a @value or children
notAvailable	S	0..*	BackboneElement	Not available during this time due to provided reason ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
description	S	1..1	string	Reason presented to the user explaining why time not available ele-1: All FHIR elements must have a @value or children
during	S	0..1	Period	Service not available from this date ele-1: All FHIR elements must have a @value or children
availabilityExceptions	S	0..1	string	Description of availability exceptions ele-1: All FHIR elements must have a @value or children
endpoint	S	0..*	Reference(National Directory API Endpoint Profile)	Technical endpoints providing access to electronic services operated for the healthcare service ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
HealthcareService.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
HealthcareService.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
HealthcareService.category	example	ServiceCategory http://hl7.org/fhir/ValueSet/service-category from the FHIR Standard
HealthcareService.category:HSC	required	HealthcareServiceCategoryVS http://hl7.org/fhir/us/ndh/ValueSet/HealthcareServiceCategoryVS from this IG
HealthcareService.type	extensible	HealthcareServiceTypeVS http://hl7.org/fhir/us/ndh/ValueSet/HealthcareServiceTypeVS from this IG
HealthcareService.specialty	extensible	HealthcareProviderTaxonomy http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066 from https://vsac.nlm.nih.gov
HealthcareService.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
HealthcareService.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
HealthcareService.serviceProvisionCode	extensible	ServiceProvisionConditions http://hl7.org/fhir/ValueSet/service-provision-conditions from the FHIR Standard
HealthcareService.eligibility.code	extensible	HealthcareServiceEligibilityCodeVS http://hl7.org/fhir/us/ndh/ValueSet/HealthcareServiceEligibilityCodeVS from this IG
HealthcareService.program	extensible	Program http://hl7.org/fhir/ValueSet/program from the FHIR Standard
HealthcareService.characteristic	example
HealthcareService.referralMethod	example	ReferralMethod http://hl7.org/fhir/ValueSet/service-referral-method from the FHIR Standard
HealthcareService.availableTime.daysOfWeek	required	DaysOfWeek http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard

This structure is derived from NdhHealthcareService

Name	Flags	Card.	Type	Description & Constraints
HealthcareService			NdhHealthcareService
meta	S	0..1	Meta	Metadata about the resource
profile		1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:newpatients	S	0..*	NewPatients	NDH New Patients
extension:deliverymethod	S	0..*	DeliveryMethod	NDH Delivery Method
extension:verification-status	S	1..1	VerificationStatus	NDH Verification Status
extension:network		0..*	NetworkReference	NDH Network Reference
value[x]		1..1	Reference(National Directory API Network Profile)	Value of extension
identifier	S	0..*	Identifier	External identifiers for this item
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:identifier-status	S	1..1	IdentifierStatus	NDH Identifier Status
use	S	0..1	code	usual | official | temp | secondary | old (If known)
type	S	0..1	CodeableConcept	Description of identifier
system	S	0..1	uri	The namespace for the identifier value
value	S	0..1	string	The value that is unique
assigner	S	0..1	Reference(National Directory API Organization Profile)	Organization that issued id (may be just text)
providedBy		0..1	Reference(National Directory API Organization Profile)	Organization that provides this service
location		0..*	Reference(National Directory API Location Profile)	Location(s) where service may be provided
comment	S	0..1	string	Additional description and/or any specific issues not covered elsewhere
telecom	S	0..*	ContactPoint	Contacts related to the healthcare service
Slices for extension				Content/Rules for all slices
extension:contactpoint-availabletime	S	0..*	ContactPointAvailableTime	NDH Contactpoint Availabletime
extension:via-intermediary	S	0..1	ViaIntermediary	NDH Via Intermediary
system	S	0..1	code	phone | fax | email | pager | url | sms | other
value	S	0..1	string	The actual contact point details
coverageArea		0..*	Reference(National Directory API Location Profile)	Location(s) service is intended for/available to
serviceProvisionCode	S	0..*	CodeableConcept	Conditions under which service is available/offered
eligibility	S	0..*	BackboneElement	Specific eligibility requirements required to use the service
code	S	0..1	CodeableConcept	Coded value for the eligibility
comment	S	0..1	markdown	Describes the eligibility conditions for the service
program	S	0..*	CodeableConcept	Programs that this service is applicable to
characteristic	S	0..*	CodeableConcept	Collection of characteristics (attributes)
referralMethod	S	0..*	CodeableConcept	Ways that the service accepts referrals
appointmentRequired	S	0..1	boolean	If an appointment is required for access to this service
availableTime	S	0..*	BackboneElement	Times the Service Site is available
daysOfWeek	S	0..*	code	mon | tue | wed | thu | fri | sat | sun
allDay	S	0..1	boolean	Always available? e.g. 24 hour service
availableStartTime	S	0..1	time	Opening time of day (ignored if allDay = true)
availableEndTime	S	0..1	time	Closing time of day (ignored if allDay = true)
notAvailable	S	0..*	BackboneElement	Not available during this time due to provided reason
description	S	1..1	string	Reason presented to the user explaining why time not available
during	S	0..1	Period	Service not available from this date
availabilityExceptions	S	0..1	string	Description of availability exceptions
endpoint		0..*	Reference(National Directory API Endpoint Profile)	Technical endpoints providing access to electronic services operated for the healthcare service
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
HealthcareService		0..*	NdhHealthcareService	The details of a healthcare service available at a location
id	Σ	0..1	id	Logical id of this artifact
meta	SΣ	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	Σ	1..1	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
extension:rating		0..*	(Complex)	Evaluations or reviews for the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
extension:newpatients	SC	0..*	(Complex)	NDH New Patients URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients new-patients-characteristics: If no new patients are accepted, no characteristics are allowed
extension:deliverymethod	S	0..*	(Complex)	NDH Delivery Method 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: hl7VS-paymentMethodCode (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:usage-restriction		0..*	Reference(NDH Base Restriction) {c}	Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
extension:verification-status	S	1..1	CodeableConcept	NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible)
extension:network		0..*	(Complex)	NDH Network Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference"
value[x]	S	1..1	Reference(National Directory API Network Profile)	Value of extension
extension:social-service-requirement	C	0..*	(Complex)	Social Service Requirement URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement agerange-or-agegroup: a service or program only allow to have either age-range or age-group but not both
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	SΣ	0..*	Identifier	External identifiers for this item
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:identifier-status	S	1..1	code	NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required)
use	?!SΣ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	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	SΣ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	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	SΣ	0..1	Reference(National Directory API 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(National Directory API Organization Profile)	Organization that provides this service
Slices for category	SΣ	1..*	CodeableConcept	Broad category of service being performed or delivered Slice: Unordered, Open by value:$this Binding: ServiceCategory (example): A category of the service(s) that could be provided.
category:HSC	SΣ	0..1	CodeableConcept	NDH HealthcareService Category Binding: Healthcare Service Category Value Set (required)
type	SΣ	0..*	CodeableConcept	Type of service that may be delivered or performed Binding: HealthcareService Type Value Set (extensible)
specialty	SΣ	0..*	CodeableConcept	Specialties handled by the HealthcareService Binding: Healthcare Provider Taxonomy (extensible)
location	SΣ	0..*	Reference(National Directory API 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	SΣ	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	S	0..*	ContactPoint	Contacts related to the healthcare service
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:contactpoint-availabletime	S	0..*	(Complex)	NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
extension:via-intermediary	S	0..1	Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)	NDH Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
extension:language-speak		0..*	code	Language Speak URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak Binding: CommonLanguages (extensible)
system	SΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	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 API Location Profile)	Location(s) service is intended for/available to
serviceProvisionCode	S	0..*	CodeableConcept	Conditions under which service is available/offered Binding: ServiceProvisionConditions (extensible)
eligibility	S	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	S	0..1	CodeableConcept	Coded value for the eligibility Binding: Healthcare Service Eligibility Code Value Set (extensible)
comment	S	0..1	markdown	Describes the eligibility conditions for the service
program	S	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	S	0..*	CodeableConcept	Collection of characteristics (attributes) Binding Description (No ValueSet): (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	S	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	S	0..1	boolean	If an appointment is required for access to this service
availableTime	S	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	S	0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay	S	0..1	boolean	Always available? e.g. 24 hour service
availableStartTime	S	0..1	time	Opening time of day (ignored if allDay = true)
availableEndTime	S	0..1	time	Closing time of day (ignored if allDay = true)
notAvailable	S	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	S	1..1	string	Reason presented to the user explaining why time not available
during	S	0..1	Period	Service not available from this date
availabilityExceptions	S	0..1	string	Description of availability exceptions
endpoint	S	0..*	Reference(National Directory API Endpoint Profile)	Technical endpoints providing access to electronic services operated for the healthcare service
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
HealthcareService.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
HealthcareService.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
HealthcareService.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
HealthcareService.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
HealthcareService.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
HealthcareService.category	example	ServiceCategory http://hl7.org/fhir/ValueSet/service-category from the FHIR Standard
HealthcareService.category:HSC	required	HealthcareServiceCategoryVS http://hl7.org/fhir/us/ndh/ValueSet/HealthcareServiceCategoryVS from this IG
HealthcareService.type	extensible	HealthcareServiceTypeVS http://hl7.org/fhir/us/ndh/ValueSet/HealthcareServiceTypeVS from this IG
HealthcareService.specialty	extensible	HealthcareProviderTaxonomy http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066 from https://vsac.nlm.nih.gov
HealthcareService.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
HealthcareService.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
HealthcareService.serviceProvisionCode	extensible	ServiceProvisionConditions http://hl7.org/fhir/ValueSet/service-provision-conditions from the FHIR Standard
HealthcareService.eligibility.code	extensible	HealthcareServiceEligibilityCodeVS http://hl7.org/fhir/us/ndh/ValueSet/HealthcareServiceEligibilityCodeVS from this IG
HealthcareService.program	extensible	Program http://hl7.org/fhir/ValueSet/program from the FHIR Standard
HealthcareService.characteristic	example
HealthcareService.communication	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
HealthcareService.referralMethod	example	ReferralMethod http://hl7.org/fhir/ValueSet/service-referral-method from the FHIR Standard
HealthcareService.availableTime.daysOfWeek	required	DaysOfWeek http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard

This structure is derived from NdhHealthcareService

Summary

Mandatory: 2 elements(3 nested mandatory elements)
Must-Support: 34 elements

Structures

This structure refers to these other structures:

• National Directory API Network Profile (http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-ndapi-Network)
• National Directory API Organization Profile (http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-ndapi-Organization)
• National Directory API Location Profile (http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-ndapi-Location)
• National Directory API Endpoint Profile (http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-ndapi-Endpoint)

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
HealthcareService		0..*	NdhHealthcareService	The details of a healthcare service available at a location dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
meta	SΣ	0..1	Meta	Metadata about the resource ele-1: All FHIR elements must have a @value or children
lastUpdated	Σ	1..1	instant	When the resource version last changed ele-1: All FHIR elements must have a @value or children
profile	Σ	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to ele-1: All FHIR elements must have a @value or children
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:rating		0..*	(Complex)	Evaluations or reviews for the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:newpatients	SC	0..*	(Complex)	NDH New Patients URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both new-patients-characteristics: If no new patients are accepted, no characteristics are allowed
extension:deliverymethod	S	0..*	(Complex)	NDH Delivery Method URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-delivery-method ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:paymentaccepted		0..*	CodeableConcept	Forms of payment accepted. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-paymentAccepted Binding: hl7VS-paymentMethodCode (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:requiredDocument		0..*	(Complex)	Documents required for the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-requiredDocument ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:fundingSource		0..*	(Complex)	Funding source for the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-fundingSource ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:usage-restriction		0..*	Reference(NDH Base Restriction) {c}	Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:verification-status	S	1..1	CodeableConcept	NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:network		0..*	(Complex)	NDH Network Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference"
value[x]	S	1..1	Reference(National Directory API Network Profile)	Value of extension ele-1: All FHIR elements must have a @value or children
extension:social-service-requirement	C	0..*	(Complex)	Social Service Requirement URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both agerange-or-agegroup: a service or program only allow to have either age-range or age-group but not both
extension:logo		0..1	Attachment	Service Logo URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-logo ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	SΣ	0..*	Identifier	External identifiers for this item ele-1: All FHIR elements must have a @value or children
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:identifier-status	S	1..1	code	NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
use	?!SΣ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
type	SΣ	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. ele-1: All FHIR elements must have a @value or children
system	SΣ	0..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient
value	SΣ	0..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
assigner	SΣ	0..1	Reference(National Directory API Organization Profile)	Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children
active	?!SΣ	1..1	boolean	Whether this HealthcareService record is in active use ele-1: All FHIR elements must have a @value or children Required Pattern: true
providedBy	SΣ	0..1	Reference(National Directory API Organization Profile)	Organization that provides this service ele-1: All FHIR elements must have a @value or children
Slices for category	SΣ	1..*	CodeableConcept	Broad category of service being performed or delivered Slice: Unordered, Open by value:$this Binding: ServiceCategory (example): A category of the service(s) that could be provided. ele-1: All FHIR elements must have a @value or children
category:HSC	SΣ	0..1	CodeableConcept	NDH HealthcareService Category Binding: Healthcare Service Category Value Set (required) ele-1: All FHIR elements must have a @value or children
type	SΣ	0..*	CodeableConcept	Type of service that may be delivered or performed Binding: HealthcareService Type Value Set (extensible) ele-1: All FHIR elements must have a @value or children
specialty	SΣ	0..*	CodeableConcept	Specialties handled by the HealthcareService Binding: Healthcare Provider Taxonomy (extensible) ele-1: All FHIR elements must have a @value or children
location	SΣ	0..*	Reference(National Directory API Location Profile)	Location(s) where service may be provided ele-1: All FHIR elements must have a @value or children
name	SΣ	0..1	string	Description of service as presented to a consumer while searching ele-1: All FHIR elements must have a @value or children
comment	SΣ	0..1	string	Additional description and/or any specific issues not covered elsewhere ele-1: All FHIR elements must have a @value or children
telecom	S	0..*	ContactPoint	Contacts related to the healthcare service ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
extension:contactpoint-availabletime	S	0..*	(Complex)	NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:via-intermediary	S	0..1	Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)	NDH Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:language-speak		0..*	code	Language Speak URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak Binding: CommonLanguages (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
system	SΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children
value	SΣ	0..1	string	The actual contact point details ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children
coverageArea	S	0..*	Reference(National Directory API Location Profile)	Location(s) service is intended for/available to ele-1: All FHIR elements must have a @value or children
serviceProvisionCode	S	0..*	CodeableConcept	Conditions under which service is available/offered Binding: ServiceProvisionConditions (extensible) ele-1: All FHIR elements must have a @value or children
eligibility	S	0..*	BackboneElement	Specific eligibility requirements required to use the service ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
code	S	0..1	CodeableConcept	Coded value for the eligibility Binding: Healthcare Service Eligibility Code Value Set (extensible) ele-1: All FHIR elements must have a @value or children
comment	S	0..1	markdown	Describes the eligibility conditions for the service ele-1: All FHIR elements must have a @value or children
program	S	0..*	CodeableConcept	Programs that this service is applicable to Binding: Program (extensible) ele-1: All FHIR elements must have a @value or children
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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
characteristic	S	0..*	CodeableConcept	Collection of characteristics (attributes) Binding Description (No ValueSet): (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). ele-1: All FHIR elements must have a @value or children
referralMethod	S	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. ele-1: All FHIR elements must have a @value or children
appointmentRequired	S	0..1	boolean	If an appointment is required for access to this service ele-1: All FHIR elements must have a @value or children
availableTime	S	0..*	BackboneElement	Times the Service Site is available ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
daysOfWeek	S	0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. ele-1: All FHIR elements must have a @value or children
allDay	S	0..1	boolean	Always available? e.g. 24 hour service ele-1: All FHIR elements must have a @value or children
availableStartTime	S	0..1	time	Opening time of day (ignored if allDay = true) ele-1: All FHIR elements must have a @value or children
availableEndTime	S	0..1	time	Closing time of day (ignored if allDay = true) ele-1: All FHIR elements must have a @value or children
notAvailable	S	0..*	BackboneElement	Not available during this time due to provided reason ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
description	S	1..1	string	Reason presented to the user explaining why time not available ele-1: All FHIR elements must have a @value or children
during	S	0..1	Period	Service not available from this date ele-1: All FHIR elements must have a @value or children
availabilityExceptions	S	0..1	string	Description of availability exceptions ele-1: All FHIR elements must have a @value or children
endpoint	S	0..*	Reference(National Directory API Endpoint Profile)	Technical endpoints providing access to electronic services operated for the healthcare service ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
HealthcareService.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
HealthcareService.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
HealthcareService.category	example	ServiceCategory http://hl7.org/fhir/ValueSet/service-category from the FHIR Standard
HealthcareService.category:HSC	required	HealthcareServiceCategoryVS http://hl7.org/fhir/us/ndh/ValueSet/HealthcareServiceCategoryVS from this IG
HealthcareService.type	extensible	HealthcareServiceTypeVS http://hl7.org/fhir/us/ndh/ValueSet/HealthcareServiceTypeVS from this IG
HealthcareService.specialty	extensible	HealthcareProviderTaxonomy http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066 from https://vsac.nlm.nih.gov
HealthcareService.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
HealthcareService.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
HealthcareService.serviceProvisionCode	extensible	ServiceProvisionConditions http://hl7.org/fhir/ValueSet/service-provision-conditions from the FHIR Standard
HealthcareService.eligibility.code	extensible	HealthcareServiceEligibilityCodeVS http://hl7.org/fhir/us/ndh/ValueSet/HealthcareServiceEligibilityCodeVS from this IG
HealthcareService.program	extensible	Program http://hl7.org/fhir/ValueSet/program from the FHIR Standard
HealthcareService.characteristic	example
HealthcareService.referralMethod	example	ReferralMethod http://hl7.org/fhir/ValueSet/service-referral-method from the FHIR Standard
HealthcareService.availableTime.daysOfWeek	required	DaysOfWeek http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard

Differential View

This structure is derived from NdhHealthcareService

Name	Flags	Card.	Type	Description & Constraints
HealthcareService			NdhHealthcareService
meta	S	0..1	Meta	Metadata about the resource
profile		1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:newpatients	S	0..*	NewPatients	NDH New Patients
extension:deliverymethod	S	0..*	DeliveryMethod	NDH Delivery Method
extension:verification-status	S	1..1	VerificationStatus	NDH Verification Status
extension:network		0..*	NetworkReference	NDH Network Reference
value[x]		1..1	Reference(National Directory API Network Profile)	Value of extension
identifier	S	0..*	Identifier	External identifiers for this item
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:identifier-status	S	1..1	IdentifierStatus	NDH Identifier Status
use	S	0..1	code	usual | official | temp | secondary | old (If known)
type	S	0..1	CodeableConcept	Description of identifier
system	S	0..1	uri	The namespace for the identifier value
value	S	0..1	string	The value that is unique
assigner	S	0..1	Reference(National Directory API Organization Profile)	Organization that issued id (may be just text)
providedBy		0..1	Reference(National Directory API Organization Profile)	Organization that provides this service
location		0..*	Reference(National Directory API Location Profile)	Location(s) where service may be provided
comment	S	0..1	string	Additional description and/or any specific issues not covered elsewhere
telecom	S	0..*	ContactPoint	Contacts related to the healthcare service
Slices for extension				Content/Rules for all slices
extension:contactpoint-availabletime	S	0..*	ContactPointAvailableTime	NDH Contactpoint Availabletime
extension:via-intermediary	S	0..1	ViaIntermediary	NDH Via Intermediary
system	S	0..1	code	phone | fax | email | pager | url | sms | other
value	S	0..1	string	The actual contact point details
coverageArea		0..*	Reference(National Directory API Location Profile)	Location(s) service is intended for/available to
serviceProvisionCode	S	0..*	CodeableConcept	Conditions under which service is available/offered
eligibility	S	0..*	BackboneElement	Specific eligibility requirements required to use the service
code	S	0..1	CodeableConcept	Coded value for the eligibility
comment	S	0..1	markdown	Describes the eligibility conditions for the service
program	S	0..*	CodeableConcept	Programs that this service is applicable to
characteristic	S	0..*	CodeableConcept	Collection of characteristics (attributes)
referralMethod	S	0..*	CodeableConcept	Ways that the service accepts referrals
appointmentRequired	S	0..1	boolean	If an appointment is required for access to this service
availableTime	S	0..*	BackboneElement	Times the Service Site is available
daysOfWeek	S	0..*	code	mon | tue | wed | thu | fri | sat | sun
allDay	S	0..1	boolean	Always available? e.g. 24 hour service
availableStartTime	S	0..1	time	Opening time of day (ignored if allDay = true)
availableEndTime	S	0..1	time	Closing time of day (ignored if allDay = true)
notAvailable	S	0..*	BackboneElement	Not available during this time due to provided reason
description	S	1..1	string	Reason presented to the user explaining why time not available
during	S	0..1	Period	Service not available from this date
availabilityExceptions	S	0..1	string	Description of availability exceptions
endpoint		0..*	Reference(National Directory API Endpoint Profile)	Technical endpoints providing access to electronic services operated for the healthcare service
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
HealthcareService		0..*	NdhHealthcareService	The details of a healthcare service available at a location
id	Σ	0..1	id	Logical id of this artifact
meta	SΣ	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	Σ	1..1	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
extension:rating		0..*	(Complex)	Evaluations or reviews for the service. URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-rating
extension:newpatients	SC	0..*	(Complex)	NDH New Patients URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients new-patients-characteristics: If no new patients are accepted, no characteristics are allowed
extension:deliverymethod	S	0..*	(Complex)	NDH Delivery Method 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: hl7VS-paymentMethodCode (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:usage-restriction		0..*	Reference(NDH Base Restriction) {c}	Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
extension:verification-status	S	1..1	CodeableConcept	NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible)
extension:network		0..*	(Complex)	NDH Network Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-network-reference"
value[x]	S	1..1	Reference(National Directory API Network Profile)	Value of extension
extension:social-service-requirement	C	0..*	(Complex)	Social Service Requirement URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-service-or-program-requirement agerange-or-agegroup: a service or program only allow to have either age-range or age-group but not both
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	SΣ	0..*	Identifier	External identifiers for this item
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:identifier-status	S	1..1	code	NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required)
use	?!SΣ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	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	SΣ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	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	SΣ	0..1	Reference(National Directory API 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(National Directory API Organization Profile)	Organization that provides this service
Slices for category	SΣ	1..*	CodeableConcept	Broad category of service being performed or delivered Slice: Unordered, Open by value:$this Binding: ServiceCategory (example): A category of the service(s) that could be provided.
category:HSC	SΣ	0..1	CodeableConcept	NDH HealthcareService Category Binding: Healthcare Service Category Value Set (required)
type	SΣ	0..*	CodeableConcept	Type of service that may be delivered or performed Binding: HealthcareService Type Value Set (extensible)
specialty	SΣ	0..*	CodeableConcept	Specialties handled by the HealthcareService Binding: Healthcare Provider Taxonomy (extensible)
location	SΣ	0..*	Reference(National Directory API 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	SΣ	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	S	0..*	ContactPoint	Contacts related to the healthcare service
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:contactpoint-availabletime	S	0..*	(Complex)	NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
extension:via-intermediary	S	0..1	Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile)	NDH Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary
extension:language-speak		0..*	code	Language Speak URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak Binding: CommonLanguages (extensible)
system	SΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	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 API Location Profile)	Location(s) service is intended for/available to
serviceProvisionCode	S	0..*	CodeableConcept	Conditions under which service is available/offered Binding: ServiceProvisionConditions (extensible)
eligibility	S	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	S	0..1	CodeableConcept	Coded value for the eligibility Binding: Healthcare Service Eligibility Code Value Set (extensible)
comment	S	0..1	markdown	Describes the eligibility conditions for the service
program	S	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	S	0..*	CodeableConcept	Collection of characteristics (attributes) Binding Description (No ValueSet): (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	S	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	S	0..1	boolean	If an appointment is required for access to this service
availableTime	S	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	S	0..*	code	mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay	S	0..1	boolean	Always available? e.g. 24 hour service
availableStartTime	S	0..1	time	Opening time of day (ignored if allDay = true)
availableEndTime	S	0..1	time	Closing time of day (ignored if allDay = true)
notAvailable	S	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	S	1..1	string	Reason presented to the user explaining why time not available
during	S	0..1	Period	Service not available from this date
availabilityExceptions	S	0..1	string	Description of availability exceptions
endpoint	S	0..*	Reference(National Directory API Endpoint Profile)	Technical endpoints providing access to electronic services operated for the healthcare service
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
HealthcareService.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
HealthcareService.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
HealthcareService.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
HealthcareService.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
HealthcareService.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
HealthcareService.category	example	ServiceCategory http://hl7.org/fhir/ValueSet/service-category from the FHIR Standard
HealthcareService.category:HSC	required	HealthcareServiceCategoryVS http://hl7.org/fhir/us/ndh/ValueSet/HealthcareServiceCategoryVS from this IG
HealthcareService.type	extensible	HealthcareServiceTypeVS http://hl7.org/fhir/us/ndh/ValueSet/HealthcareServiceTypeVS from this IG
HealthcareService.specialty	extensible	HealthcareProviderTaxonomy http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066 from https://vsac.nlm.nih.gov
HealthcareService.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
HealthcareService.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
HealthcareService.serviceProvisionCode	extensible	ServiceProvisionConditions http://hl7.org/fhir/ValueSet/service-provision-conditions from the FHIR Standard
HealthcareService.eligibility.code	extensible	HealthcareServiceEligibilityCodeVS http://hl7.org/fhir/us/ndh/ValueSet/HealthcareServiceEligibilityCodeVS from this IG
HealthcareService.program	extensible	Program http://hl7.org/fhir/ValueSet/program from the FHIR Standard
HealthcareService.characteristic	example
HealthcareService.communication	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
HealthcareService.referralMethod	example	ReferralMethod http://hl7.org/fhir/ValueSet/service-referral-method from the FHIR Standard
HealthcareService.availableTime.daysOfWeek	required	DaysOfWeek http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard

This structure is derived from NdhHealthcareService

Summary

Mandatory: 2 elements(3 nested mandatory elements)
Must-Support: 34 elements

Structures

This structure refers to these other structures:

• National Directory API Network Profile (http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-ndapi-Network)
• National Directory API Organization Profile (http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-ndapi-Organization)
• National Directory API Location Profile (http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-ndapi-Location)
• National Directory API Endpoint Profile (http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-ndapi-Endpoint)