Estonian Base Implementation Guide
1.0.0 - ballot
Estonian Base Implementation Guide
1.0.0 - ballot
Estonian Base Implementation Guide - Local Development build (v1.0.0). See the Directory of published versions
| Official URL: https://fhir.ee/StructureDefinition/ee-healthcare-service | Version: 1.0.0 | |||
| Draft as of 2023-05-29 | Computable Name: EEBaseHealthcareService | |||
HealthcareService resource describes the details of 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.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
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 | |
  providedBy | S | 0..1 | Reference(EEBase Organization) | Organization that provides this service |
 category | S | 0..* | CodeableConcept | Broad category of service being performed or delivered |
| specialty | S | 0..* | CodeableConcept | Specialties handled by the HealthcareService |
| location | 0..* | Reference(EEBase Location) | Location(s) where service may be provided | |
 coverageArea | 0..* | Reference(EEBase Location) | Location(s) service is intended for/available to | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 |
| contained | 0..* | Resource | Contained, inline Resources | |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| active | ?!Σ | 0..1 | boolean | Whether this HealthcareService record is in active use |
| providedBy | SΣ | 0..1 | Reference(EEBase Organization) | Organization that provides this service |
 category | SΣ | 0..* | CodeableConcept | Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided. |
| specialty | SΣ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide. |
| location | Σ | 0..* | Reference(EEBase Location) | Location(s) where service may be provided |
| coverageArea | 0..* | Reference(EEBase Location) | Location(s) service is intended for/available to | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| HealthcareService.category | example | ServiceCategory |
| HealthcareService.specialty | preferred | PracticeSettingCodeValueSet |
| Id | Grade | Path(s) | Details | Requirements |
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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() |
| 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: AllLanguages (required): IETF language tag for 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 | Σ | 0..* | Identifier | External identifiers for this item |
| active | ?!Σ | 0..1 | boolean | Whether this HealthcareService record is in active use |
| providedBy | SΣ | 0..1 | Reference(EEBase Organization) | Organization that provides this service |
| offeredIn | 0..* | Reference(HealthcareService) | The service within which this service is offered | |
| category | SΣ | 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 | 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 | SΣ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide. |
| location | Σ | 0..* | Reference(EEBase 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 | markdown | 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 |
| contact | 0..* | ExtendedContactDetail | Official contact details for the HealthcareService | |
| coverageArea | 0..* | Reference(EEBase 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: (unbound) (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: ServiceMode (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibility). | |
| communication | 0..* | CodeableConcept | The language that this service is offered in Binding: AllLanguages (required): IETF language tag for 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 | |
| availability | 0..* | Availability | Times the healthcare service is available (including exceptions) | |
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| HealthcareService.language | required | AllLanguages |
| HealthcareService.category | example | ServiceCategory |
| HealthcareService.type | example | ServiceType |
| HealthcareService.specialty | preferred | PracticeSettingCodeValueSet |
| HealthcareService.serviceProvisionCode | example | ServiceProvisionConditions |
| HealthcareService.eligibility.code | example | |
| HealthcareService.program | example | Program |
| HealthcareService.characteristic | example | ServiceMode |
| HealthcareService.communication | required | AllLanguages |
| HealthcareService.referralMethod | example | ReferralMethod |
| Id | Grade | Path(s) | Details | Requirements |
| 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
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 | |
| providedBy | S | 0..1 | Reference(EEBase Organization) | Organization that provides this service |
| category | S | 0..* | CodeableConcept | Broad category of service being performed or delivered |
| specialty | S | 0..* | CodeableConcept | Specialties handled by the HealthcareService |
| location | 0..* | Reference(EEBase Location) | Location(s) where service may be provided | |
| coverageArea | 0..* | Reference(EEBase Location) | Location(s) service is intended for/available to | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 |
| contained | 0..* | Resource | Contained, inline Resources | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| active | ?!Σ | 0..1 | boolean | Whether this HealthcareService record is in active use |
| providedBy | SΣ | 0..1 | Reference(EEBase Organization) | Organization that provides this service |
| category | SΣ | 0..* | CodeableConcept | Broad category of service being performed or delivered Binding: ServiceCategory (example): A category of the service(s) that could be provided. |
| specialty | SΣ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide. |
| location | Σ | 0..* | Reference(EEBase Location) | Location(s) where service may be provided |
| coverageArea | 0..* | Reference(EEBase Location) | Location(s) service is intended for/available to | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| HealthcareService.category | example | ServiceCategory |
| HealthcareService.specialty | preferred | PracticeSettingCodeValueSet |
| Id | Grade | Path(s) | Details | Requirements |
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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() |
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: AllLanguages (required): IETF language tag for 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 | Σ | 0..* | Identifier | External identifiers for this item |
| active | ?!Σ | 0..1 | boolean | Whether this HealthcareService record is in active use |
| providedBy | SΣ | 0..1 | Reference(EEBase Organization) | Organization that provides this service |
| offeredIn | 0..* | Reference(HealthcareService) | The service within which this service is offered | |
| category | SΣ | 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 | 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 | SΣ | 0..* | CodeableConcept | Specialties handled by the HealthcareService Binding: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide. |
| location | Σ | 0..* | Reference(EEBase 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 | markdown | 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 |
| contact | 0..* | ExtendedContactDetail | Official contact details for the HealthcareService | |
| coverageArea | 0..* | Reference(EEBase 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: (unbound) (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: ServiceMode (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibility). | |
| communication | 0..* | CodeableConcept | The language that this service is offered in Binding: AllLanguages (required): IETF language tag for 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 | |
| availability | 0..* | Availability | Times the healthcare service is available (including exceptions) | |
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to electronic services operated for the healthcare service | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| HealthcareService.language | required | AllLanguages |
| HealthcareService.category | example | ServiceCategory |
| HealthcareService.type | example | ServiceType |
| HealthcareService.specialty | preferred | PracticeSettingCodeValueSet |
| HealthcareService.serviceProvisionCode | example | ServiceProvisionConditions |
| HealthcareService.eligibility.code | example | |
| HealthcareService.program | example | Program |
| HealthcareService.characteristic | example | ServiceMode |
| HealthcareService.communication | required | AllLanguages |
| HealthcareService.referralMethod | example | ReferralMethod |
| Id | Grade | Path(s) | Details | Requirements |
| 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
Other representations of profile: CSV, Excel, Schematron