Finnish Base Profiles
1.0.0 - trial-use
This page is part of the Finnish Base Profiles (v1.0.0: STU 1) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions
Official URL: https://hl7.fi/fhir/finnish-base-profiles/StructureDefinition/fi-base-healthcare-service | Version: 1.0.0 | |||
Active as of 2023-11-10 | Computable Name: FiBaseHealthcareService |
This is the Finnish base profile for the HealthcareService resource.
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 | HealthcareService | |||
providedBy | 0..1 | Reference(FI Base Organization) | Organization that provides this service | |
location | 0..* | Reference(FI Base Location) | Location(s) where service may be provided | |
coverageArea | 0..* | Reference(FI Base 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 |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
active | ?!Σ | 0..1 | boolean | Whether this HealthcareService record is in active use |
providedBy | Σ | 0..1 | Reference(FI Base Organization) | Organization that provides this service |
location | Σ | 0..* | Reference(FI Base Location) | Location(s) where service may be provided |
coverageArea | 0..* | Reference(FI Base Location) | Location(s) service is intended for/available to | |
Documentation for this format |
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().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() |
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: CommonLanguages (preferred): 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 | Σ | 0..1 | Reference(FI Base Organization) | Organization that provides this service | ||||
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 | 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: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide. | ||||
location | Σ | 0..* | Reference(FI Base 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(FI Base 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: (unbound) (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) | Technical endpoints providing access to electronic services operated for the healthcare service | |||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
HealthcareService.language | preferred | CommonLanguages
| ||||
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 | |||||
HealthcareService.communication | preferred | CommonLanguages
| ||||
HealthcareService.referralMethod | example | ReferralMethod | ||||
HealthcareService.availableTime.daysOfWeek | required | DaysOfWeek |
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().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
Differential View
This structure is derived from HealthcareService
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
HealthcareService | HealthcareService | |||
providedBy | 0..1 | Reference(FI Base Organization) | Organization that provides this service | |
location | 0..* | Reference(FI Base Location) | Location(s) where service may be provided | |
coverageArea | 0..* | Reference(FI Base 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 |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
active | ?!Σ | 0..1 | boolean | Whether this HealthcareService record is in active use |
providedBy | Σ | 0..1 | Reference(FI Base Organization) | Organization that provides this service |
location | Σ | 0..* | Reference(FI Base Location) | Location(s) where service may be provided |
coverageArea | 0..* | Reference(FI Base Location) | Location(s) service is intended for/available to | |
Documentation for this format |
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().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() |
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: CommonLanguages (preferred): 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 | Σ | 0..1 | Reference(FI Base Organization) | Organization that provides this service | ||||
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 | 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: PracticeSettingCodeValueSet (preferred): A specialty that a healthcare service may provide. | ||||
location | Σ | 0..* | Reference(FI Base 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(FI Base 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: (unbound) (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) | Technical endpoints providing access to electronic services operated for the healthcare service | |||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
HealthcareService.language | preferred | CommonLanguages
| ||||
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 | |||||
HealthcareService.communication | preferred | CommonLanguages
| ||||
HealthcareService.referralMethod | example | ReferralMethod | ||||
HealthcareService.availableTime.daysOfWeek | required | DaysOfWeek |
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().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
Other representations of profile: CSV, Excel, Schematron