Da Vinci PDex Plan Net, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 1.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-pdex-plan-net/ and changes regularly. See the Directory of published versions

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

Resource Profile: Plan-Net HealthcareService

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: Plan-Net OrganizationAffiliation and Plan-Net PractitionerRole
• Examples for this Resource Profile: HealthcareService/BurrClinicServices, HealthcareService/CancerClinicService, HealthcareService/HamiltonClinicServices, HealthcareService/HansSoloService... Show 6 more, HealthcareService/HartfordOrthopedicServices, HealthcareService/HospERService, Compounding Pharmacy by OrgA, Mail Order Pharmacy by OrgA, Pharmacy by PharmChain and HealthcareService/VirtualCounselService

Formal Views of Profile Content

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

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

This structure is derived from HealthcareService

Name	Flags	Card.	Type	Description & Constraints
HealthcareService		0..*	HealthcareService	The details of a healthcare service available at a location
meta
lastUpdated		1..1	instant	When the resource version last changed
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
newpatients	S	0..*	(Complex)	New Patients URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients
deliverymethod	S	0..*	(Complex)	Delivery Method URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/delivery-method
identifier
type	S	0..1	CodeableConcept	Description of identifier
value	S	0..1	string	The value that is unique
active	S	1..1	boolean	Whether this HealthcareService record is in active use Required Pattern: true
providedBy	S	0..1	Reference(Plan-Net Organization)	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:plan-net-category	S	0..1	CodeableConcept	Broad category of service being performed or delivered Binding: Healthcare Service CategoryVS (required)
type	S	0..*	CodeableConcept	Type of service that may be delivered or performed Binding: HealthcareService Types VS (extensible)
specialty	S	0..*	CodeableConcept	Specialties handled by the HealthcareService Binding: Specialties VS (required)
location	S	0..*	Reference(Plan-Net Location)	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
telecom	S	0..*	ContactPoint	Contacts related to the healthcare service
Slices for extension				Content/Rules for all slices
contactpoint-availabletime	S	0..*	(Complex)	Contactpoint Availabletime URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime
via-intermediary	S	0..*	Reference(Plan-Net PractitionerRole | Plan-Net OrganizationAffiliation | Plan-Net Location | Plan-Net Organization)	Via Intermediary URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/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	S	0..*	Reference(Plan-Net Location)	Location(s) service is intended for/available to
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	S	0..*	Reference(Plan-Net Endpoint)	Technical endpoints providing access to electronic services operated for the healthcare service
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
HealthcareService.category:plan-net-category	required	HealthcareServiceCategoryVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/HealthcareServiceCategoryVS from this IG
HealthcareService.type	extensible	HealthcareServiceTypeVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/HealthcareServiceTypeVS from this IG
HealthcareService.specialty	required	SpecialtiesVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/SpecialtiesVS from this IG

