Care Coordination and 360 Referrals (Proof of Concept)
0.1.0 - proof-of-concept
Care Coordination and 360 Referrals (Proof of Concept)
0.1.0 - proof-of-concept
Care Coordination and 360 Referrals (Proof of Concept) - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir.acmeexample.org.uk/PatientCareCoordination/StructureDefinition/HealthcareService | Version: 0.1.0 | ||||
| Draft as of 2026-11-03 | Computable Name: HealthcareService | ||||
Care Directory - a service that patients can be referred to (the Referral Recipient),
provided by an organisation (ODS) at one or more locations. The master record is held in
a directory: the NHS England Directory of Services,
the eRS service catalogue, or a regional / local
directory. Follows IHE mCSD HealthcareService.
The service a patient is referred to - the Referral Recipient in
ServiceRequest.performer and Task.owner. Follows the
IHE mCSD HealthcareService; found with
Find Matching Care Services [ITI-90].
Services are a central record held in a directory. In England there are several, each for a part of the NHS - see Care Services Directory (mCSD).
| Element | Master record | NHS England API |
|---|---|---|
identifier, name, type, specialty, location, telecom, referralMethod, endpoint |
Directory of Services (DoS) | DoS Search API (FHIR R4) GET /HealthcareService - published, not yet available; UEC DoS SOAP / REST APIs (UEC / NHS 111) |
| eRS service ID and service details | eRS service catalogue | eRS FHIR API A033 / A035 GET /R4/HealthcareService, A010 service search (eRS only); identifier system http://fhir.nhs.net/Id/ers-service in the API examples |
providedBy (ODS code) |
ODS | See Organization |
endpoint |
DoS Endpoint; BaRS Endpoint Catalogue (BaRS only) |
DoS Search API _include / _revinclude Endpoint |
| Data Source (providers maintaining their services) | DoS | DoS Ingest API - mCSD Care Services Feed [ITI-130] |
The DoS Search API's HealthcareService uses NHS England code systems for type,
category and characteristic (e.g. https://fhir.nhs.uk/England/CodeSystem/England-HealthcareServiceType)
and identifies services by resource id; eRS uses its own. This profile does not fix
either - To confirm whether the DoS and eRS service identifiers should be sliced.
Equivalent FDP Canonical Data Model
(CDM) v1.0.0 objects: eRS Service
(properties not checked - To confirm). The CDM has no general service object; the
referral carries serviceId (eRS) and specialtyId.
The CDM is a downstream persistence model, used here as evidence of what NHS operations record, not as a design source. Mapping by property name - To confirm. See FDP Canonical Data Model Mapping for the full mapping.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  HealthcareService |
0..* | HealthcareService | The details of a healthcare service available at a location | |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
 identifier |
0..* | Identifier | Directory service ID, e.g. eRS service ID or DoS service ID (systems To confirm) | |
| active |
0..1 | boolean | Whether this HealthcareService record is in active use | |
  providedBy |
1..1 | Reference(Organization) | Organization that provides this service | |
  identifier |
0..1 | OrganisationCode | Logical reference, when literal reference is not known | |
| 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 |
0..* | CodeableConcept | What the service does, e.g. SNOMED CT procedure or regime / therapy Binding: ServiceType (example): Additional details about where the content was created (e.g. clinical specialty). | |
| specialty |
0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: Specialty (extensible) | |
| 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 | |
| telecom |
0..* | ContactPoint | Contacts related to the healthcare service | |
| coverageArea |
0..* | Reference(Location) | Location(s) service is intended for/available to | |
| 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 | |
| endpoint |
0..* | Reference(Endpoint) | Where referrals (PCC-55) are sent - see Find Matching Care Services [ITI-90] | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| HealthcareService.category | Base | example | Service category | 📍4.0.1 | FHIR Std. |
| HealthcareService.type | Base | example | Service type | 📍4.0.1 | FHIR Std. |
| HealthcareService.specialty | Base | extensible | Specialty | 📦0.1.0 | This IG |
| HealthcareService.referralMethod | Base | example | ReferralMethod | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | HealthcareService | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | HealthcareService | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | HealthcareService | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from HealthcareService
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| HealthcareService |
0..* | HealthcareService | The details of a healthcare service available at a location | |
 identifier |
0..* | Identifier | Directory service ID, e.g. eRS service ID or DoS service ID (systems To confirm) | |
| active |
0..1 | boolean | Whether this HealthcareService record is in active use | |
| providedBy |
1..1 | Reference(Organization) | Organization that provides this service | |
| identifier |
0..1 | OrganisationCode | Logical reference, when literal reference is not known | |
| category |
0..* | CodeableConcept | Broad category of service being performed or delivered | |
| type |
0..* | CodeableConcept | What the service does, e.g. SNOMED CT procedure or regime / therapy | |
| specialty |
0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: Specialty (extensible) | |
| 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 | |
| telecom |
0..* | ContactPoint | Contacts related to the healthcare service | |
| coverageArea |
0..* | Reference(Location) | Location(s) service is intended for/available to | |
| referralMethod |
0..* | CodeableConcept | Ways that the service accepts referrals | |
| appointmentRequired |
0..1 | boolean | If an appointment is required for access to this service | |
| endpoint |
0..* | Reference(Endpoint) | Where referrals (PCC-55) are sent - see Find Matching Care Services [ITI-90] | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| HealthcareService.specialty | Base | extensible | Specialty | 📦0.1.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| HealthcareService |
0..* | HealthcareService | The details of a healthcare service available at a location | |||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | Directory service ID, e.g. eRS service ID or DoS service ID (systems To confirm) | |||||
| active |
0..1 | boolean | Whether this HealthcareService record is in active use | |||||
| providedBy |
1..1 | Reference(Organization) | Organization that provides this service | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
| identifier |
0..1 | OrganisationCode | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for the resource | |||||
| 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 |
0..* | CodeableConcept | What the service does, e.g. SNOMED CT procedure or regime / therapy Binding: ServiceType (example): Additional details about where the content was created (e.g. clinical specialty). | |||||
| specialty |
0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: Specialty (extensible) | |||||
| 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 | string | Additional description and/or any specific issues not covered elsewhere | |||||
| extraDetails |
0..1 | markdown | Extra details about the service that can't be placed in the other fields | |||||
| photo |
0..1 | Attachment | Facilitates quick identification of the service | |||||
| telecom |
0..* | ContactPoint | Contacts related to the healthcare service | |||||
| coverageArea |
0..* | Reference(Location) | Location(s) service is intended for/available to | |||||
| serviceProvisionCode |
0..* | CodeableConcept | Conditions under which service is available/offered Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered. | |||||
| eligibility |
0..* | BackboneElement | Specific eligibility requirements required to use the service | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| code |
0..1 | CodeableConcept | Coded value for the eligibility Binding Description: (example): Coded values underwhich a specific service is made available. | |||||
| comment |
0..1 | markdown | Describes the eligibility conditions for the service | |||||
| program |
0..* | CodeableConcept | Programs that this service is applicable to Binding: Program (example): Government or local programs that this service applies to. | |||||
| characteristic |
0..* | CodeableConcept | Collection of characteristics (attributes) Binding Description: (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | |||||
| communication |
0..* | CodeableConcept | The language that this service is offered in Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 | |||||
| availableTime |
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 | 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 | |||||
| endpoint |
0..* | Reference(Endpoint) | Where referrals (PCC-55) are sent - see Find Matching Care Services [ITI-90] | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| HealthcareService.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| HealthcareService.providedBy.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| HealthcareService.category | Base | example | Service category | 📍4.0.1 | FHIR Std. |
| HealthcareService.type | Base | example | Service type | 📍4.0.1 | FHIR Std. |
| HealthcareService.specialty | Base | extensible | Specialty | 📦0.1.0 | This IG |
| HealthcareService.serviceProvisionCode | Base | example | ServiceProvisionConditions | 📍4.0.1 | FHIR Std. |
| HealthcareService.eligibility.code | Base | example | Not State | Unknown | |
| HealthcareService.program | Base | example | Program | 📍4.0.1 | FHIR Std. |
| HealthcareService.characteristic | Base | example | Not State | Unknown | |
| HealthcareService.communication | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| HealthcareService.referralMethod | Base | example | ReferralMethod | 📍4.0.1 | FHIR Std. |
| HealthcareService.availableTime.daysOfWeek | Base | required | DaysOfWeek | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | HealthcareService | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | HealthcareService | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | HealthcareService | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from HealthcareService
Summary
Mandatory: 1 element
Must-Support: 13 elements
Structures
This structure refers to these other structures:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| HealthcareService |
0..* | HealthcareService | The details of a healthcare service available at a location | |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| identifier |
0..* | Identifier | Directory service ID, e.g. eRS service ID or DoS service ID (systems To confirm) | |
| active |
0..1 | boolean | Whether this HealthcareService record is in active use | |
| providedBy |
1..1 | Reference(Organization) | Organization that provides this service | |
| identifier |
0..1 | OrganisationCode | Logical reference, when literal reference is not known | |
| 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 |
0..* | CodeableConcept | What the service does, e.g. SNOMED CT procedure or regime / therapy Binding: ServiceType (example): Additional details about where the content was created (e.g. clinical specialty). | |
| specialty |
0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: Specialty (extensible) | |
| 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 | |
| telecom |
0..* | ContactPoint | Contacts related to the healthcare service | |
| coverageArea |
0..* | Reference(Location) | Location(s) service is intended for/available to | |
| 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 | |
| endpoint |
0..* | Reference(Endpoint) | Where referrals (PCC-55) are sent - see Find Matching Care Services [ITI-90] | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| HealthcareService.category | Base | example | Service category | 📍4.0.1 | FHIR Std. |
| HealthcareService.type | Base | example | Service type | 📍4.0.1 | FHIR Std. |
| HealthcareService.specialty | Base | extensible | Specialty | 📦0.1.0 | This IG |
| HealthcareService.referralMethod | Base | example | ReferralMethod | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | HealthcareService | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | HealthcareService | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | HealthcareService | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from HealthcareService
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| HealthcareService |
0..* | HealthcareService | The details of a healthcare service available at a location | |
| identifier |
0..* | Identifier | Directory service ID, e.g. eRS service ID or DoS service ID (systems To confirm) | |
| active |
0..1 | boolean | Whether this HealthcareService record is in active use | |
| providedBy |
1..1 | Reference(Organization) | Organization that provides this service | |
| identifier |
0..1 | OrganisationCode | Logical reference, when literal reference is not known | |
| category |
0..* | CodeableConcept | Broad category of service being performed or delivered | |
| type |
0..* | CodeableConcept | What the service does, e.g. SNOMED CT procedure or regime / therapy | |
| specialty |
0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: Specialty (extensible) | |
| 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 | |
| telecom |
0..* | ContactPoint | Contacts related to the healthcare service | |
| coverageArea |
0..* | Reference(Location) | Location(s) service is intended for/available to | |
| referralMethod |
0..* | CodeableConcept | Ways that the service accepts referrals | |
| appointmentRequired |
0..1 | boolean | If an appointment is required for access to this service | |
| endpoint |
0..* | Reference(Endpoint) | Where referrals (PCC-55) are sent - see Find Matching Care Services [ITI-90] | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| HealthcareService.specialty | Base | extensible | Specialty | 📦0.1.0 | This IG |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| HealthcareService |
0..* | HealthcareService | The details of a healthcare service available at a location | |||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | Directory service ID, e.g. eRS service ID or DoS service ID (systems To confirm) | |||||
| active |
0..1 | boolean | Whether this HealthcareService record is in active use | |||||
| providedBy |
1..1 | Reference(Organization) | Organization that provides this service | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
| identifier |
0..1 | OrganisationCode | Logical reference, when literal reference is not known | |||||
| display |
0..1 | string | Text alternative for the resource | |||||
| 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 |
0..* | CodeableConcept | What the service does, e.g. SNOMED CT procedure or regime / therapy Binding: ServiceType (example): Additional details about where the content was created (e.g. clinical specialty). | |||||
| specialty |
0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: Specialty (extensible) | |||||
| 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 | string | Additional description and/or any specific issues not covered elsewhere | |||||
| extraDetails |
0..1 | markdown | Extra details about the service that can't be placed in the other fields | |||||
| photo |
0..1 | Attachment | Facilitates quick identification of the service | |||||
| telecom |
0..* | ContactPoint | Contacts related to the healthcare service | |||||
| coverageArea |
0..* | Reference(Location) | Location(s) service is intended for/available to | |||||
| serviceProvisionCode |
0..* | CodeableConcept | Conditions under which service is available/offered Binding: ServiceProvisionConditions (example): The code(s) that detail the conditions under which the healthcare service is available/offered. | |||||
| eligibility |
0..* | BackboneElement | Specific eligibility requirements required to use the service | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| code |
0..1 | CodeableConcept | Coded value for the eligibility Binding Description: (example): Coded values underwhich a specific service is made available. | |||||
| comment |
0..1 | markdown | Describes the eligibility conditions for the service | |||||
| program |
0..* | CodeableConcept | Programs that this service is applicable to Binding: Program (example): Government or local programs that this service applies to. | |||||
| characteristic |
0..* | CodeableConcept | Collection of characteristics (attributes) Binding Description: (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | |||||
| communication |
0..* | CodeableConcept | The language that this service is offered in Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 | |||||
| availableTime |
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 | 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 | |||||
| endpoint |
0..* | Reference(Endpoint) | Where referrals (PCC-55) are sent - see Find Matching Care Services [ITI-90] | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| HealthcareService.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| HealthcareService.providedBy.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| HealthcareService.category | Base | example | Service category | 📍4.0.1 | FHIR Std. |
| HealthcareService.type | Base | example | Service type | 📍4.0.1 | FHIR Std. |
| HealthcareService.specialty | Base | extensible | Specialty | 📦0.1.0 | This IG |
| HealthcareService.serviceProvisionCode | Base | example | ServiceProvisionConditions | 📍4.0.1 | FHIR Std. |
| HealthcareService.eligibility.code | Base | example | Not State | Unknown | |
| HealthcareService.program | Base | example | Program | 📍4.0.1 | FHIR Std. |
| HealthcareService.characteristic | Base | example | Not State | Unknown | |
| HealthcareService.communication | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| HealthcareService.referralMethod | Base | example | ReferralMethod | 📍4.0.1 | FHIR Std. |
| HealthcareService.availableTime.daysOfWeek | Base | required | DaysOfWeek | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | HealthcareService | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | HealthcareService | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | HealthcareService | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | HealthcareService | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from HealthcareService
Summary
Mandatory: 1 element
Must-Support: 13 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron