CambioOpenServicesIG - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Examples
• JSON

Resource Profile: HealthcareServiceLiteSe

Introduction

HealthcareServiceLiteSe is a profile based on the FHIR resource HealthcareService.

Intended Use

HealthcareServiceLiteSe is used as part of the booking flow, where this profile searches for a list of healthcare services that may be used to book an appointment.

Specific Rules and Limitations

Versions

Extensions

APIs & Supported Operations

Search Parameters

Supported Queries

• GET [baseURL]/HealthcareService/_search?location=<reference>
• GET [baseURL]/HealthcareService/_search?location.identifier=<identifier reference>

Error Codes

In the table below, a few error messages specific for HealthcareServices are listed.

Usages:

• Refer to this Profile: AppointmentSe
• Examples for this Profile: KOL

You can also check for usages in the FHIR IG Statistics

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    Filter: Bindings Constraints Obligations
HealthcareService		0..*	HealthcareServiceCoreSe	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
extension:permittedPatientActions		0..*	Coding	Use to describe what a patient is permitted to do URL: http://cambio.se/fhir/StructureDefinition/common-permittedPatientActions/v1
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
active	?!Σ	0..1	boolean	Whether this HealthcareService record is in active use
category	Σ	0..1	CodeableConcept	Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided.
name	Σ	1..1	string	Description of service as presented to a consumer while searching
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
HealthcareService.category	example	ServiceCategory http://hl7.org/fhir/ValueSet/service-category 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()

This structure is derived from HealthcareServiceCoreSe

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
HealthcareService			HealthcareServiceCoreSe
Slices for extension				Content/Rules for all slices
extension:color		0..0
category		0..1	CodeableConcept	Broad category of service being performed or delivered
type		0..0
specialty		0..0
name		1..1	string	Description of service as presented to a consumer while searching
comment		0..0
extraDetails		0..0
coverageArea		0..0
serviceProvisionCode		0..0
eligibility		0..0
program		0..0
characteristic		0..0
communication		0..0
referralMethod		0..0
appointmentRequired		0..0
availableTime		0..0
notAvailable		0..0
availabilityExceptions		0..0
endpoint		0..0
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
HealthcareService		0..*	HealthcareServiceCoreSe	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
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:permittedPatientActions		0..*	Coding	Use to describe what a patient is permitted to do URL: http://cambio.se/fhir/StructureDefinition/common-permittedPatientActions/v1
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	External identifiers for this item
active	?!Σ	0..1	boolean	Whether this HealthcareService record is in active use
providedBy	Σ	0..1	Reference(Organization)	Organization that provides this service
category	Σ	0..1	CodeableConcept	Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided.
location	Σ	0..*	Reference(Location)	Location(s) where service may be provided
name	Σ	1..1	string	Description of service as presented to a consumer while searching
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
HealthcareService.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
HealthcareService.category	example	ServiceCategory http://hl7.org/fhir/ValueSet/service-category From the FHIR Standard
HealthcareService.eligibility.code	example
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()

This structure is derived from HealthcareServiceCoreSe

Summary

Mandatory: 1 element
Prohibited: 17 elements

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
HealthcareService		0..*	HealthcareServiceCoreSe	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
extension:permittedPatientActions		0..*	Coding	Use to describe what a patient is permitted to do URL: http://cambio.se/fhir/StructureDefinition/common-permittedPatientActions/v1
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
active	?!Σ	0..1	boolean	Whether this HealthcareService record is in active use
category	Σ	0..1	CodeableConcept	Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided.
name	Σ	1..1	string	Description of service as presented to a consumer while searching
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
HealthcareService.category	example	ServiceCategory http://hl7.org/fhir/ValueSet/service-category 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()

Differential View

This structure is derived from HealthcareServiceCoreSe

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
HealthcareService			HealthcareServiceCoreSe
Slices for extension				Content/Rules for all slices
extension:color		0..0
category		0..1	CodeableConcept	Broad category of service being performed or delivered
type		0..0
specialty		0..0
name		1..1	string	Description of service as presented to a consumer while searching
comment		0..0
extraDetails		0..0
coverageArea		0..0
serviceProvisionCode		0..0
eligibility		0..0
program		0..0
characteristic		0..0
communication		0..0
referralMethod		0..0
appointmentRequired		0..0
availableTime		0..0
notAvailable		0..0
availabilityExceptions		0..0
endpoint		0..0
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
HealthcareService		0..*	HealthcareServiceCoreSe	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
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:permittedPatientActions		0..*	Coding	Use to describe what a patient is permitted to do URL: http://cambio.se/fhir/StructureDefinition/common-permittedPatientActions/v1
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	External identifiers for this item
active	?!Σ	0..1	boolean	Whether this HealthcareService record is in active use
providedBy	Σ	0..1	Reference(Organization)	Organization that provides this service
category	Σ	0..1	CodeableConcept	Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided.
location	Σ	0..*	Reference(Location)	Location(s) where service may be provided
name	Σ	1..1	string	Description of service as presented to a consumer while searching
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
HealthcareService.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
HealthcareService.category	example	ServiceCategory http://hl7.org/fhir/ValueSet/service-category From the FHIR Standard
HealthcareService.eligibility.code	example
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()

This structure is derived from HealthcareServiceCoreSe

Summary

Mandatory: 1 element
Prohibited: 17 elements

Other representations of profile: CSV, Excel, Schematron