ERA FHIR specification - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Resource Profile: EraAppointmentHealthcareService
| Official URL: https://eradocumentation.atostek.com/StructureDefinition/EraAppointmentHealthcareService | Version: 1.0.0 | |||
| Draft as of 2026-03-24 | Computable Name: EraAppointmentHealthcareService | |||
HealthcareService profile used in the ERA interface for appointment booking. Based on the Kanta Services profile AppointmentHealthcareService. The profile conveys the details of the subject of the appointment.
Usages:
- Refer to this Profile: EraAppointmentAppointment
- Examples for this Profile: Appointment with a public health nurse
- CapabilityStatements using this Profile: ERA Capability Statement
You can also check for usages in the FHIR IG Statistics
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  | ||||
|---|---|---|---|---|---|---|---|---|
  HealthcareService |
0..* | HealthcareService | Healthcare service that is the subject of the appointment | |||||
  id |
1..1 | id | Logical id of this artifact | |||||
  meta |
0..1 | Meta | Metadata about the resource | |||||
  profile |
1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: https://eradocumentation.atostek.com/StructureDefinition/EraAppointmentHealthcareService (no extensions allowed) | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
 Slices for extension |
Content/Rules for all slices | |||||||
  extension:AppointmentType |
0..1 | Coding | Mode of transaction URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentType Binding: fipta-vs-appointmenttype (required) | |||||
| extension:RequestedService |
0..1 | (Complex) | Requested service URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/RequestedService | |||||
 extension:ResourceCalendar |
0..* | (Complex) | Resource to be booked URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/ResourceCalendar | |||||
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
 providedBy |
1..1 | Reference(AppointmentOrganization) {r} | Service-providing unit | |||||
| reference |
C | 1..1 | string | Reference to the resource to be used | ||||
| category |
1..1 | CodeableConcept | Service category Binding: fipta-vs-servicecategory (required) | |||||
 coding |
1..1 | Coding | Code defined by a terminology system | |||||
 system |
1..1 | uri | Identity of the terminology system | |||||
| code |
1..1 | code | Code value of the service category | |||||
| display |
1..1 | string | Service category name | |||||
| type |
0..* | CodeableConcept | Detailed content of the booking Binding: fipta-vs-detailedcontent (required) | |||||
| coding |
1..1 | Coding | Code defined by a terminology system | |||||
| system |
1..1 | uri | Identity of the terminology system | |||||
| code |
1..1 | code | Code value of the detailed content of the booking | |||||
| display |
1..1 | string | Detailed content of the booking | |||||
| specialty |
0..1 | CodeableConcept | Appointment specialty Binding: fipta-vs-specialty (required) | |||||
| coding |
1..1 | Coding | Code defined by a terminology system | |||||
| system |
1..1 | uri | Identity of the terminology system | |||||
| code |
1..1 | code | Specialty code value | |||||
| display |
1..1 | string | Specialty name | |||||
| name |
1..1 | string | Service title | |||||
| communication |
0..1 | CodeableConcept | Service language Binding: CommonLanguages (preferred): A human language.
| |||||
| coding |
1..1 | Coding | Code defined by a terminology system | |||||
| system |
1..1 | uri | Identity of the terminology system | |||||
| code |
1..1 | code | Symbol in syntax defined by the system | |||||
| display |
1..1 | string | Representation defined by the system | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| HealthcareService.category | Base | required | fipta-vs-servicecategory | 📦1.0.0 | This IG |
| HealthcareService.type | Base | required | fipta-vs-detailedcontent | 📦1.0.0 | This IG |
| HealthcareService.specialty | Base | required | fipta-vs-specialty | 📦1.0.0 | This IG |
| HealthcareService.communication | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
Constraints
| 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 | Healthcare service that is the subject of the appointment | |
 id |
