Interweave Implementation Guide
0.1.0 - ci-build United Kingdom flag

Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the STU3 profiles here.

Resource Profile: InterweaveHealthcareService

Official URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Interweave-HealthcareService Version: 0.0.1
Draft as of 2024-07-15 Computable Name: InterweaveHealthcareService

Interweave HealthcareService resource profile - DRAFT.

Status: DRAFT: For Review

Introduction

This profile sets minimum expectations for the HealthcareService resource. We use the HealthcareService structure definition as a base to this profile.

The HealthcareService resource is used to describe a single healthcare service or category of services that are provided by an organization at a location. The location of the services could be virtual, as with telemedicine services.

The HealthcareService resource can be used with the Schedule resource to define actual availability of the service.

Mandatory fields

The following mandatory fields are defined:

  1. Identifier - a Local Id must be provided, such that could be quoted if manually getting in touch to find out more. Although UKCore has marked this element as optional, the NHS BaRS application has marked this element as a MUST.

  2. Active - Essential if not active. Good practice to always populate anyway.

  3. Type - The type of service that may be delivered or performed (ideally this would be an identifiable service - which is at a location, rather than the location itself). We use the value set based on SNOMED refset 1127531000000102: Services Simple Reference Set - for consistency with the Encounter, and because it is more relevant than the default FHIR example and also covers social care.

  4. Name - The name of the Healthcare Serivice as presented to a consumer while searching.

Must Support fields

In addition the following fields are "Must Support" - ie they must be populated if relevant and known.

  1. Telecom - List of contacts related to this specific healthcare service, If this is empty, then refer to the location's contacts. Eg phone and/or email details. Useful for getting in contact for further information

  2. Appointment Required - Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this service.

  3. Coverage Area - The location(s) that this service is available to (not where the service is provided).

  4. Available Time - A collection of times that the Service Site is available. More detailed availability information may be provided in associated Schedule/Slot resources.

Optional fields

Other fields are optional and may be populated if known - on the understanding that not all data consumers will necessarily make use of them. Points of note include:

  • Category - A general description under broad categorisation of the types of services that is to be performed during this appointment.

  • Specialty - further information which may be useful about the type of specialty required. Knowing the Service Type is probably sufficient for a shared care record, with the Specialty being more relevant to resourcing the correct staff member in a scheduling system. However obviously useful additional information if available.

  • Location - the location provides essential information about where the service will take place. Exactly what is appropriate here will depend on the care setting:
    • For a hospital information should be provided down to the “clinic” level. Thus making it easir to find, as well as potentially giving some insight into the type of treatment being provided.
    • For other (smaller) locations then the "site" level may be sufficient
    • Other types of care (eg community, emergency) may take place at home or in a vehicle
  • comment - Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName.

  • Provided By - Organization that provides this service. Note: this will often be the same as the provenance of the message, but not necessarily if external locations are being referenced

  • Program - Programs that this service is applicable to. Programs are often defined externally to an Organization, commonly by governments; e.g. Home and Community Care Programs, Homeless Program etc. that this service applies to.

  • Characteristic - Collection of characteristics such things as 'is wheelchair accessible'. at the time of writing, the current FHIR standards does not have approved valueSet binding for this element, please get in touch with possible values, so that we can create custom valueSet / use local valueSet.

  • Referral Method - The methods of referral can be used when referring to a specific HealthcareService resource.

  • Availability Exceptions - A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times.

Discouraged or Removed fields

  • extraDetails - REMOVED. Extra details about the service that can't be placed in the other fields.

  • Photo - REMOVED. Not relevant here, and adds size and complexity to the content.

  • Service Provision Code - DISCOURAGED. The code(s) that detail the conditions under which the healthcare service is available/offered.

  • Eligibility - REMOVED. Does this service have specific eligibility requirements that need to be met in order to use the service.

  • Eligibility Note - REMOVED. Describes the eligibility conditions for the service. Inline with R4 we have also removed this element.

  • Communication - DISCOURAGED. Some services are specifically made available in multiple languages, this property permits a directory to declare the languages this is offered in. Typically this is only provided where a service operates in communities with mixed languages used. Not relevant to current use-cases within the Shared care record.

  • notAvailable - DISCOURAGED. The HealthcareService is not available during this period of time due to the provided reason..

  • Endpoint - REMOVED. Technical endpoints are captured elsewhere (ie via the Participant Registry)

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from UKCoreHealthcareService

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..* UKCoreHealthcareService The details of a healthcare service available at a location
... id S 0..1 id Logical id of this artifact
... meta
.... id 0..0
.... versionId S 0..1 id Version specific identifier
.... lastUpdated S 0..1 instant MANDATORY except in Contained Resources. When the resource version last changed.
.... profile S 0..* canonical(StructureDefinition) Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
.... security 0..* Coding DISCOURAGED - may not be honoured by Data Consumers
.... Slices for tag 0..* Coding Tags applied to this resource
Slice: Unordered, Open by value:system
..... tag:Source S 0..1 Coding MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
...... id 0..0
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
...... version 0..0
...... code S 1..1 code The Data Provider Id of the system supplying the data
...... display S 1..1 string Name of the system supplying the data
..... tag:Provenance S 0..1 Coding MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
...... id 0..0
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
...... version 0..0
...... code S 1..1 code The ODS Code of the organisation responsible for the data
...... display S 1..1 string Name of the organisation supplying the data
... implicitRules 0..1 uri DISCOURAGED - may not be honoured by Data Consumers
... text 0..1 Narrative DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... identifier 1..1 Identifier External identifiers for this item
.... assigner 0..1 Reference(InterweaveOrganization) Organization that issued id (may be just text)
... active S 1..1 boolean Whether this HealthcareService record is in active use
... providedBy 0..1 Reference(InterweaveOrganization) The organization that provides this healthcare service.
... category 0..* CodeableConcept Broad category of service being performed or delivered
Binding: ServiceCategory (preferred)
... type 1..* CodeableConcept The type of service provided by this healthcare service.
Binding: UK Core Care Setting Type (preferred)
.... coding
..... system 1..1 uri Identity of the terminology system
..... code 1..1 code Symbol in syntax defined by the system
..... display 1..1 string Representation defined by the system
... location 0..* Reference(InterweaveLocation) Location(s) where service may be provided
... name S 1..1 string Description of service as presented to a consumer while searching
... extraDetails 0..0
... photo 0..0
... telecom S 0..* ContactPoint Contacts related to the healthcare service
... coverageArea S 0..* Reference(InterweaveLocation) Location(s) service is intended for/available to
... serviceProvisionCode 0..* CodeableConcept DISCOURAGED - Conditions under which service is available/offered
Binding: ServiceProvisionConditions (preferred)
... eligibility 0..0
... program 0..* CodeableConcept Programs that this service is applicable to
Binding: Program (preferred)
... communication 0..* CodeableConcept DISCOURAGED - The language that this service is offered in.
... referralMethod 0..* CodeableConcept Ways that the service accepts referrals
Binding: InterweaveReferralRequestMethod (preferred)
... 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
... notAvailable 0..* BackboneElement DISCOURAGED - Not available during this time due to provided reason
... endpoint 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
HealthcareService.categorypreferredServiceCategory
http://hl7.org/fhir/ValueSet/service-category
from the FHIR Standard
HealthcareService.typepreferredUKCoreCareSettingType
https://fhir.hl7.org.uk/ValueSet/UKCore-CareSettingType
from this IG
HealthcareService.serviceProvisionCodepreferredServiceProvisionConditions
http://hl7.org/fhir/ValueSet/service-provision-conditions
from the FHIR Standard
HealthcareService.programpreferredProgram
http://hl7.org/fhir/ValueSet/program
from the FHIR Standard
HealthcareService.referralMethodpreferredInterweaveReferralRequestMethod
https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-ReferralRequestMethod
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..* UKCoreHealthcareService The details of a healthcare service available at a location
... id SΣ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... versionId SΣ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant MANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
.... security Σ 0..* Coding DISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... Slices for tag Σ 0..* Coding Tags applied to this resource
Slice: Unordered, Open by value:system
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


..... tag:Source SΣ 0..1 Coding MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
...... code SΣ 1..1 code The Data Provider Id of the system supplying the data
...... display SΣ 1..1 string Name of the system supplying the data
..... tag:Provenance SΣ 0..1 Coding MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
...... code SΣ 1..1 code The ODS Code of the organisation responsible for the data
...... display SΣ 1..1 string Name of the organisation supplying the data
... implicitRules ?!Σ 0..1 uri DISCOURAGED - may not be honoured by Data Consumers
... text 0..1 Narrative DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..1 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 .

.... assigner Σ 0..1 Reference(InterweaveOrganization) Organization that issued id (may be just text)
... active ?!SΣ 1..1 boolean Whether this HealthcareService record is in active use
... providedBy SΣ 0..1 Reference(InterweaveOrganization) The organization that provides this healthcare service.
... category Σ 0..* CodeableConcept Broad category of service being performed or delivered
Binding: ServiceCategory (preferred)
... type SΣ 1..* CodeableConcept The type of service provided by this healthcare service.
Binding: UK Core Care Setting Type (preferred)
... location Σ 0..* Reference(InterweaveLocation) Location(s) where service may be provided
... name SΣ 1..1 string Description of service as presented to a consumer while searching
... telecom S 0..* ContactPoint Contacts related to the healthcare service
... coverageArea S 0..* Reference(InterweaveLocation) Location(s) service is intended for/available to
... serviceProvisionCode 0..* CodeableConcept DISCOURAGED - Conditions under which service is available/offered
Binding: ServiceProvisionConditions (preferred)
... program 0..* CodeableConcept Programs that this service is applicable to
Binding: Program (preferred)
... communication 0..* CodeableConcept DISCOURAGED - The language that this service is offered in.
Binding: AllLanguages (required): A ValueSet that identifies the language used by a person.


... referralMethod 0..* CodeableConcept Ways that the service accepts referrals
Binding: InterweaveReferralRequestMethod (preferred)
... 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
... notAvailable 0..* BackboneElement DISCOURAGED - Not available during this time due to provided reason
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... description 1..1 string Reason presented to the user explaining why time not available

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
HealthcareService.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
HealthcareService.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
HealthcareService.meta.tag:SourceexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
HealthcareService.meta.tag:ProvenanceexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
HealthcareService.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
HealthcareService.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
HealthcareService.categorypreferredServiceCategory
http://hl7.org/fhir/ValueSet/service-category
from the FHIR Standard
HealthcareService.typepreferredUKCoreCareSettingType
https://fhir.hl7.org.uk/ValueSet/UKCore-CareSettingType
from this IG
HealthcareService.serviceProvisionCodepreferredServiceProvisionConditions
http://hl7.org/fhir/ValueSet/service-provision-conditions
from the FHIR Standard
HealthcareService.programpreferredProgram
http://hl7.org/fhir/ValueSet/program
from the FHIR Standard
HealthcareService.communicationrequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages
HealthcareService.referralMethodpreferredInterweaveReferralRequestMethod
https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-ReferralRequestMethod
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().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-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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..* UKCoreHealthcareService The details of a healthcare service available at a location
... id SΣ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant MANDATORY except in Contained Resources. When the resource version last changed.
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile SΣ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
.... security Σ 0..* Coding DISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... Slices for tag Σ 0..* Coding Tags applied to this resource
Slice: Unordered, Open by value:system
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


..... tag:Source SΣ 0..1 Coding MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
...... code SΣ 1..1 code The Data Provider Id of the system supplying the data
...... display SΣ 1..1 string Name of the system supplying the data
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... tag:Provenance SΣ 0..1 Coding MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
...... code SΣ 1..1 code The ODS Code of the organisation responsible for the data
...... display SΣ 1..1 string Name of the organisation supplying the data
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... implicitRules ?!Σ 0..1 uri DISCOURAGED - may not be honoured by Data Consumers
... language 0..1 code English is assumed (not currently a multi-lingual implementation)
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..1 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 Σ 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 Σ 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(InterweaveOrganization) Organization that issued id (may be just text)
... active ?!SΣ 1..1 boolean Whether this HealthcareService record is in active use
... providedBy SΣ 0..1 Reference(InterweaveOrganization) The organization that provides this healthcare service.
... category Σ 0..* CodeableConcept Broad category of service being performed or delivered
Binding: ServiceCategory (preferred)
... type SΣ 1..* CodeableConcept The type of service provided by this healthcare service.
Binding: UK Core Care Setting Type (preferred)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
..... display Σ 1..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... specialty Σ 0..* CodeableConcept Specialties handled by the HealthcareService
Binding: UK Core Practice Setting Code (extensible)
... location Σ 0..* Reference(InterweaveLocation) Location(s) where service may be provided
... name SΣ 1..1 string Description of service as presented to a consumer while searching
... comment Σ 0..1 string Additional description and/or any specific issues not covered elsewhere
... telecom S 0..* ContactPoint Contacts related to the healthcare service
... coverageArea S 0..* Reference(InterweaveLocation) Location(s) service is intended for/available to
... serviceProvisionCode 0..* CodeableConcept DISCOURAGED - Conditions under which service is available/offered
Binding: ServiceProvisionConditions (preferred)
... program 0..* CodeableConcept Programs that this service is applicable to
Binding: Program (preferred)
... characteristic 0..* CodeableConcept Collection of characteristics (attributes)
Binding: (unbound) (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).


... communication 0..* CodeableConcept DISCOURAGED - The language that this service is offered in.
Binding: AllLanguages (required): A ValueSet that identifies the language used by a person.


... referralMethod 0..* CodeableConcept Ways that the service accepts referrals
Binding: InterweaveReferralRequestMethod (preferred)
... 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 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1 boolean Always available? e.g. 24 hour service
.... availableStartTime 0..1 time Opening time of day (ignored if allDay = true)
.... availableEndTime 0..1 time Closing time of day (ignored if allDay = true)
... notAvailable 0..* BackboneElement DISCOURAGED - 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 1..1 string Reason presented to the user explaining why time not available
.... during 0..1 Period Service not available from this date
... availabilityExceptions 0..1 string Description of availability exceptions

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
HealthcareService.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
HealthcareService.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
HealthcareService.meta.tag:SourceexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
HealthcareService.meta.tag:ProvenanceexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
HealthcareService.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
HealthcareService.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
HealthcareService.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
HealthcareService.categorypreferredServiceCategory
http://hl7.org/fhir/ValueSet/service-category
from the FHIR Standard
HealthcareService.typepreferredUKCoreCareSettingType
https://fhir.hl7.org.uk/ValueSet/UKCore-CareSettingType
from this IG
HealthcareService.specialtyextensibleUKCorePracticeSettingCode (a valid code from UKCore Practice Setting Code)
https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode
from this IG
HealthcareService.serviceProvisionCodepreferredServiceProvisionConditions
http://hl7.org/fhir/ValueSet/service-provision-conditions
from the FHIR Standard
HealthcareService.eligibility.codeexample
HealthcareService.programpreferredProgram
http://hl7.org/fhir/ValueSet/program
from the FHIR Standard
HealthcareService.characteristicexample
HealthcareService.communicationrequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages
HealthcareService.referralMethodpreferredInterweaveReferralRequestMethod
https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-ReferralRequestMethod
from this IG
HealthcareService.availableTime.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
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().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-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()

This structure is derived from UKCoreHealthcareService

Summary

Mandatory: 4 elements(9 nested mandatory elements)
Must-Support: 16 elements
Fixed: 2 elements
Prohibited: 9 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

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

Differential View

This structure is derived from UKCoreHealthcareService

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..* UKCoreHealthcareService The details of a healthcare service available at a location
... id S 0..1 id Logical id of this artifact
... meta
.... id 0..0
.... versionId S 0..1 id Version specific identifier
.... lastUpdated S 0..1 instant MANDATORY except in Contained Resources. When the resource version last changed.
.... profile S 0..* canonical(StructureDefinition) Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
.... security 0..* Coding DISCOURAGED - may not be honoured by Data Consumers
.... Slices for tag 0..* Coding Tags applied to this resource
Slice: Unordered, Open by value:system
..... tag:Source S 0..1 Coding MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
...... id 0..0
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
...... version 0..0
...... code S 1..1 code The Data Provider Id of the system supplying the data
...... display S 1..1 string Name of the system supplying the data
..... tag:Provenance S 0..1 Coding MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
...... id 0..0
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
...... version 0..0
...... code S 1..1 code The ODS Code of the organisation responsible for the data
...... display S 1..1 string Name of the organisation supplying the data
... implicitRules 0..1 uri DISCOURAGED - may not be honoured by Data Consumers
... text 0..1 Narrative DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... identifier 1..1 Identifier External identifiers for this item
.... assigner 0..1 Reference(InterweaveOrganization) Organization that issued id (may be just text)
... active S 1..1 boolean Whether this HealthcareService record is in active use
... providedBy 0..1 Reference(InterweaveOrganization) The organization that provides this healthcare service.
... category 0..* CodeableConcept Broad category of service being performed or delivered
Binding: ServiceCategory (preferred)
... type 1..* CodeableConcept The type of service provided by this healthcare service.
Binding: UK Core Care Setting Type (preferred)
.... coding
..... system 1..1 uri Identity of the terminology system
..... code 1..1 code Symbol in syntax defined by the system
..... display 1..1 string Representation defined by the system
... location 0..* Reference(InterweaveLocation) Location(s) where service may be provided
... name S 1..1 string Description of service as presented to a consumer while searching
... extraDetails 0..0
... photo 0..0
... telecom S 0..* ContactPoint Contacts related to the healthcare service
... coverageArea S 0..* Reference(InterweaveLocation) Location(s) service is intended for/available to
... serviceProvisionCode 0..* CodeableConcept DISCOURAGED - Conditions under which service is available/offered
Binding: ServiceProvisionConditions (preferred)
... eligibility 0..0
... program 0..* CodeableConcept Programs that this service is applicable to
Binding: Program (preferred)
... communication 0..* CodeableConcept DISCOURAGED - The language that this service is offered in.
... referralMethod 0..* CodeableConcept Ways that the service accepts referrals
Binding: InterweaveReferralRequestMethod (preferred)
... 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
... notAvailable 0..* BackboneElement DISCOURAGED - Not available during this time due to provided reason
... endpoint 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
HealthcareService.categorypreferredServiceCategory
http://hl7.org/fhir/ValueSet/service-category
from the FHIR Standard
HealthcareService.typepreferredUKCoreCareSettingType
https://fhir.hl7.org.uk/ValueSet/UKCore-CareSettingType
from this IG
HealthcareService.serviceProvisionCodepreferredServiceProvisionConditions
http://hl7.org/fhir/ValueSet/service-provision-conditions
from the FHIR Standard
HealthcareService.programpreferredProgram
http://hl7.org/fhir/ValueSet/program
from the FHIR Standard
HealthcareService.referralMethodpreferredInterweaveReferralRequestMethod
https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-ReferralRequestMethod
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..* UKCoreHealthcareService The details of a healthcare service available at a location
... id SΣ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... versionId SΣ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant MANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
.... security Σ 0..* Coding DISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... Slices for tag Σ 0..* Coding Tags applied to this resource
Slice: Unordered, Open by value:system
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


..... tag:Source SΣ 0..1 Coding MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
...... code SΣ 1..1 code The Data Provider Id of the system supplying the data
...... display SΣ 1..1 string Name of the system supplying the data
..... tag:Provenance SΣ 0..1 Coding MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
...... code SΣ 1..1 code The ODS Code of the organisation responsible for the data
...... display SΣ 1..1 string Name of the organisation supplying the data
... implicitRules ?!Σ 0..1 uri DISCOURAGED - may not be honoured by Data Consumers
... text 0..1 Narrative DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..1 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 .

.... assigner Σ 0..1 Reference(InterweaveOrganization) Organization that issued id (may be just text)
... active ?!SΣ 1..1 boolean Whether this HealthcareService record is in active use
... providedBy SΣ 0..1 Reference(InterweaveOrganization) The organization that provides this healthcare service.
... category Σ 0..* CodeableConcept Broad category of service being performed or delivered
Binding: ServiceCategory (preferred)
... type SΣ 1..* CodeableConcept The type of service provided by this healthcare service.
Binding: UK Core Care Setting Type (preferred)
... location Σ 0..* Reference(InterweaveLocation) Location(s) where service may be provided
... name SΣ 1..1 string Description of service as presented to a consumer while searching
... telecom S 0..* ContactPoint Contacts related to the healthcare service
... coverageArea S 0..* Reference(InterweaveLocation) Location(s) service is intended for/available to
... serviceProvisionCode 0..* CodeableConcept DISCOURAGED - Conditions under which service is available/offered
Binding: ServiceProvisionConditions (preferred)
... program 0..* CodeableConcept Programs that this service is applicable to
Binding: Program (preferred)
... communication 0..* CodeableConcept DISCOURAGED - The language that this service is offered in.
Binding: AllLanguages (required): A ValueSet that identifies the language used by a person.


... referralMethod 0..* CodeableConcept Ways that the service accepts referrals
Binding: InterweaveReferralRequestMethod (preferred)
... 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
... notAvailable 0..* BackboneElement DISCOURAGED - Not available during this time due to provided reason
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... description 1..1 string Reason presented to the user explaining why time not available

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
HealthcareService.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
HealthcareService.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
HealthcareService.meta.tag:SourceexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
HealthcareService.meta.tag:ProvenanceexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
HealthcareService.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
HealthcareService.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
HealthcareService.categorypreferredServiceCategory
http://hl7.org/fhir/ValueSet/service-category
from the FHIR Standard
HealthcareService.typepreferredUKCoreCareSettingType
https://fhir.hl7.org.uk/ValueSet/UKCore-CareSettingType
from this IG
HealthcareService.serviceProvisionCodepreferredServiceProvisionConditions
http://hl7.org/fhir/ValueSet/service-provision-conditions
from the FHIR Standard
HealthcareService.programpreferredProgram
http://hl7.org/fhir/ValueSet/program
from the FHIR Standard
HealthcareService.communicationrequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages
HealthcareService.referralMethodpreferredInterweaveReferralRequestMethod
https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-ReferralRequestMethod
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().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-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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. HealthcareService 0..* UKCoreHealthcareService The details of a healthcare service available at a location
... id SΣ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ 0..1 id Version specific identifier
.... lastUpdated SΣ 0..1 instant MANDATORY except in Contained Resources. When the resource version last changed.
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile SΣ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
.... security Σ 0..* Coding DISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... Slices for tag Σ 0..* Coding Tags applied to this resource
Slice: Unordered, Open by value:system
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


..... tag:Source SΣ 0..1 Coding MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
...... code SΣ 1..1 code The Data Provider Id of the system supplying the data
...... display SΣ 1..1 string Name of the system supplying the data
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... tag:Provenance SΣ 0..1 Coding MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
...... code SΣ 1..1 code The ODS Code of the organisation responsible for the data
...... display SΣ 1..1 string Name of the organisation supplying the data
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... implicitRules ?!Σ 0..1 uri DISCOURAGED - may not be honoured by Data Consumers
... language 0..1 code English is assumed (not currently a multi-lingual implementation)
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..1 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 Σ 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 Σ 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(InterweaveOrganization) Organization that issued id (may be just text)
... active ?!SΣ 1..1 boolean Whether this HealthcareService record is in active use
... providedBy SΣ 0..1 Reference(InterweaveOrganization) The organization that provides this healthcare service.
... category Σ 0..* CodeableConcept Broad category of service being performed or delivered
Binding: ServiceCategory (preferred)
... type SΣ 1..* CodeableConcept The type of service provided by this healthcare service.
Binding: UK Core Care Setting Type (preferred)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
..... display Σ 1..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... specialty Σ 0..* CodeableConcept Specialties handled by the HealthcareService
Binding: UK Core Practice Setting Code (extensible)
... location Σ 0..* Reference(InterweaveLocation) Location(s) where service may be provided
... name SΣ 1..1 string Description of service as presented to a consumer while searching
... comment Σ 0..1 string Additional description and/or any specific issues not covered elsewhere
... telecom S 0..* ContactPoint Contacts related to the healthcare service
... coverageArea S 0..* Reference(InterweaveLocation) Location(s) service is intended for/available to
... serviceProvisionCode 0..* CodeableConcept DISCOURAGED - Conditions under which service is available/offered
Binding: ServiceProvisionConditions (preferred)
... program 0..* CodeableConcept Programs that this service is applicable to
Binding: Program (preferred)
... characteristic 0..* CodeableConcept Collection of characteristics (attributes)
Binding: (unbound) (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).


... communication 0..* CodeableConcept DISCOURAGED - The language that this service is offered in.
Binding: AllLanguages (required): A ValueSet that identifies the language used by a person.


... referralMethod 0..* CodeableConcept Ways that the service accepts referrals
Binding: InterweaveReferralRequestMethod (preferred)
... 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 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1 boolean Always available? e.g. 24 hour service
.... availableStartTime 0..1 time Opening time of day (ignored if allDay = true)
.... availableEndTime 0..1 time Closing time of day (ignored if allDay = true)
... notAvailable 0..* BackboneElement DISCOURAGED - 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 1..1 string Reason presented to the user explaining why time not available
.... during 0..1 Period Service not available from this date
... availabilityExceptions 0..1 string Description of availability exceptions

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
HealthcareService.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
HealthcareService.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
HealthcareService.meta.tag:SourceexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
HealthcareService.meta.tag:ProvenanceexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
HealthcareService.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
HealthcareService.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
HealthcareService.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
HealthcareService.categorypreferredServiceCategory
http://hl7.org/fhir/ValueSet/service-category
from the FHIR Standard
HealthcareService.typepreferredUKCoreCareSettingType
https://fhir.hl7.org.uk/ValueSet/UKCore-CareSettingType
from this IG
HealthcareService.specialtyextensibleUKCorePracticeSettingCode (a valid code from UKCore Practice Setting Code)
https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode
from this IG
HealthcareService.serviceProvisionCodepreferredServiceProvisionConditions
http://hl7.org/fhir/ValueSet/service-provision-conditions
from the FHIR Standard
HealthcareService.eligibility.codeexample
HealthcareService.programpreferredProgram
http://hl7.org/fhir/ValueSet/program
from the FHIR Standard
HealthcareService.characteristicexample
HealthcareService.communicationrequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages
HealthcareService.referralMethodpreferredInterweaveReferralRequestMethod
https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-ReferralRequestMethod
from this IG
HealthcareService.availableTime.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
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().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-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()

This structure is derived from UKCoreHealthcareService

Summary

Mandatory: 4 elements(9 nested mandatory elements)
Must-Support: 16 elements
Fixed: 2 elements
Prohibited: 9 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Differences between Interweave STU3 and R4 profiles

Element name Change details
extension:program
  • Deleted (added as normal element)
category
  • Max Cardinality changed from 1 to *
type
  • Change valueSet from https://fhir.yhcr.nhs.uk/ValueSet/Interweave-UkCoreCareSettingType to https://fhir.hl7.org.uk/ValueSet/UKCore-CareSettingType
specialty
  • Change valueSet from https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-SDSJobRoleName-1 to https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode
program
  • Added Element
referralMethod
  • Change valueSet from https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-ReferralRequestMethod-1 to https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-ReferralRequestMethod