careMESH NPD - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

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

Resource Profile: careMESH 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:

• Examples for this Resource Profile: HealthcareService/CaremeshHealthcareServiceExample

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..*	PlannetHealthcareService	The details of a healthcare service available at a location
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
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
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.
value	SΣ	0..1	string	The value that is unique Example General: 123456
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
category	SΣ	1..1	CodeableConcept	Broad category of service being performed or delivered Binding: Healthcare Service CategoryVS (extensible)
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Σ	1..*	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
telecom-info	S	0..1	(Complex)	careMESH ContactPoint Description URL: http://fhir.caremesh.app/StructureDefinition/caremesh-contact-point-description
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.
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
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
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.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	extensible	HealthcareServiceCategoryVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/HealthcareServiceCategoryVS
HealthcareService.type	extensible	HealthcareServiceTypeVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/HealthcareServiceTypeVS
HealthcareService.specialty	required	SpecialtiesVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/SpecialtiesVS
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

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	HealthcareService	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	HealthcareService	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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	HealthcareService	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	HealthcareService	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	HealthcareService	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
new-patients-characteristics	error	HealthcareService.extension:newpatients	If no new patients are accepted, no characteristics are allowed : extension('acceptingPatients').valueCodeableConcept.coding.exists(code = 'no') implies extension('characteristics').empty()

This structure is derived from PlannetHealthcareService

Name	Flags	Card.	Type	Description & Constraints
HealthcareService		0..*	PlannetHealthcareService	The details of a healthcare service available at a location
location		1..*	Reference(Plan-Net Location)	Location(s) where service may be provided
telecom
Slices for extension				Content/Rules for all slices
telecom-info	S	0..1	(Complex)	careMESH ContactPoint Description URL: http://fhir.caremesh.app/StructureDefinition/caremesh-contact-point-description
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
HealthcareService		0..*	PlannetHealthcareService	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
category	SΣ	1..1	CodeableConcept	Broad category of service being performed or delivered Binding: Healthcare Service CategoryVS (extensible)
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Σ	1..*	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
telecom-info	S	0..1	(Complex)	careMESH ContactPoint Description URL: http://fhir.caremesh.app/StructureDefinition/caremesh-contact-point-description
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 Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
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	extensible	HealthcareServiceCategoryVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/HealthcareServiceCategoryVS
HealthcareService.type	extensible	HealthcareServiceTypeVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/HealthcareServiceTypeVS
HealthcareService.specialty	required	SpecialtiesVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/SpecialtiesVS
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 Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
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

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	HealthcareService	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	HealthcareService	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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	HealthcareService	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	HealthcareService	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	HealthcareService	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
new-patients-characteristics	error	HealthcareService.extension:newpatients	If no new patients are accepted, no characteristics are allowed : extension('acceptingPatients').valueCodeableConcept.coding.exists(code = 'no') implies extension('characteristics').empty()

This structure is derived from PlannetHealthcareService

Summary

Mandatory: 1 element
Must-Support: 1 element

Extensions

This structure refers to these extensions:

• http://fhir.caremesh.app/StructureDefinition/caremesh-contact-point-description

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
HealthcareService		0..*	PlannetHealthcareService	The details of a healthcare service available at a location
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
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
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.
value	SΣ	0..1	string	The value that is unique Example General: 123456
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
category	SΣ	1..1	CodeableConcept	Broad category of service being performed or delivered Binding: Healthcare Service CategoryVS (extensible)
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Σ	1..*	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
telecom-info	S	0..1	(Complex)	careMESH ContactPoint Description URL: http://fhir.caremesh.app/StructureDefinition/caremesh-contact-point-description
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.
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
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
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.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	extensible	HealthcareServiceCategoryVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/HealthcareServiceCategoryVS
HealthcareService.type	extensible	HealthcareServiceTypeVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/HealthcareServiceTypeVS
HealthcareService.specialty	required	SpecialtiesVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/SpecialtiesVS
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

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	HealthcareService	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	HealthcareService	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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	HealthcareService	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	HealthcareService	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	HealthcareService	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
new-patients-characteristics	error	HealthcareService.extension:newpatients	If no new patients are accepted, no characteristics are allowed : extension('acceptingPatients').valueCodeableConcept.coding.exists(code = 'no') implies extension('characteristics').empty()

Differential View

This structure is derived from PlannetHealthcareService

Name	Flags	Card.	Type	Description & Constraints
HealthcareService		0..*	PlannetHealthcareService	The details of a healthcare service available at a location
location		1..*	Reference(Plan-Net Location)	Location(s) where service may be provided
telecom
Slices for extension				Content/Rules for all slices
telecom-info	S	0..1	(Complex)	careMESH ContactPoint Description URL: http://fhir.caremesh.app/StructureDefinition/caremesh-contact-point-description
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
HealthcareService		0..*	PlannetHealthcareService	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
category	SΣ	1..1	CodeableConcept	Broad category of service being performed or delivered Binding: Healthcare Service CategoryVS (extensible)
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Σ	1..*	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
telecom-info	S	0..1	(Complex)	careMESH ContactPoint Description URL: http://fhir.caremesh.app/StructureDefinition/caremesh-contact-point-description
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 Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
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	extensible	HealthcareServiceCategoryVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/HealthcareServiceCategoryVS
HealthcareService.type	extensible	HealthcareServiceTypeVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/HealthcareServiceTypeVS
HealthcareService.specialty	required	SpecialtiesVS http://hl7.org/fhir/us/davinci-pdex-plan-net/ValueSet/SpecialtiesVS
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 Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
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

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	HealthcareService	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	HealthcareService	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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	HealthcareService	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	HealthcareService	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	HealthcareService	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
new-patients-characteristics	error	HealthcareService.extension:newpatients	If no new patients are accepted, no characteristics are allowed : extension('acceptingPatients').valueCodeableConcept.coding.exists(code = 'no') implies extension('characteristics').empty()

This structure is derived from PlannetHealthcareService

Summary

Mandatory: 1 element
Must-Support: 1 element

Extensions

This structure refers to these extensions:

• http://fhir.caremesh.app/StructureDefinition/caremesh-contact-point-description

Other representations of profile: CSV, Excel, Schematron