Interweave Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions
Resource Profile: CareConnectHealthcareService1
| Official URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-HealthcareService-1 | Version: 0.1.0 | |||
| Draft as of 2018-09-27 | Computable Name: CareConnect-HealthcareService-1 | |||
Copyright/Legal: Copyright © 2018 NHS Digital |
||||
CareConnect HealthCareService Profile
NOT CURATED BY INTEROPen see: http://www.interopen.org/careconnect-curation-methodology/
Usage:
- Refer to this Resource Profile:
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from HealthcareService
This structure is derived from HealthcareService
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  HealthcareService | 0..* | HealthcareService | The details of a healthcare service available at a location | |
  identifier | 1..1 | Identifier | External identifiers for this item | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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: Common Languages (extensible): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional Content defined by implementations | |||||
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 1..1 | Identifier | External identifiers for this item | ||||
| active | ?!Σ | 0..1 | boolean | Whether this healthcareservice is in active use | ||||
 providedBy | Σ | 0..1 | Reference(Organization) | Organization that provides this service | ||||
| category | Σ | 0..1 | CodeableConcept | Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided. | ||||
| type | Σ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: ServiceType (example): Additional details about where the content was created (e.g. clinical specialty). | ||||
| specialty | Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: Practice Setting Code Value Set (preferred): A specialty that a healthcare service may provide. | ||||
| location | Σ | 0..* | Reference(Location) | Location(s) where service may be provided | ||||
| name | Σ | 0..1 | string | Description of service as presented to a consumer while searching | ||||
| comment | Σ | 0..1 | string | Additional description and/or any specific issues not covered elsewhere | ||||
| extraDetails | 0..1 | string | 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 inteded 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..1 | CodeableConcept | Specific eligibility requirements required to use the service Binding: (unbound) (example): Coded values underwhich a specific service is made available. | |||||
| eligibilityNote | 0..1 | string | Describes the eligibility conditions for the service | |||||
| programName | 0..* | string | Program Names that categorize the service | |||||
| characteristic | 0..* | CodeableConcept | Collection of characteristics (attributes) Binding: (unbound) (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | |||||
| 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 | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| 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 | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| description | 1..1 | string | Reason presented to the user explaining why time not available | |||||
| during | 0..1 | Period | Service not availablefrom this date | |||||
| availabilityExceptions | 0..1 | string | Description of availability exceptions | |||||
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location | |||||
| Documentation for this format | ||||||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| HealthcareService | 0..* | HealthcareService | The details of a healthcare service available at a location | |
| Documentation for this format | ||||
This structure is derived from HealthcareService
Differential View
This structure is derived from HealthcareService
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| HealthcareService | 0..* | HealthcareService | The details of a healthcare service available at a location | |
| identifier | 1..1 | Identifier | External identifiers for this item | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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: Common Languages (extensible): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 1..1 | Identifier | External identifiers for this item | ||||
| active | ?!Σ | 0..1 | boolean | Whether this healthcareservice is in active use | ||||
| providedBy | Σ | 0..1 | Reference(Organization) | Organization that provides this service | ||||
| category | Σ | 0..1 | CodeableConcept | Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided. | ||||
| type | Σ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: ServiceType (example): Additional details about where the content was created (e.g. clinical specialty). | ||||
| specialty | Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: Practice Setting Code Value Set (preferred): A specialty that a healthcare service may provide. | ||||
| location | Σ | 0..* | Reference(Location) | Location(s) where service may be provided | ||||
| name | Σ | 0..1 | string | Description of service as presented to a consumer while searching | ||||
| comment | Σ | 0..1 | string | Additional description and/or any specific issues not covered elsewhere | ||||
| extraDetails | 0..1 | string | 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 inteded 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..1 | CodeableConcept | Specific eligibility requirements required to use the service Binding: (unbound) (example): Coded values underwhich a specific service is made available. | |||||
| eligibilityNote | 0..1 | string | Describes the eligibility conditions for the service | |||||
| programName | 0..* | string | Program Names that categorize the service | |||||
| characteristic | 0..* | CodeableConcept | Collection of characteristics (attributes) Binding: (unbound) (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | |||||
| 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 | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| 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 | xml:id (or equivalent in JSON) | |||||
| extension | 0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| description | 1..1 | string | Reason presented to the user explaining why time not available | |||||
| during | 0..1 | Period | Service not availablefrom this date | |||||
| availabilityExceptions | 0..1 | string | Description of availability exceptions | |||||
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location | |||||
| Documentation for this format | ||||||||
Other representations of profile: CSV, Excel, Schematron
Terminology Bindings
| Path | Conformance | ValueSet |
| HealthcareService.language | extensible | Common Languages Max Binding: All Languages |
| HealthcareService.category | example | ServiceCategory |
| HealthcareService.type | example | ServiceType |
| HealthcareService.specialty | preferred | Practice Setting Code Value Set |
| HealthcareService.serviceProvisionCode | example | ServiceProvisionConditions |
| HealthcareService.eligibility | example | |
| HealthcareService.characteristic | example | |
| HealthcareService.referralMethod | example | ReferralMethod |
| HealthcareService.availableTime.daysOfWeek | required | DaysOfWeek |
Constraints
| Id | Grade | Path | Details | Requirements |
| dom-2 | error | HealthcareService | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-1 | error | HealthcareService | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.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-3 | error | HealthcareService | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
| ele-1 | error | HealthcareService.availableTime | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ele-1 | error | HealthcareService.notAvailable | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |