SPL Mapping FHIR R5 Implementation Guide
0.2.1 - Build CI United States of America flag

SPL Mapping FHIR R5 Implementation Guide, published by HL7 International / Biomedical Research and Regulation. This guide is not an authorized publication; it is the continuous build for version 0.2.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-spl/ and changes regularly. See the Directory of published versions

Resource Profile: LabelerBusinessOperation

Official URL: http://hl7.org/fhir/us/spl/StructureDefinition/LabelerBusinessOperation Version: 0.2.1
Standards status: Trial-use Maturity Level: 1 Computable Name: LabelerBusinessOperation

A profile that associates a Labeler to the set of business operations that it can perform.

Usage:

Formal Views of Profile Content

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

This structure is derived from HealthcareService

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService C 0..* HealthcareService The details of a healthcare service available at a location
spl-5.1.5.7: Qualifier is mandatory unless operation is analysis (C25391) or API manufacture (C82401)
spl-5.1.5.11: If operation is C43360, then qualifier is C106643, C131710, C131708, and/or C131709
spl-5.1.5.12: If operation is C73608, then qualifier is C111077 and/or C111078
spl-5.1.5.13: If operation is C112113, then qualifier is C112087, C112091, C112092, C112093, C112094 and/or C112095
... providedBy S 1..1 Reference(LabelerOrganization) Organization that provides this service
... type S 1..1 CodeableConcept Type of service that may be delivered or performed
Binding: Labeler Business Operations (required)
... serviceProvisionCode S 0..* CodeableConcept Conditions under which service is available/offered
Binding: Business Operation Qualifiers (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
HealthcareService.typerequiredLabelerBusinessOperations
http://hl7.org/fhir/us/spl/ValueSet/valueset-labelerBusinessOperations
from this IG
HealthcareService.serviceProvisionCoderequiredBusinessOperationQualifiers
http://hl7.org/fhir/us/spl/ValueSet/valueset-businessOperationQualifiers
from this IG

Constraints

IdGradePath(s)DetailsRequirements
spl-5.1.5.11errorHealthcareServiceIf operation is C43360, then qualifier is C106643, C131710, C131708, and/or C131709
: type.coding.where(code = 'C43360').exists() implies serviceProvisionCode.coding.select(code in ('C106643' | 'C131710' | 'C131708' | 'C131709')).allTrue()
spl-5.1.5.12errorHealthcareServiceIf operation is C73608, then qualifier is C111077 and/or C111078
: type.coding.where(code = 'C73608').exists() implies serviceProvisionCode.coding.select(code in ('C111077' | 'C111078')).allTrue()
spl-5.1.5.13errorHealthcareServiceIf operation is C112113, then qualifier is C112087, C112091, C112092, C112093, C112094 and/or C112095
: type.coding.where(code = 'C112113').exists() implies serviceProvisionCode.coding.select(code in ('C112087' | 'C112091' | 'C112092' | 'C112093' | 'C112094' | 'C112095')).allTrue()
spl-5.1.5.7errorHealthcareServiceQualifier is mandatory unless operation is analysis (C25391) or API manufacture (C82401)
: type.coding.where(code = 'C25391').exists() or type.coding.where(code = 'C82401').exists() or serviceProvisionCode.count() > 0
NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService C 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
spl-5.1.5.7: Qualifier is mandatory unless operation is analysis (C25391) or API manufacture (C82401)
spl-5.1.5.11: If operation is C43360, then qualifier is C106643, C131710, C131708, and/or C131709
spl-5.1.5.12: If operation is C73608, then qualifier is C111077 and/or C111078
spl-5.1.5.13: If operation is C112113, then qualifier is C112087, C112091, C112092, C112093, C112094 and/or C112095
... 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
... contained 0..* Resource Contained, inline Resources
... 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
... providedBy SΣ 1..1 Reference(LabelerOrganization) Organization that provides this service
ele-1: All FHIR elements must have a @value or children
... type SΣ 1..1 CodeableConcept Type of service that may be delivered or performed
Binding: Labeler Business Operations (required)
ele-1: All FHIR elements must have a @value or children
... serviceProvisionCode S 0..* CodeableConcept Conditions under which service is available/offered
Binding: Business Operation Qualifiers (required)
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
HealthcareService.typerequiredLabelerBusinessOperations
http://hl7.org/fhir/us/spl/ValueSet/valueset-labelerBusinessOperations
from this IG
HealthcareService.serviceProvisionCoderequiredBusinessOperationQualifiers
http://hl7.org/fhir/us/spl/ValueSet/valueset-businessOperationQualifiers
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorHealthcareServiceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorHealthcareServiceIf 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorHealthcareServiceIf 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-5errorHealthcareServiceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceHealthcareServiceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
spl-5.1.5.11errorHealthcareServiceIf operation is C43360, then qualifier is C106643, C131710, C131708, and/or C131709
: type.coding.where(code = 'C43360').exists() implies serviceProvisionCode.coding.select(code in ('C106643' | 'C131710' | 'C131708' | 'C131709')).allTrue()
spl-5.1.5.12errorHealthcareServiceIf operation is C73608, then qualifier is C111077 and/or C111078
: type.coding.where(code = 'C73608').exists() implies serviceProvisionCode.coding.select(code in ('C111077' | 'C111078')).allTrue()
spl-5.1.5.13errorHealthcareServiceIf operation is C112113, then qualifier is C112087, C112091, C112092, C112093, C112094 and/or C112095
: type.coding.where(code = 'C112113').exists() implies serviceProvisionCode.coding.select(code in ('C112087' | 'C112091' | 'C112092' | 'C112093' | 'C112094' | 'C112095')).allTrue()
spl-5.1.5.7errorHealthcareServiceQualifier is mandatory unless operation is analysis (C25391) or API manufacture (C82401)
: type.coding.where(code = 'C25391').exists() or type.coding.where(code = 'C82401').exists() or serviceProvisionCode.count() > 0
NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService C 0..* HealthcareService The details of a healthcare service available at a location
spl-5.1.5.7: Qualifier is mandatory unless operation is analysis (C25391) or API manufacture (C82401)
spl-5.1.5.11: If operation is C43360, then qualifier is C106643, C131710, C131708, and/or C131709
spl-5.1.5.12: If operation is C73608, then qualifier is C111077 and/or C111078
spl-5.1.5.13: If operation is C112113, then qualifier is C112087, C112091, C112092, C112093, C112094 and/or C112095
... 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: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... 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 SΣ 1..1 Reference(LabelerOrganization) Organization that provides this service
... offeredIn 0..* Reference(HealthcareService) The service within which this service is offered
... category Σ 0..* CodeableConcept Broad category of service being performed or delivered
Binding: ServiceCategory (example): A category of the service(s) that could be provided.


... type SΣ 1..1 CodeableConcept Type of service that may be delivered or performed
Binding: Labeler Business Operations (required)
... specialty Σ 0..* CodeableConcept Specialties handled by the HealthcareService
Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide.


... location Σ 0..* Reference(Location) Location(s) where service may be provided
... name Σ 0..1 string Description of service as presented to a consumer while searching
... comment Σ 0..1 markdown 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
... contact 0..* ExtendedContactDetail Official contact details for the HealthcareService
... coverageArea 0..* Reference(Location) Location(s) service is intended for/available to
... serviceProvisionCode S 0..* CodeableConcept Conditions under which service is available/offered
Binding: Business Operation Qualifiers (required)
... 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: ServiceMode (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibility).


... communication 0..* CodeableConcept The language that this service is offered in
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set

... 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 0..1 boolean If an appointment is required for access to this service
... availability 0..* Availability Times the healthcare service is available (including exceptions)
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to electronic services operated for the healthcare service

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
HealthcareService.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
HealthcareService.categoryexampleServiceCategory
http://hl7.org/fhir/ValueSet/service-category
from the FHIR Standard
HealthcareService.typerequiredLabelerBusinessOperations
http://hl7.org/fhir/us/spl/ValueSet/valueset-labelerBusinessOperations
from this IG
HealthcareService.specialtypreferredPracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
from the FHIR Standard
HealthcareService.serviceProvisionCoderequiredBusinessOperationQualifiers
http://hl7.org/fhir/us/spl/ValueSet/valueset-businessOperationQualifiers
from this IG
HealthcareService.eligibility.codeexample
HealthcareService.programexampleProgram
http://hl7.org/fhir/ValueSet/program
from the FHIR Standard
HealthcareService.characteristicexampleServiceMode
http://hl7.org/fhir/ValueSet/service-mode
from the FHIR Standard
HealthcareService.communicationrequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
HealthcareService.referralMethodexampleReferralMethod
http://hl7.org/fhir/ValueSet/service-referral-method
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorHealthcareServiceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorHealthcareServiceIf 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorHealthcareServiceIf 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-5errorHealthcareServiceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceHealthcareServiceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
spl-5.1.5.11errorHealthcareServiceIf operation is C43360, then qualifier is C106643, C131710, C131708, and/or C131709
: type.coding.where(code = 'C43360').exists() implies serviceProvisionCode.coding.select(code in ('C106643' | 'C131710' | 'C131708' | 'C131709')).allTrue()
spl-5.1.5.12errorHealthcareServiceIf operation is C73608, then qualifier is C111077 and/or C111078
: type.coding.where(code = 'C73608').exists() implies serviceProvisionCode.coding.select(code in ('C111077' | 'C111078')).allTrue()
spl-5.1.5.13errorHealthcareServiceIf operation is C112113, then qualifier is C112087, C112091, C112092, C112093, C112094 and/or C112095
: type.coding.where(code = 'C112113').exists() implies serviceProvisionCode.coding.select(code in ('C112087' | 'C112091' | 'C112092' | 'C112093' | 'C112094' | 'C112095')).allTrue()
spl-5.1.5.7errorHealthcareServiceQualifier is mandatory unless operation is analysis (C25391) or API manufacture (C82401)
: type.coding.where(code = 'C25391').exists() or type.coding.where(code = 'C82401').exists() or serviceProvisionCode.count() > 0

This structure is derived from HealthcareService

Summary

Mandatory: 2 elements
Must-Support: 3 elements

Structures

This structure refers to these other structures:

Maturity: 1

Differential View

This structure is derived from HealthcareService

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService C 0..* HealthcareService The details of a healthcare service available at a location
spl-5.1.5.7: Qualifier is mandatory unless operation is analysis (C25391) or API manufacture (C82401)
spl-5.1.5.11: If operation is C43360, then qualifier is C106643, C131710, C131708, and/or C131709
spl-5.1.5.12: If operation is C73608, then qualifier is C111077 and/or C111078
spl-5.1.5.13: If operation is C112113, then qualifier is C112087, C112091, C112092, C112093, C112094 and/or C112095
... providedBy S 1..1 Reference(LabelerOrganization) Organization that provides this service
... type S 1..1 CodeableConcept Type of service that may be delivered or performed
Binding: Labeler Business Operations (required)
... serviceProvisionCode S 0..* CodeableConcept Conditions under which service is available/offered
Binding: Business Operation Qualifiers (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
HealthcareService.typerequiredLabelerBusinessOperations
http://hl7.org/fhir/us/spl/ValueSet/valueset-labelerBusinessOperations
from this IG
HealthcareService.serviceProvisionCoderequiredBusinessOperationQualifiers
http://hl7.org/fhir/us/spl/ValueSet/valueset-businessOperationQualifiers
from this IG

Constraints

IdGradePath(s)DetailsRequirements
spl-5.1.5.11errorHealthcareServiceIf operation is C43360, then qualifier is C106643, C131710, C131708, and/or C131709
: type.coding.where(code = 'C43360').exists() implies serviceProvisionCode.coding.select(code in ('C106643' | 'C131710' | 'C131708' | 'C131709')).allTrue()
spl-5.1.5.12errorHealthcareServiceIf operation is C73608, then qualifier is C111077 and/or C111078
: type.coding.where(code = 'C73608').exists() implies serviceProvisionCode.coding.select(code in ('C111077' | 'C111078')).allTrue()
spl-5.1.5.13errorHealthcareServiceIf operation is C112113, then qualifier is C112087, C112091, C112092, C112093, C112094 and/or C112095
: type.coding.where(code = 'C112113').exists() implies serviceProvisionCode.coding.select(code in ('C112087' | 'C112091' | 'C112092' | 'C112093' | 'C112094' | 'C112095')).allTrue()
spl-5.1.5.7errorHealthcareServiceQualifier is mandatory unless operation is analysis (C25391) or API manufacture (C82401)
: type.coding.where(code = 'C25391').exists() or type.coding.where(code = 'C82401').exists() or serviceProvisionCode.count() > 0

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService C 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
spl-5.1.5.7: Qualifier is mandatory unless operation is analysis (C25391) or API manufacture (C82401)
spl-5.1.5.11: If operation is C43360, then qualifier is C106643, C131710, C131708, and/or C131709
spl-5.1.5.12: If operation is C73608, then qualifier is C111077 and/or C111078
spl-5.1.5.13: If operation is C112113, then qualifier is C112087, C112091, C112092, C112093, C112094 and/or C112095
... 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
... contained 0..* Resource Contained, inline Resources
... 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
... providedBy SΣ 1..1 Reference(LabelerOrganization) Organization that provides this service
ele-1: All FHIR elements must have a @value or children
... type SΣ 1..1 CodeableConcept Type of service that may be delivered or performed
Binding: Labeler Business Operations (required)
ele-1: All FHIR elements must have a @value or children
... serviceProvisionCode S 0..* CodeableConcept Conditions under which service is available/offered
Binding: Business Operation Qualifiers (required)
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
HealthcareService.typerequiredLabelerBusinessOperations
http://hl7.org/fhir/us/spl/ValueSet/valueset-labelerBusinessOperations
from this IG
HealthcareService.serviceProvisionCoderequiredBusinessOperationQualifiers
http://hl7.org/fhir/us/spl/ValueSet/valueset-businessOperationQualifiers
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorHealthcareServiceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorHealthcareServiceIf 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorHealthcareServiceIf 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-5errorHealthcareServiceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceHealthcareServiceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
spl-5.1.5.11errorHealthcareServiceIf operation is C43360, then qualifier is C106643, C131710, C131708, and/or C131709
: type.coding.where(code = 'C43360').exists() implies serviceProvisionCode.coding.select(code in ('C106643' | 'C131710' | 'C131708' | 'C131709')).allTrue()
spl-5.1.5.12errorHealthcareServiceIf operation is C73608, then qualifier is C111077 and/or C111078
: type.coding.where(code = 'C73608').exists() implies serviceProvisionCode.coding.select(code in ('C111077' | 'C111078')).allTrue()
spl-5.1.5.13errorHealthcareServiceIf operation is C112113, then qualifier is C112087, C112091, C112092, C112093, C112094 and/or C112095
: type.coding.where(code = 'C112113').exists() implies serviceProvisionCode.coding.select(code in ('C112087' | 'C112091' | 'C112092' | 'C112093' | 'C112094' | 'C112095')).allTrue()
spl-5.1.5.7errorHealthcareServiceQualifier is mandatory unless operation is analysis (C25391) or API manufacture (C82401)
: type.coding.where(code = 'C25391').exists() or type.coding.where(code = 'C82401').exists() or serviceProvisionCode.count() > 0

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService C 0..* HealthcareService The details of a healthcare service available at a location
spl-5.1.5.7: Qualifier is mandatory unless operation is analysis (C25391) or API manufacture (C82401)
spl-5.1.5.11: If operation is C43360, then qualifier is C106643, C131710, C131708, and/or C131709
spl-5.1.5.12: If operation is C73608, then qualifier is C111077 and/or C111078
spl-5.1.5.13: If operation is C112113, then qualifier is C112087, C112091, C112092, C112093, C112094 and/or C112095
... 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: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... 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 SΣ 1..1 Reference(LabelerOrganization) Organization that provides this service
... offeredIn 0..* Reference(HealthcareService) The service within which this service is offered
... category Σ 0..* CodeableConcept Broad category of service being performed or delivered
Binding: ServiceCategory (example): A category of the service(s) that could be provided.


... type SΣ 1..1 CodeableConcept Type of service that may be delivered or performed
Binding: Labeler Business Operations (required)
... specialty Σ 0..* CodeableConcept Specialties handled by the HealthcareService
Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide.


... location Σ 0..* Reference(Location) Location(s) where service may be provided
... name Σ 0..1 string Description of service as presented to a consumer while searching
... comment Σ 0..1 markdown 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
... contact 0..* ExtendedContactDetail Official contact details for the HealthcareService
... coverageArea 0..* Reference(Location) Location(s) service is intended for/available to
... serviceProvisionCode S 0..* CodeableConcept Conditions under which service is available/offered
Binding: Business Operation Qualifiers (required)
... 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: ServiceMode (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibility).


... communication 0..* CodeableConcept The language that this service is offered in
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter Set

... 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 0..1 boolean If an appointment is required for access to this service
... availability 0..* Availability Times the healthcare service is available (including exceptions)
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to electronic services operated for the healthcare service

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
HealthcareService.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
HealthcareService.categoryexampleServiceCategory
http://hl7.org/fhir/ValueSet/service-category
from the FHIR Standard
HealthcareService.typerequiredLabelerBusinessOperations
http://hl7.org/fhir/us/spl/ValueSet/valueset-labelerBusinessOperations
from this IG
HealthcareService.specialtypreferredPracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
from the FHIR Standard
HealthcareService.serviceProvisionCoderequiredBusinessOperationQualifiers
http://hl7.org/fhir/us/spl/ValueSet/valueset-businessOperationQualifiers
from this IG
HealthcareService.eligibility.codeexample
HealthcareService.programexampleProgram
http://hl7.org/fhir/ValueSet/program
from the FHIR Standard
HealthcareService.characteristicexampleServiceMode
http://hl7.org/fhir/ValueSet/service-mode
from the FHIR Standard
HealthcareService.communicationrequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
HealthcareService.referralMethodexampleReferralMethod
http://hl7.org/fhir/ValueSet/service-referral-method
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorHealthcareServiceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorHealthcareServiceIf 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorHealthcareServiceIf 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-5errorHealthcareServiceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceHealthcareServiceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
spl-5.1.5.11errorHealthcareServiceIf operation is C43360, then qualifier is C106643, C131710, C131708, and/or C131709
: type.coding.where(code = 'C43360').exists() implies serviceProvisionCode.coding.select(code in ('C106643' | 'C131710' | 'C131708' | 'C131709')).allTrue()
spl-5.1.5.12errorHealthcareServiceIf operation is C73608, then qualifier is C111077 and/or C111078
: type.coding.where(code = 'C73608').exists() implies serviceProvisionCode.coding.select(code in ('C111077' | 'C111078')).allTrue()
spl-5.1.5.13errorHealthcareServiceIf operation is C112113, then qualifier is C112087, C112091, C112092, C112093, C112094 and/or C112095
: type.coding.where(code = 'C112113').exists() implies serviceProvisionCode.coding.select(code in ('C112087' | 'C112091' | 'C112092' | 'C112093' | 'C112094' | 'C112095')).allTrue()
spl-5.1.5.7errorHealthcareServiceQualifier is mandatory unless operation is analysis (C25391) or API manufacture (C82401)
: type.coding.where(code = 'C25391').exists() or type.coding.where(code = 'C82401').exists() or serviceProvisionCode.count() > 0

This structure is derived from HealthcareService

Summary

Mandatory: 2 elements
Must-Support: 3 elements

Structures

This structure refers to these other structures:

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron