INTEROPen CareConnect Base STU3 Implementation Guide
3.0.0 - CI Build
INTEROPen CareConnect Base STU3 Implementation Guide - Local Development build (v3.0.0). See the Directory of published versions
CareConnect HealthCareService Profile
The official URL for this profile is:
https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-HealthcareService-1
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 | I | 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) Max Binding: All Languages | |
text | I | 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) |
type | Σ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: ServiceType (example) |
specialty | Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: Practice Setting Code Value Set (preferred) |
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) | |
eligibility | 0..1 | CodeableConcept | Specific eligibility requirements required to use the service Binding: (unbound) (example) | |
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) | |
referralMethod | 0..* | CodeableConcept | Ways that the service accepts referrals Binding: ReferralMethod (example) | |
appointmentRequired | 0..1 | boolean | If an appointment is required for access to this service | |
availableTime | I | 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) | |
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 | I | 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 |
This structure is derived from HealthcareService
Differential View
This structure is derived from HealthcareService
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
HealthcareService | I | 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) Max Binding: All Languages | |
text | I | 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) |
type | Σ | 0..* | CodeableConcept | Type of service that may be delivered or performed Binding: ServiceType (example) |
specialty | Σ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: Practice Setting Code Value Set (preferred) |
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) | |
eligibility | 0..1 | CodeableConcept | Specific eligibility requirements required to use the service Binding: (unbound) (example) | |
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) | |
referralMethod | 0..* | CodeableConcept | Ways that the service accepts referrals Binding: ReferralMethod (example) | |
appointmentRequired | 0..1 | boolean | If an appointment is required for access to this service | |
availableTime | I | 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) | |
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 | I | 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: Schematron
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 |
Id | Path | Details | Requirements |
dom-2 | HealthcareService | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-1 | HealthcareService | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-4 | 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 | 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 | HealthcareService.availableTime | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ele-1 | HealthcareService.notAvailable | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |