NHSDigital-HealthcareService
Conformance url | FHIR Module | Maturity Level |
---|---|---|
https://fhir.nhs.uk/StructureDefinition/NHSDigital-HealthcareService | Administration | trial-use |
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.
HealthcareService | HealthcareService | ||
identifier | S | 1.. | |
ersServiceId | S | ..1 | |
system | 1.. | Fixed Value | |
value | 1.. | ||
dosServiceId | S | ..1 | |
system | 1.. | Fixed Value | |
value | 1.. | ||
providedBy | S | Reference(NHSDigitalOrganization) | |
identifier | 1.. | ||
system | 1.. | Fixed Value | |
value | 1.. | ||
type | S | Binding | |
coding | |||
UKCoreCareSettingType | S | Binding | |
system | Fixed Value | ||
eRSAppointmentType | S | ||
system | Fixed Value | ||
specialty | S | ||
coding | |||
(All Slices) | |||
system | 1.. | ||
code | 1.. | ||
NHSDataDictionarySpecialty | S | Binding | |
system | Fixed Value | ||
SNOMEDPracticeCode | S | Binding | |
system | Fixed Value | ||
eRSSpecialty | S | Binding | |
system | Fixed Value | ||
location | S I | ..1 | Reference(NHSDigitalLocation) |
identifier | |||
system | 1.. | Fixed Value | |
value | 1.. | ||
name | S | 1.. | |
telecom | S | ||
value | 1.. | ||
use | 1.. | ||
serviceProvisionCode | S | ||
coding | |||
eRSClinicType | S | Binding | |
system | Fixed Value | ||
availableTime | S | ||
endpoint | S | ||
(All Slices) | |||
identifier | 1.. | ||
system | 1.. | ||
value | 1.. | ||
nhsMhsPartyKey | ..1 | ||
identifier | |||
system | Fixed Value | ||
nhsSpineASID | ..1 | ||
identifier | |||
system | Fixed Value |
HealthcareService | HealthcareService | ||
identifier | S | 1.. | |
ersServiceId | S | ..1 | |
system | 1.. | Fixed Value | |
value | 1.. | ||
dosServiceId | S | ..1 | |
system | 1.. | Fixed Value | |
value | 1.. | ||
providedBy | S | Reference(NHSDigitalOrganization) | |
identifier | 1.. | ||
system | 1.. | Fixed Value | |
value | 1.. | ||
type | S | Binding | |
coding | |||
UKCoreCareSettingType | S | Binding | |
system | Fixed Value | ||
eRSAppointmentType | S | ||
system | Fixed Value | ||
specialty | S | ||
coding | |||
(All Slices) | |||
system | 1.. | ||
code | 1.. | ||
NHSDataDictionarySpecialty | S | Binding | |
system | Fixed Value | ||
SNOMEDPracticeCode | S | Binding | |
system | Fixed Value | ||
eRSSpecialty | S | Binding | |
system | Fixed Value | ||
location | S I | ..1 | Reference(NHSDigitalLocation) |
identifier | |||
system | 1.. | Fixed Value | |
value | 1.. | ||
name | S | 1.. | |
telecom | S | ||
value | 1.. | ||
use | 1.. | ||
serviceProvisionCode | S | ||
coding | |||
eRSClinicType | S | Binding | |
system | Fixed Value | ||
availableTime | S | ||
endpoint | S | ||
(All Slices) | |||
identifier | 1.. | ||
system | 1.. | ||
value | 1.. | ||
nhsMhsPartyKey | ..1 | ||
identifier | |||
system | Fixed Value | ||
nhsSpineASID | ..1 | ||
identifier | |||
system | Fixed Value |
- Command 'pagelink' could not render: Page not found.
- Command 'pagelink' could not render: Page not found.
Constraint Profiles
Definition
The details of a healthcare service available at a location.
- identifier
- identifier:ersServiceId
- identifier:ersServiceId.system
- identifier:dosServiceId
- identifier:dosServiceId.system
- providedBy
- providedBy.identifier.system
- type
- type.coding:UKCoreCareSettingType
- type.coding:UKCoreCareSettingType.system
- type.coding:eRSAppointmentType
- type.coding:eRSAppointmentType.system
- specialty
- specialty.coding:NHSDataDictionarySpecialty
- specialty.coding:NHSDataDictionarySpecialty.system
- specialty.coding:SNOMEDPracticeCode
- specialty.coding:SNOMEDPracticeCode.system
- specialty.coding:eRSSpecialty
- specialty.coding:eRSSpecialty.system
- location
- location.identifier.system
- name
- telecom
- serviceProvisionCode
- serviceProvisionCode.coding:eRSClinicType
- serviceProvisionCode.coding:eRSClinicType.system
- availableTime
- endpoint
- endpoint:nhsMhsPartyKey
- endpoint:nhsMhsPartyKey.identifier.system
- endpoint:nhsSpineASID
- endpoint:nhsSpineASID.identifier.system
identifier
Element Id | HealthcareService.identifier |
Cardinality | 1..* |
Slicing | OPEN discriminator - VALUE system |
type | Identifier |
Definition
SHOULD contain the service identifier e.g. the serviceId from Directory of Service or e-RS Directory Services
MAY contain an ANANA/ODS code.
"identifier": [ { "use": "official", "system": "https://fhir.nhs.uk/Id/ers-service", "value": "11021" } ]
Comment
MUST contain an ANANA/ODS code.
identifier:ersServiceId
Element Id | HealthcareService.identifier:ersServiceId |
Cardinality | 0..1 |
Slice Name | ersServiceId |
type | Identifier |
Definition
External identifiers for this item.
identifier:ersServiceId.system
Element Id | HealthcareService.identifier:ersServiceId.system |
Cardinality | 1..1 |
Fixed Value | https://fhir.nhs.uk/Id/ers-service |
type | uri |
Definition
Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Requirements
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comment
Identifier.system is always case sensitive.
identifier:dosServiceId
Element Id | HealthcareService.identifier:dosServiceId |
Cardinality | 0..1 |
Slice Name | dosServiceId |
type | Identifier |
Definition
External identifiers for this item.
identifier:dosServiceId.system
Element Id | HealthcareService.identifier:dosServiceId.system |
Cardinality | 1..1 |
Fixed Value | http://fhir.nhs.uk/Id/dos-service-id |
type | uri |
Definition
Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Requirements
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comment
Identifier.system is always case sensitive.
providedBy
Element Id | HealthcareService.providedBy |
Cardinality | 0..1 |
type | Reference(NHSDigitalOrganization) |
Definition
It is recommended an identifier reference using ODS code is used.
"providedBy": { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-organization-code", "value": "RBA" }, "display": "TAUNTON AND SOMERSET NHS FOUNDATION TRUST" }
Comment
This property is recommended to be the same as the Location's managingOrganization, and if not provided should be interpreted as such. If the Location does not have a managing Organization, then this property should be populated.
providedBy.identifier.system
Element Id | HealthcareService.providedBy.identifier.system |
Cardinality | 1..1 |
Fixed Value | https://fhir.nhs.uk/Id/ods-organization-code |
type | uri |
Definition
Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Requirements
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comment
Identifier.system is always case sensitive.
type
Element Id | HealthcareService.type |
Cardinality | 0..* |
Terminology Binding | ServiceType (Preferred) |
type | CodeableConcept |
Definition
Type SHOULD be populated.
"type": [ { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/DoS-ClinicType", "code": "PHARMACY", "display": "Pharmacy" } ] } ],
or
"type": [ { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/eRS-AppointmentType", "code": "DAY_CASE", } ] } ],
type.coding:UKCoreCareSettingType
Element Id | HealthcareService.type.coding:UKCoreCareSettingType |
Cardinality | 0..* |
Terminology Binding | UKCoreCareSettingType (Preferred) |
Slice Name | UKCoreCareSettingType |
type | Coding |
Definition
A reference to a code defined by a terminology system.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
type.coding:UKCoreCareSettingType.system
Element Id | HealthcareService.type.coding:UKCoreCareSettingType.system |
Cardinality | 0..1 |
Fixed Value | http://snomed.info/sct |
type | uri |
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
type.coding:eRSAppointmentType
Element Id | HealthcareService.type.coding:eRSAppointmentType |
Cardinality | 0..* |
Slice Name | eRSAppointmentType |
type | Coding |
Definition
Appointment type e.g. telephone/video (only applicable and mandatory if Service Type is Appointment Request, not applicable to Service Type of Triage Request)
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
type.coding:eRSAppointmentType.system
Element Id | HealthcareService.type.coding:eRSAppointmentType.system |
Cardinality | 0..1 |
Fixed Value | https://fhir.nhs.uk/CodeSystem/eRS-AppointmentType |
type | uri |
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
specialty
Element Id | HealthcareService.specialty |
Cardinality | 0..* |
Terminology Binding | PracticeSettingCodeValueSet (Preferred) A specialty that a healthcare service may provide. |
type | CodeableConcept |
Definition
Specialty SHOULD be from the PracticeSettingCodeValueSet and is the SNOMED equivalent of the NHS Data Dictionary - Main Specialty and Treament Function Codes and FHIR
"specialty": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "394579002", "display": "Cardiology" } ] } ],
or using NHS Data Dictionary codes.
"specialty": [ { "coding": [ { "system": "https://fhir.nhs.uk/CodeSystem/NHSDataModelAndDictionary-clinical-specialty", "code": "320", "display": "Cardiology" } ] } ],
or for e-RS Patient Care
"specialty": [ { "coding": [ { "display": "Dermatology" } ] } ],
specialty.coding:NHSDataDictionarySpecialty
Element Id | HealthcareService.specialty.coding:NHSDataDictionarySpecialty |
Cardinality | 0..* |
Terminology Binding | NHSDataDictionaryMainClinicalSpecialty (Required) NHS Data Dictionary Specialty/Treatment Function Code |
Slice Name | NHSDataDictionarySpecialty |
type | Coding |
Definition
A reference to a code defined by a terminology system.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
specialty.coding:NHSDataDictionarySpecialty.system
Element Id | HealthcareService.specialty.coding:NHSDataDictionarySpecialty.system |
Cardinality | 0..1 |
Fixed Value | https://fhir.nhs.uk/CodeSystem/NHSDataModelAndDictionary-clinical-specialty |
type | uri |
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
specialty.coding:SNOMEDPracticeCode
Element Id | HealthcareService.specialty.coding:SNOMEDPracticeCode |
Cardinality | 0..* |
Terminology Binding | PracticeSettingCodeValueSet (Preferred) Specific specialty associated with the agency. |
Slice Name | SNOMEDPracticeCode |
type | Coding |
Definition
A reference to a code defined by a terminology system.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
specialty.coding:SNOMEDPracticeCode.system
Element Id | HealthcareService.specialty.coding:SNOMEDPracticeCode.system |
Cardinality | 0..1 |
Fixed Value | http://snomed.info/sct |
type | uri |
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
specialty.coding:eRSSpecialty
Element Id | HealthcareService.specialty.coding:eRSSpecialty |
Cardinality | 0..* |
Terminology Binding | NHSDigitaleRSSpecialty (Preferred) Specific specialty associated with the agency. |
Slice Name | eRSSpecialty |
type | Coding |
Definition
A reference to a code defined by a terminology system.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
specialty.coding:eRSSpecialty.system
Element Id | HealthcareService.specialty.coding:eRSSpecialty.system |
Cardinality | 0..1 |
Fixed Value | https://fhir.nhs.uk/CodeSystem/eRS-Specialty |
type | uri |
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
location
Element Id | HealthcareService.location |
Cardinality | 0..1 |
type | Reference(NHSDigitalLocation) |
Definition
Reference to a location. ODS codes may be used, however this may differ from Directory of Services and so DoS addresses are preferred.
"location": [ { "reference": "urn:uuid:8a5d7d67-64fb-44ec-9802-2dc214bb3dcb" } ],
or
"location": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/ods-site-code", "value": "R6901" } } ],
Constraints
- nhsd-8 (ERROR) location - An identifier reference or resource reference must be provided
location.identifier.system
Element Id | HealthcareService.location.identifier.system |
Cardinality | 1..1 |
Fixed Value | https://fhir.nhs.uk/Id/ods-site-code |
type | uri |
Definition
Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Requirements
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comment
Identifier.system is always case sensitive.
name
Element Id | HealthcareService.name |
Cardinality | 1..1 |
type | string |
Definition
Name of the clinic or service.
"name": "SOMERSET BOWEL CANCER SCREENING CENTRE",
telecom
Element Id | HealthcareService.telecom |
Cardinality | 0..* |
type | ContactPoint |
Definition
Contact details for the clinic or service.
"telecom": [ { "system": "phone", "value": "0113 922 4984", "use": "work" }, { "system": "email", "value": "directaddress@example.com", "use": "work" } ],
Comment
If this is empty, then refer to the location's contacts.
serviceProvisionCode
Element Id | HealthcareService.serviceProvisionCode |
Cardinality | 0..* |
Terminology Binding | ServiceProvisionConditions (Example) The code(s) that detail the conditions under which the healthcare service is available/offered. |
type | CodeableConcept |
Definition
The code(s) that detail the conditions under which the healthcare service is available/offered.
Comment
The provision means being commissioned by, contractually obliged or financially sourced. Types of costings that may apply to this healthcare service, such if the service may be available for free, some discounts available, or fees apply.
serviceProvisionCode.coding:eRSClinicType
Element Id | HealthcareService.serviceProvisionCode.coding:eRSClinicType |
Cardinality | 0..* |
Terminology Binding | ERSClinicType (Required) |
Slice Name | eRSClinicType |
type | Coding |
Definition
A reference to a code defined by a terminology system.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
serviceProvisionCode.coding:eRSClinicType.system
Element Id | HealthcareService.serviceProvisionCode.coding:eRSClinicType.system |
Cardinality | 0..1 |
Fixed Value | https://fhir.nhs.uk/CodeSystem/NHSDigital-ClinicType |
type | uri |
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
availableTime
Element Id | HealthcareService.availableTime |
Cardinality | 0..* |
type | BackboneElement |
Definition
Opening times for the clinic or service.
"availableTime": [ { "daysOfWeek": [ "wed" ], "allDay": true }, { "daysOfWeek": [ "mon", "tue", "wed", "thu" ], "availableStartTime": "08:30:00", "availableEndTime": "05:30:00" }, { "daysOfWeek": [ "sat", "fri" ], "availableStartTime": "09:30:00", "availableEndTime": "04:30:00" } ],
Comment
More detailed availability information may be provided in associated Schedule/Slot resources.
endpoint
Element Id | HealthcareService.endpoint |
Cardinality | 0..* |
Slicing | OPEN discriminator - VALUE identifier.system |
type | Reference(Endpoint) |
Definition
Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.
Endpoint identfiers to be used with the HealthcareService. Endpoints can be resolved using the SDS API
"endpoint": [ { "identifier": { "system": "https://fhir.nhs.uk/Id/nhsSpineASID", // or https://fhir.nhs.uk/Id/nhsMhsPartyKey "value": "999900000041" } } ]
endpoint:nhsMhsPartyKey
Element Id | HealthcareService.endpoint:nhsMhsPartyKey |
Cardinality | 0..1 |
Slice Name | nhsMhsPartyKey |
type | Reference(Endpoint) |
Definition
Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.
endpoint:nhsMhsPartyKey.identifier.system
Element Id | HealthcareService.endpoint:nhsMhsPartyKey.identifier.system |
Cardinality | 0..1 |
Fixed Value | https://fhir.nhs.uk/Id/nhsMhsPartyKey |
type | uri |
Definition
Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Requirements
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comment
Identifier.system is always case sensitive.
endpoint:nhsSpineASID
Element Id | HealthcareService.endpoint:nhsSpineASID |
Cardinality | 0..1 |
Slice Name | nhsSpineASID |
type | Reference(Endpoint) |
Definition
Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.
endpoint:nhsSpineASID.identifier.system
Element Id | HealthcareService.endpoint:nhsSpineASID.identifier.system |
Cardinality | 0..1 |
Fixed Value | https://fhir.nhs.uk/Id/nhsSpineASID |
type | uri |
Definition
Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Requirements
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Comment
Identifier.system is always case sensitive.