Name	Flags	Card.	Type	Description & Constraints
HealthcareService		0..*	HealthcareService	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
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		0..*	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
newpatients	SC	0..*	(Complex)	New Patients URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/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
deliverymethod	S	0..*	(Complex)	Delivery Method URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/delivery-method 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	Σ	0..*	Identifier	External identifiers for this item ele-1: All FHIR elements must have a @value or children
use	?!Σ	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
value	SΣ	0..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
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(Plan-Net Organization)	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 pattern:$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:plan-net-category	SΣ	0..1	CodeableConcept	Broad category of service being performed or delivered Binding: Healthcare Service CategoryVS (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 Types VS (extensible) ele-1: All FHIR elements must have a @value or children
specialty	SΣ	0..*	CodeableConcept	Specialties handled by the HealthcareService Binding: Specialties VS (required) ele-1: All FHIR elements must have a @value or children
location	SΣ	0..*	Reference(Plan-Net Location)	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
contactpoint-availabletime	S	0..*	(Complex)	Contactpoint Availabletime URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
via-intermediary	S	0..*	Reference(Plan-Net PractitionerRole | Plan-Net OrganizationAffiliation | Plan-Net Location | Plan-Net Organization)	Via Intermediary URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary 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(Plan-Net Location)	Location(s) service is intended for/available to 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(Plan-Net Endpoint)	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:plan-net-category	required	HealthcareServiceCategoryVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/HealthcareServiceCategoryVS from this IG
HealthcareService.type	extensible	HealthcareServiceTypeVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/HealthcareServiceTypeVS from this IG
HealthcareService.specialty	required	SpecialtiesVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/SpecialtiesVS from this IG
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.availableTime.daysOfWeek	required	DaysOfWeek http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard

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
newpatients	SC	0..*	(Complex)	New Patients URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients new-patients-characteristics: If no new patients are accepted, no characteristics are allowed
deliverymethod	S	0..*	(Complex)	Delivery Method URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/delivery-method
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
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	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	Σ	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	Σ	0..1	Reference(Organization)	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(Plan-Net Organization)	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:plan-net-category	SΣ	0..1	CodeableConcept	Broad category of service being performed or delivered Binding: Healthcare Service CategoryVS (required)
type	SΣ	0..*	CodeableConcept	Type of service that may be delivered or performed Binding: HealthcareService Types VS (extensible)
specialty	SΣ	0..*	CodeableConcept	Specialties handled by the HealthcareService Binding: Specialties VS (required)
location	SΣ	0..*	Reference(Plan-Net Location)	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
contactpoint-availabletime	S	0..*	(Complex)	Contactpoint Availabletime URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime
via-intermediary	S	0..*	Reference(Plan-Net PractitionerRole | Plan-Net OrganizationAffiliation | Plan-Net Location | Plan-Net Organization)	Via Intermediary URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary
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(Plan-Net Location)	Location(s) service is intended for/available to
serviceProvisionCode		0..*	CodeableConcept	Conditions under which service is available/offered Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered.
eligibility		0..*	BackboneElement	Specific eligibility requirements required to use the service
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code		0..1	CodeableConcept	Coded value for the eligibility Binding Description (No ValueSet): (example): Coded values underwhich a specific service is made available.
comment		0..1	markdown	Describes the eligibility conditions for the service
program		0..*	CodeableConcept	Programs that this service is applicable to Binding: Program (example): Government or local programs that this service applies to.
characteristic		0..*	CodeableConcept	Collection of characteristics (attributes) Binding 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		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(Plan-Net Endpoint)	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:plan-net-category	required	HealthcareServiceCategoryVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/HealthcareServiceCategoryVS from this IG
HealthcareService.type	extensible	HealthcareServiceTypeVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/HealthcareServiceTypeVS from this IG
HealthcareService.specialty	required	SpecialtiesVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/SpecialtiesVS from this IG
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	example	ServiceProvisionConditions http://hl7.org/fhir/ValueSet/service-provision-conditions from the FHIR Standard
HealthcareService.eligibility.code	example
HealthcareService.program	example	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 HealthcareService

Summary

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

Structures

This structure refers to these other structures:

• Plan-Net Organization (http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Organization)
• Plan-Net Location (http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Location)
• Plan-Net Endpoint (http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Endpoint)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients
• http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/delivery-method
• http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime
• http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary

Slices

This structure defines the following Slices:

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

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
newpatients	S	0..*	(Complex)	New Patients URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients
deliverymethod	S	0..*	(Complex)	Delivery Method URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/delivery-method
identifier
type	S	0..1	CodeableConcept	Description of identifier
value	S	0..1	string	The value that is unique
active	S	1..1	boolean	Whether this HealthcareService record is in active use Required Pattern: true
providedBy	S	0..1	Reference(Plan-Net Organization)	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:plan-net-category	S	0..1	CodeableConcept	Broad category of service being performed or delivered Binding: Healthcare Service CategoryVS (required)
type	S	0..*	CodeableConcept	Type of service that may be delivered or performed Binding: HealthcareService Types VS (extensible)
specialty	S	0..*	CodeableConcept	Specialties handled by the HealthcareService Binding: Specialties VS (required)
location	S	0..*	Reference(Plan-Net Location)	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
telecom	S	0..*	ContactPoint	Contacts related to the healthcare service
Slices for extension				Content/Rules for all slices
contactpoint-availabletime	S	0..*	(Complex)	Contactpoint Availabletime URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime
via-intermediary	S	0..*	Reference(Plan-Net PractitionerRole | Plan-Net OrganizationAffiliation | Plan-Net Location | Plan-Net Organization)	Via Intermediary URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/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	S	0..*	Reference(Plan-Net Location)	Location(s) service is intended for/available to
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	S	0..*	Reference(Plan-Net Endpoint)	Technical endpoints providing access to electronic services operated for the healthcare service
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
HealthcareService.category:plan-net-category	required	HealthcareServiceCategoryVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/HealthcareServiceCategoryVS from this IG
HealthcareService.type	extensible	HealthcareServiceTypeVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/HealthcareServiceTypeVS from this IG
HealthcareService.specialty	required	SpecialtiesVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/SpecialtiesVS from this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
HealthcareService		0..*	HealthcareService	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
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		0..*	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
newpatients	SC	0..*	(Complex)	New Patients URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/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
deliverymethod	S	0..*	(Complex)	Delivery Method URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/delivery-method 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	Σ	0..*	Identifier	External identifiers for this item ele-1: All FHIR elements must have a @value or children
use	?!Σ	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
value	SΣ	0..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
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(Plan-Net Organization)	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 pattern:$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:plan-net-category	SΣ	0..1	CodeableConcept	Broad category of service being performed or delivered Binding: Healthcare Service CategoryVS (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 Types VS (extensible) ele-1: All FHIR elements must have a @value or children
specialty	SΣ	0..*	CodeableConcept	Specialties handled by the HealthcareService Binding: Specialties VS (required) ele-1: All FHIR elements must have a @value or children
location	SΣ	0..*	Reference(Plan-Net Location)	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
contactpoint-availabletime	S	0..*	(Complex)	Contactpoint Availabletime URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
via-intermediary	S	0..*	Reference(Plan-Net PractitionerRole | Plan-Net OrganizationAffiliation | Plan-Net Location | Plan-Net Organization)	Via Intermediary URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary 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(Plan-Net Location)	Location(s) service is intended for/available to 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(Plan-Net Endpoint)	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:plan-net-category	required	HealthcareServiceCategoryVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/HealthcareServiceCategoryVS from this IG
HealthcareService.type	extensible	HealthcareServiceTypeVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/HealthcareServiceTypeVS from this IG
HealthcareService.specialty	required	SpecialtiesVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/SpecialtiesVS from this IG
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.availableTime.daysOfWeek	required	DaysOfWeek http://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard

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
newpatients	SC	0..*	(Complex)	New Patients URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients new-patients-characteristics: If no new patients are accepted, no characteristics are allowed
deliverymethod	S	0..*	(Complex)	Delivery Method URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/delivery-method
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
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	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	Σ	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	Σ	0..1	Reference(Organization)	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(Plan-Net Organization)	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:plan-net-category	SΣ	0..1	CodeableConcept	Broad category of service being performed or delivered Binding: Healthcare Service CategoryVS (required)
type	SΣ	0..*	CodeableConcept	Type of service that may be delivered or performed Binding: HealthcareService Types VS (extensible)
specialty	SΣ	0..*	CodeableConcept	Specialties handled by the HealthcareService Binding: Specialties VS (required)
location	SΣ	0..*	Reference(Plan-Net Location)	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
contactpoint-availabletime	S	0..*	(Complex)	Contactpoint Availabletime URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime
via-intermediary	S	0..*	Reference(Plan-Net PractitionerRole | Plan-Net OrganizationAffiliation | Plan-Net Location | Plan-Net Organization)	Via Intermediary URL: http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary
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(Plan-Net Location)	Location(s) service is intended for/available to
serviceProvisionCode		0..*	CodeableConcept	Conditions under which service is available/offered Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered.
eligibility		0..*	BackboneElement	Specific eligibility requirements required to use the service
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code		0..1	CodeableConcept	Coded value for the eligibility Binding Description (No ValueSet): (example): Coded values underwhich a specific service is made available.
comment		0..1	markdown	Describes the eligibility conditions for the service
program		0..*	CodeableConcept	Programs that this service is applicable to Binding: Program (example): Government or local programs that this service applies to.
characteristic		0..*	CodeableConcept	Collection of characteristics (attributes) Binding 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		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(Plan-Net Endpoint)	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:plan-net-category	required	HealthcareServiceCategoryVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/HealthcareServiceCategoryVS from this IG
HealthcareService.type	extensible	HealthcareServiceTypeVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/HealthcareServiceTypeVS from this IG
HealthcareService.specialty	required	SpecialtiesVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/SpecialtiesVS from this IG
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	example	ServiceProvisionConditions http://hl7.org/fhir/ValueSet/service-provision-conditions from the FHIR Standard
HealthcareService.eligibility.code	example
HealthcareService.program	example	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 HealthcareService

Summary

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

Structures

This structure refers to these other structures:

• Plan-Net Organization (http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Organization)
• Plan-Net Location (http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Location)
• Plan-Net Endpoint (http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Endpoint)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/newpatients
• http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/delivery-method
• http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/contactpoint-availabletime
• http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/via-intermediary

Slices

This structure defines the following Slices:

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

Other representations of profile: CSV, Excel, Schematron