1..1 | id | Logical id of this artifact | |
| meta |
0..1 | Meta | Metadata about the resource | |
| profile |
1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: https://eradocumentation.atostek.com/StructureDefinition/EraAppointmentHealthcareService (no extensions allowed) | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:AppointmentType |
0..1 | Coding | Mode of transaction URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentType Binding: fipta-vs-appointmenttype (required) | |
| extension:RequestedService |
0..1 | (Complex) | Requested service URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/RequestedService | |
| extension:ResourceCalendar |
0..* | (Complex) | Resource to be booked URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/ResourceCalendar | |
| identifier |
0..0 | External identifiers for this item | ||
| active |
0..0 | Whether this HealthcareService record is in active use | ||
| providedBy |
1..1 | Reference(AppointmentOrganization) {r} | Service-providing unit | |
| reference |
1..1 | string | Reference to the resource to be used | |
| identifier |
0..0 | Logical reference, when literal reference is not known | ||
| display |
0..0 | Text alternative for the resource | ||
| category |
1..1 | CodeableConcept | Service category Binding: fipta-vs-servicecategory (required) | |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Code value of the service category | |
| display |
1..1 | string | Service category name | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..0 | Plain text representation of the concept | ||
| type |
0..* | CodeableConcept | Detailed content of the booking Binding: fipta-vs-detailedcontent (required) | |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Code value of the detailed content of the booking | |
| display |
1..1 | string | Detailed content of the booking | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..0 | Plain text representation of the concept | ||
| specialty |
0..1 | CodeableConcept | Appointment specialty Binding: fipta-vs-specialty (required) | |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Specialty code value | |
| display |
1..1 | string | Specialty name | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..0 | Plain text representation of the concept | ||
| location |
0..0 | Location(s) where service may be provided | ||
| name |
1..1 | string | Service title | |
| comment |
0..0 | Additional description and/or any specific issues not covered elsewhere | ||
| extraDetails |
0..0 | Extra details about the service that can't be placed in the other fields | ||
| photo |
0..0 | Facilitates quick identification of the service | ||
| telecom |
0..0 | Contacts related to the healthcare service | ||
| coverageArea |
0..0 | Location(s) service is intended for/available to | ||
| serviceProvisionCode |
0..0 | Conditions under which service is available/offered | ||
| eligibility |
0..0 | Specific eligibility requirements required to use the service | ||
| program |
0..0 | Programs that this service is applicable to | ||
| characteristic |
0..0 | Collection of characteristics (attributes) | ||
| communication |
0..1 | CodeableConcept | Service language | |
| id |
0..0 | Unique id for inter-element referencing | ||
| coding |
1..1 | Coding | Code defined by a terminology system | |
| id |
0..0 | Unique id for inter-element referencing | ||
| system |
1..1 | uri | Identity of the terminology system | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Symbol in syntax defined by the system | |
| display |
1..1 | string | Representation defined by the system | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..0 | Plain text representation of the concept | ||
| referralMethod |
0..0 | Ways that the service accepts referrals | ||
| appointmentRequired |
0..0 | If an appointment is required for access to this service | ||
| availableTime |
0..0 | Times the Service Site is available | ||
| notAvailable |
0..0 | Not available during this time due to provided reason | ||
| availabilityExceptions |
0..0 | Description of availability exceptions | ||
| endpoint |
0..0 | Technical endpoints providing access to electronic services operated for the healthcare service | ||
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Status | Usage | ValueSet | Version | Source |
| HealthcareService.category | Base | required | fipta-vs-servicecategory | 📦1.0.0 | This IG |
| HealthcareService.type | Base | required | fipta-vs-detailedcontent | 📦1.0.0 | This IG |
| HealthcareService.specialty | Base | required | fipta-vs-specialty | 📦1.0.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| HealthcareService |
0..* | HealthcareService | Healthcare service that is the subject of the appointment | |||||
| id |
1..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
 extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
0..1 | id | Version specific identifier | |||||
| lastUpdated |
0..1 | instant | When the resource version last changed | |||||
| source |
0..1 | uri | Identifies where the resource comes from | |||||
| profile |
1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: https://eradocumentation.atostek.com/StructureDefinition/EraAppointmentHealthcareService (no extensions allowed) | |||||
| security |
0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| tag |
0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |||||
| 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 | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:AppointmentType |
0..1 | Coding | Mode of transaction URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentType Binding: fipta-vs-appointmenttype (required) | |||||
| extension:RequestedService |
0..1 | (Complex) | Requested service URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/RequestedService | |||||
| extension:ResourceCalendar |
0..* | (Complex) | Resource to be booked URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/ResourceCalendar | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| providedBy |
1..1 | Reference(AppointmentOrganization) {r} | Service-providing unit | |||||
| 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 | 1..1 | string | Reference to the resource to be used | ||||
| 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). | |||||
| category |
1..1 | CodeableConcept | Service category Binding: fipta-vs-servicecategory (required) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
1..1 | Coding | Code defined by a terminology system | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system | |||||
| code |
1..1 | code | Code value of the service category | |||||
| display |
1..1 | string | Service category name | |||||
| type |
0..* | CodeableConcept | Detailed content of the booking Binding: fipta-vs-detailedcontent (required) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
1..1 | Coding | Code defined by a terminology system | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system | |||||
| code |
1..1 | code | Code value of the detailed content of the booking | |||||
| display |
1..1 | string | Detailed content of the booking | |||||
| specialty |
0..1 | CodeableConcept | Appointment specialty Binding: fipta-vs-specialty (required) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
1..1 | Coding | Code defined by a terminology system | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system | |||||
| code |
1..1 | code | Specialty code value | |||||
| display |
1..1 | string | Specialty name | |||||
| name |
1..1 | string | Service title | |||||
| communication |
0..1 | CodeableConcept | Service language Binding: CommonLanguages (preferred): A human language.
| |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
1..1 | Coding | Code defined by a terminology system | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system | |||||
| code |
1..1 | code | Symbol in syntax defined by the system | |||||
| display |
1..1 | string | Representation defined by the system | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| HealthcareService.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| HealthcareService.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| 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 | required | fipta-vs-servicecategory | 📦1.0.0 | This IG |
| HealthcareService.type | Base | required | fipta-vs-detailedcontent | 📦1.0.0 | This IG |
| HealthcareService.specialty | Base | required | fipta-vs-specialty | 📦1.0.0 | This IG |
| HealthcareService.eligibility.code | Base | example | Not State | Unknown | |
| HealthcareService.communication | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| HealthcareService.availableTime.daysOfWeek | Base | required | DaysOfWeek | 📍4.0.1 | FHIR Std. |
Constraints
| 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
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| HealthcareService |
0..* | HealthcareService | Healthcare service that is the subject of the appointment | |||||
| id |
1..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| profile |
1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: https://eradocumentation.atostek.com/StructureDefinition/EraAppointmentHealthcareService (no extensions allowed) | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| extension:AppointmentType |
0..1 | Coding | Mode of transaction URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentType Binding: fipta-vs-appointmenttype (required) | |||||
| extension:RequestedService |
0..1 | (Complex) | Requested service URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/RequestedService | |||||
| extension:ResourceCalendar |
0..* | (Complex) | Resource to be booked URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/ResourceCalendar | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| providedBy |
1..1 | Reference(AppointmentOrganization) {r} | Service-providing unit | |||||
| reference |
C | 1..1 | string | Reference to the resource to be used | ||||
| category |
1..1 | CodeableConcept | Service category Binding: fipta-vs-servicecategory (required) | |||||
| coding |
1..1 | Coding | Code defined by a terminology system | |||||
| system |
1..1 | uri | Identity of the terminology system | |||||
| code |
1..1 | code | Code value of the service category | |||||
| display |
1..1 | string | Service category name | |||||
| type |
0..* | CodeableConcept | Detailed content of the booking Binding: fipta-vs-detailedcontent (required) | |||||
| coding |
1..1 | Coding | Code defined by a terminology system | |||||
| system |
1..1 | uri | Identity of the terminology system | |||||
| code |
1..1 | code | Code value of the detailed content of the booking | |||||
| display |
1..1 | string | Detailed content of the booking | |||||
| specialty |
0..1 | CodeableConcept | Appointment specialty Binding: fipta-vs-specialty (required) | |||||
| coding |
1..1 | Coding | Code defined by a terminology system | |||||
| system |
1..1 | uri | Identity of the terminology system | |||||
| code |
1..1 | code | Specialty code value | |||||
| display |
1..1 | string | Specialty name | |||||
| name |
1..1 | string | Service title | |||||
| communication |
0..1 | CodeableConcept | Service language Binding: CommonLanguages (preferred): A human language.
| |||||
| coding |
1..1 | Coding | Code defined by a terminology system | |||||
| system |
1..1 | uri | Identity of the terminology system | |||||
| code |
1..1 | code | Symbol in syntax defined by the system | |||||
| display |
1..1 | string | Representation defined by the system | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| HealthcareService.category | Base | required | fipta-vs-servicecategory | 📦1.0.0 | This IG |
| HealthcareService.type | Base | required | fipta-vs-detailedcontent | 📦1.0.0 | This IG |
| HealthcareService.specialty | Base | required | fipta-vs-specialty | 📦1.0.0 | This IG |
| HealthcareService.communication | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
Constraints
| 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 | Healthcare service that is the subject of the appointment | |
| id |
1..1 | id | Logical id of this artifact | |
| meta |
0..1 | Meta | Metadata about the resource | |
| profile |
1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: https://eradocumentation.atostek.com/StructureDefinition/EraAppointmentHealthcareService (no extensions allowed) | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:AppointmentType |
0..1 | Coding | Mode of transaction URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentType Binding: fipta-vs-appointmenttype (required) | |
| extension:RequestedService |
0..1 | (Complex) | Requested service URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/RequestedService | |
| extension:ResourceCalendar |
0..* | (Complex) | Resource to be booked URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/ResourceCalendar | |
| identifier |
0..0 | External identifiers for this item | ||
| active |
0..0 | Whether this HealthcareService record is in active use | ||
| providedBy |
1..1 | Reference(AppointmentOrganization) {r} | Service-providing unit | |
| reference |
1..1 | string | Reference to the resource to be used | |
| identifier |
0..0 | Logical reference, when literal reference is not known | ||
| display |
0..0 | Text alternative for the resource | ||
| category |
1..1 | CodeableConcept | Service category Binding: fipta-vs-servicecategory (required) | |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Code value of the service category | |
| display |
1..1 | string | Service category name | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..0 | Plain text representation of the concept | ||
| type |
0..* | CodeableConcept | Detailed content of the booking Binding: fipta-vs-detailedcontent (required) | |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Code value of the detailed content of the booking | |
| display |
1..1 | string | Detailed content of the booking | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..0 | Plain text representation of the concept | ||
| specialty |
0..1 | CodeableConcept | Appointment specialty Binding: fipta-vs-specialty (required) | |
| coding |
1..1 | Coding | Code defined by a terminology system | |
| system |
1..1 | uri | Identity of the terminology system | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Specialty code value | |
| display |
1..1 | string | Specialty name | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..0 | Plain text representation of the concept | ||
| location |
0..0 | Location(s) where service may be provided | ||
| name |
1..1 | string | Service title | |
| comment |
0..0 | Additional description and/or any specific issues not covered elsewhere | ||
| extraDetails |
0..0 | Extra details about the service that can't be placed in the other fields | ||
| photo |
0..0 | Facilitates quick identification of the service | ||
| telecom |
0..0 | Contacts related to the healthcare service | ||
| coverageArea |
0..0 | Location(s) service is intended for/available to | ||
| serviceProvisionCode |
0..0 | Conditions under which service is available/offered | ||
| eligibility |
0..0 | Specific eligibility requirements required to use the service | ||
| program |
0..0 | Programs that this service is applicable to | ||
| characteristic |
0..0 | Collection of characteristics (attributes) | ||
| communication |
0..1 | CodeableConcept | Service language | |
| id |
0..0 | Unique id for inter-element referencing | ||
| coding |
1..1 | Coding | Code defined by a terminology system | |
| id |
0..0 | Unique id for inter-element referencing | ||
| system |
1..1 | uri | Identity of the terminology system | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Symbol in syntax defined by the system | |
| display |
1..1 | string | Representation defined by the system | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..0 | Plain text representation of the concept | ||
| referralMethod |
0..0 | Ways that the service accepts referrals | ||
| appointmentRequired |
0..0 | If an appointment is required for access to this service | ||
| availableTime |
0..0 | Times the Service Site is available | ||
| notAvailable |
0..0 | Not available during this time due to provided reason | ||
| availabilityExceptions |
0..0 | Description of availability exceptions | ||
| endpoint |
0..0 | Technical endpoints providing access to electronic services operated for the healthcare service | ||
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Status | Usage | ValueSet | Version | Source |
| HealthcareService.category | Base | required | fipta-vs-servicecategory | 📦1.0.0 | This IG |
| HealthcareService.type | Base | required | fipta-vs-detailedcontent | 📦1.0.0 | This IG |
| HealthcareService.specialty | Base | required | fipta-vs-specialty | 📦1.0.0 | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| HealthcareService |
0..* | HealthcareService | Healthcare service that is the subject of the appointment | |||||
| id |
1..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
0..1 | id | Version specific identifier | |||||
| lastUpdated |
0..1 | instant | When the resource version last changed | |||||
| source |
0..1 | uri | Identifies where the resource comes from | |||||
| profile |
1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: https://eradocumentation.atostek.com/StructureDefinition/EraAppointmentHealthcareService (no extensions allowed) | |||||
| security |
0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| tag |
0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |||||
| 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 | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:AppointmentType |
0..1 | Coding | Mode of transaction URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentType Binding: fipta-vs-appointmenttype (required) | |||||
| extension:RequestedService |
0..1 | (Complex) | Requested service URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/RequestedService | |||||
| extension:ResourceCalendar |
0..* | (Complex) | Resource to be booked URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/ResourceCalendar | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| providedBy |
1..1 | Reference(AppointmentOrganization) {r} | Service-providing unit | |||||
| 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 | 1..1 | string | Reference to the resource to be used | ||||
| 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). | |||||
| category |
1..1 | CodeableConcept | Service category Binding: fipta-vs-servicecategory (required) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
1..1 | Coding | Code defined by a terminology system | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system | |||||
| code |
1..1 | code | Code value of the service category | |||||
| display |
1..1 | string | Service category name | |||||
| type |
0..* | CodeableConcept | Detailed content of the booking Binding: fipta-vs-detailedcontent (required) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
1..1 | Coding | Code defined by a terminology system | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system | |||||
| code |
1..1 | code | Code value of the detailed content of the booking | |||||
| display |
1..1 | string | Detailed content of the booking | |||||
| specialty |
0..1 | CodeableConcept | Appointment specialty Binding: fipta-vs-specialty (required) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
1..1 | Coding | Code defined by a terminology system | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system | |||||
| code |
1..1 | code | Specialty code value | |||||
| display |
1..1 | string | Specialty name | |||||
| name |
1..1 | string | Service title | |||||
| communication |
0..1 | CodeableConcept | Service language Binding: CommonLanguages (preferred): A human language.
| |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
1..1 | Coding | Code defined by a terminology system | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Identity of the terminology system | |||||
| code |
1..1 | code | Symbol in syntax defined by the system | |||||
| display |
1..1 | string | Representation defined by the system | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| HealthcareService.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| HealthcareService.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| 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 | required | fipta-vs-servicecategory | 📦1.0.0 | This IG |
| HealthcareService.type | Base | required | fipta-vs-detailedcontent | 📦1.0.0 | This IG |
| HealthcareService.specialty | Base | required | fipta-vs-specialty | 📦1.0.0 | This IG |
| HealthcareService.eligibility.code | Base | example | Not State | Unknown | |
| HealthcareService.communication | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| HealthcareService.availableTime.daysOfWeek | Base | required | DaysOfWeek | 📍4.0.1 | FHIR Std. |
Constraints
| 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
Other representations of profile: CSV, Excel, Schematron