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: EraAppointmentAppointment
| Official URL: https://eradocumentation.atostek.com/StructureDefinition/EraAppointmentAppointment | Version: 1.0.0 | |||
| Draft as of 2026-03-24 | Computable Name: EraAppointmentAppointment | |||
Appointment profile used in the ERA interface for creating and updating appointments. Based on the Kanta Services profile AppointmentAppointment.
Usages:
- Refer to this Profile: EraAppointmentProvenance
- Examples for this Profile: Appointment/Appointment-update-example and Appointment/EraAppointmentAppointment-example
- 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:  | ||||
|---|---|---|---|---|---|---|---|---|
  Appointment |
C | 0..* | Appointment | Appointment information Constraints: app-2, app-3, app-4, PTA-APP-1, PTA-APP-2, PTA-APP-3, PTA-APP-4 | ||||
  id |
0..1 | id | Unique identifier of the appointment | |||||
  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/EraAppointmentAppointment (no extensions allowed) | |||||
 security |
0..* | Coding | Display of appointment information Binding: fipta-vs-visible (required) | |||||
 system |
1..1 | uri | Identity of the terminology system | |||||
| code |
1..1 | code | Code value for information on disclosure of a minor's data to guardians | |||||
 display |
1..1 | string | Representation defined by the system | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
1..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Appointment information to be presented in display form. ERA will overwrite this with the correct narrative. This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
 Slices for extension |
Content/Rules for all slices | |||||||
  extension:remoteServiceURL |
0..1 | url | Link for joining the remote service URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/RemoteServiceURL | |||||
| extension:ServiceAdditionalInformation |
0..1 | string | Additional information on further care or the service process URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/ServiceAdditionalInformation | |||||
| extension:AppointmentReason |
0..1 | (Complex) | Reason for the appointment booking URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentReason | |||||
| extension:CareplanIdentifier |
0..1 | Identifier | Identifier of the plan related to the appointment URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/CareplanIdentifier | |||||
| extension:NotificationMedium |
0..* | Coding | Reminder method URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/NotificationMedium Binding: fipta-vs-notificationmedium (required) | |||||
| extension:CustomerJourney |
0..* | (Complex) | Identification details of the customer's service pathway URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/CustomerJourney | |||||
| extension:SelfServiceInfo |
0..1 | (Complex) | Web address of the e-service and information on the possibility to act on behalf of another person URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/SelfServiceInfo | |||||
| extension:AppointmentMutabilityNotAfter |
0..1 | dateTime | Deadline for cancellation or rescheduling URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentMutabilityNotAfter | |||||
| extension:QueueNo |
0..1 | string | Queue number URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/QueueNo | |||||
| extension:TicketNo |
0..1 | string | Ticket number URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/TicketNo | |||||
| extension:ChildAppointment |
0..* | Identifier | Sub-appointment identifier URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/ChildAppointment | |||||
| extension:AdditionalInformationURL |
0..* | url | Additional information address URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AdditionalInformationURL | |||||
| extension:PractitionerGender |
0..1 | Coding | Gender of the service provider URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/PractitionerGender Binding: fipta-vs-gender (required) | |||||
 extension:BookingDeadline |
0..1 | dateTime | Date and time by which the appointment is instructed to be made at the latest URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/BookingDeadline | |||||
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | Appointment identifier. If not provided, ERA will generate one. | |||||
| system |
1..1 | uri | Namespace defined by the organization Example General: http://www.acme.com/identifiers/patient | |||||
| value |
1..1 | string | Appointment identifier Example General: 123456 | |||||
| status |
1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: fipta-vs-appointmentstatus (required) | |||||
| cancelationReason |
0..1 | CodeableConcept | Reason for cancellation of the appointment Binding: fipta-vs-cancelationreason (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 for the reason why the appointment was cancelled | |||||
| display |
1..1 | string | Reason why the appointment was cancelled | |||||
| start |
0..1 | instant | Start time of the appointment time interval | |||||
| end |
0..1 | instant | End time of the appointment time interval | |||||
| comment |
0..1 | string | Additional information | |||||
| patientInstruction |
0..1 | string | Patient instruction | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| extension:PatientInstructionURL |
0..* | url | Link to patient instructions URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/PatientInstructionURL | |||||
 basedOn |
0..* | Reference(ServiceRequest) | Identifier of the referral or request related to the appointment | |||||
| identifier |
1..1 | Identifier | Identifier of the referral or request related to the appointment | |||||
| system |
1..1 | uri | Namespace defined by the organization Example General: http://www.acme.com/identifiers/patient | |||||
| value |
1..1 | string | Referral or request identifier Example General: 123456 | |||||
| Slices for participant |
C | 1..* | BackboneElement | Participants involved in appointment Slice: Unordered, Closed by value:type.coding.code Constraints: app-1 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||
  participant:All Slices |
Content/Rules for all slices | |||||||
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| status |
1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | |||||
| participant:Patient |
C | 1..1 | BackboneElement | Patient or customer Constraints: app-1 | ||||
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
 type |
1..1 | CodeableConcept | Customer for whom the appointment has been booked. Binding: fipta-vs-appointmenttypecategory (required) | |||||
 coding |
1..1 | Coding | Role in appointment | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: https://pta.kanta.fi/fhir/CodeSystem/fipta-cs-appointmenttypecategory (no extensions allowed) | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 (no extensions allowed) | |||||
| display |
1..1 | string | Representation defined by the system | |||||
| actor |
1..1 | Reference(AppointmentPatient) {r} | Person, Location/HealthcareService or Device | |||||
| reference |
C | 1..1 | string | Reference to the resource to be used | ||||
 status |
1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Fixed Value: accepted (no extensions allowed) | |||||
| participant:HealthcareService |
C | 1..1 | BackboneElement | Healthcare service Constraints: app-1 | ||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| type |
1..1 | CodeableConcept | Healthcare service Binding: fipta-vs-appointmenttypecategory (required) | |||||
| coding |
1..1 | Coding | Role in appointment | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: https://pta.kanta.fi/fhir/CodeSystem/fipta-cs-appointmenttypecategory (no extensions allowed) | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 2 (no extensions allowed) | |||||
| display |
1..1 | string | Representation defined by the system | |||||
| actor |
1..1 | Reference(EraAppointmentHealthcareService) {r} | Person, Location/HealthcareService or Device | |||||
| reference |
C | 1..1 | string | Reference to the resource to be used | ||||
| status |
1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Fixed Value: accepted (no extensions allowed) | |||||
 participant:Location |
C | 0..1 | BackboneElement | Service point location Constraints: app-1 | ||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| type |
1..1 | CodeableConcept | Service point location details Binding: fipta-vs-appointmenttypecategory (required) | |||||
| coding |
1..1 | Coding | Role in appointment | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: https://pta.kanta.fi/fhir/CodeSystem/fipta-cs-appointmenttypecategory (no extensions allowed) | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 3 (no extensions allowed) | |||||
| display |
1..1 | string | Representation defined by the system | |||||
| actor |
1..1 | Reference(AppointmentLocation) {r} | Person, Location/HealthcareService or Device | |||||
| reference |
C | 1..1 | string | Reference to the resource to be used | ||||
| status |
1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Fixed Value: accepted (no extensions allowed) | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Appointment.meta.security | Base | required | fipta-vs-visible | 📦1.0.0 | This IG |
| Appointment.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Appointment.status | Base | required | fipta-vs-appointmentstatus | 📦1.0.0 | This IG |
| Appointment.cancelationReason | Base | required | fipta-vs-cancelationreason | 📦1.0.0 | This IG |
| Appointment.participant.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Appointment.participant:Patient.type | Base | required | fipta-vs-appointmenttypecategory | 📦1.0.0 | This IG |
| Appointment.participant:Patient.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Appointment.participant:HealthcareService.type | Base | required | fipta-vs-appointmenttypecategory | 📦1.0.0 | This IG |
| Appointment.participant:HealthcareService.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Appointment.participant:Location.type | Base | required | fipta-vs-appointmenttypecategory | 📦1.0.0 | This IG |
| Appointment.participant:Location.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| PTA-APP-1 | error | Appointment | The end time of the appointment cannot be before the start time of the appointment. |
start.exists() implies start <= end
|
| PTA-APP-2 | error | Appointment | The deadline for cancellation or rescheduling must be given in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. |
Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentMutabilityNotAfter').exists() implies Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentMutabilityNotAfter').value.toString().length()>10
|
| PTA-APP-3 | error | Appointment | The date and time by which the appointment is instructed to take place at the latest must be given in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. |
Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/BookingDeadline').exists() implies Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/BookingDeadline').value.toString().length()>10
|
| PTA-APP-4 | error | Appointment | The appointment identifier (Appointment.identifier) exceeds the allowed maximum length. |
Appointment.identifier.exists() implies Appointment.identifier.system.length()+Appointment.identifier.value.length() < 125
|
| app-1 | error | Appointment.participant, Appointment.participant:Patient, Appointment.participant:HealthcareService, Appointment.participant:Location | Either the type or actor on the participant SHALL be specified |
type.exists() or actor.exists()
|
| app-2 | error | Appointment | Either start and end are specified, or neither |
start.exists() = end.exists()
|
| app-3 | error | Appointment | Only proposed or cancelled appointments can be missing start/end dates |
(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
|
| app-4 | error | Appointment | Cancelation reason is only used for appointments that have been cancelled, or no-show |
Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
|
| dom-2 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Appointment | 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 | Appointment | 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 | Appointment | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Appointment | 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 Appointment
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Appointment |
C | 0..* | Appointment | Appointment information Constraints: PTA-APP-1, PTA-APP-2, PTA-APP-3, PTA-APP-4 |
| id |
0..1 | id | Unique identifier of the appointment | |
| 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/EraAppointmentAppointment (no extensions allowed) | |
| security |
0..* | Coding | Display of appointment information Binding: fipta-vs-visible (required) | |
| 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 | Code value for information on disclosure of a minor's data to guardians | |
| display |
1..1 | string | Representation defined by the system | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| language |
1..1 | code | Language of the resource content | |
| text |
0..1 | Narrative | Appointment information to be presented in display form. ERA will overwrite this with the correct narrative. | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:remoteServiceURL |
0..1 | url | Link for joining the remote service URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/RemoteServiceURL | |
| extension:ServiceAdditionalInformation |
0..1 | string | Additional information on further care or the service process URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/ServiceAdditionalInformation | |
| extension:AppointmentReason |
0..1 | (Complex) | Reason for the appointment booking URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentReason | |
| extension:CareplanIdentifier |
0..1 | Identifier | Identifier of the plan related to the appointment URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/CareplanIdentifier | |
| extension:NotificationMedium |
0..* | Coding | Reminder method URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/NotificationMedium Binding: fipta-vs-notificationmedium (required) | |
| extension:CustomerJourney |
0..* | (Complex) | Identification details of the customer's service pathway URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/CustomerJourney | |
| extension:SelfServiceInfo |
0..1 | (Complex) | Web address of the e-service and information on the possibility to act on behalf of another person URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/SelfServiceInfo | |
| extension:AppointmentMutabilityNotAfter |
0..1 | dateTime | Deadline for cancellation or rescheduling URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentMutabilityNotAfter | |
| extension:QueueNo |
0..1 | string | Queue number URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/QueueNo | |
| extension:TicketNo |
0..1 | string | Ticket number URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/TicketNo | |
| extension:ChildAppointment |
0..* | Identifier | Sub-appointment identifier URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/ChildAppointment | |
| extension:AdditionalInformationURL |
0..* | url | Additional information address URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AdditionalInformationURL | |
| extension:PractitionerGender |
0..1 | Coding | Gender of the service provider URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/PractitionerGender Binding: fipta-vs-gender (required) | |
| extension:BookingDeadline |
0..1 | dateTime | Date and time by which the appointment is instructed to be made at the latest URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/BookingDeadline | |
| identifier |
0..* | Identifier | Appointment identifier. If not provided, ERA will generate one. | |
| id |
0..0 | Unique id for inter-element referencing | ||
| use |
0..0 | usual | official | temp | secondary | old (If known) | ||
| type |
0..0 | Description of identifier | ||
| system |
1..1 | uri | Namespace defined by the organization | |
| value |
1..1 | string | Appointment identifier | |
| period |
0..0 | Time period when id is/was valid for use | ||
| assigner |
0..0 | Organization that issued id (may be just text) | ||
| status |
1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: fipta-vs-appointmentstatus (required) | |
| cancelationReason |
0..1 | CodeableConcept | Reason for cancellation of the appointment Binding: fipta-vs-cancelationreason (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 for the reason why the appointment was cancelled | |
| display |
1..1 | string | Reason why the appointment was cancelled | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..0 | Plain text representation of the concept | ||
| serviceCategory |
0..0 | Service category | ||
| serviceType |
0..0 | Service name | ||
| specialty |
0..0 | The specialty of a practitioner that would be required to perform the service requested in this appointment | ||
| appointmentType |
0..0 | The style of appointment or patient that has been booked in the slot (not service type) | ||
| reasonCode |
0..0 | Coded reason this appointment is scheduled | ||
| reasonReference |
0..0 | Description of symptoms, the main reason for contact, and a description of the customer's risk information | ||
| priority |
0..0 | Used to make informed decisions if needing to re-prioritize | ||
| description |
0..0 | Shown on a subject line in a meeting request, or appointment list | ||
| supportingInformation |
0..0 | Additional information to support the appointment | ||
| start |
0..1 | instant | Start time of the appointment time interval | |
| end |
0..1 | instant | End time of the appointment time interval | |
| minutesDuration |
0..0 | Can be less than start/end (e.g. estimate) | ||
| slot |
0..0 | The slots that this appointment is filling | ||
| created |
0..0 | The date that this appointment was initially created | ||
| comment |
0..1 | string | Additional information | |
| patientInstruction |
0..1 | string | Patient instruction | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:PatientInstructionURL |
0..* | url | Link to patient instructions URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/PatientInstructionURL | |
| basedOn |
0..* | Reference(ServiceRequest) | Identifier of the referral or request related to the appointment | |
| reference |
0..0 | Literal reference, Relative, internal or absolute URL | ||
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| identifier |
1..1 | Identifier | Identifier of the referral or request related to the appointment | |
| use |
0..0 | usual | official | temp | secondary | old (If known) | ||
| type |
0..0 | Description of identifier | ||
| system |
1..1 | uri | Namespace defined by the organization | |
| value |
1..1 | string | Referral or request identifier | |
| period |
0..0 | Time period when id is/was valid for use | ||
| assigner |
0..0 | Organization that issued id (may be just text) | ||
| display |
0..0 | Text alternative for the resource | ||
| Slices for participant |
1..* | BackboneElement | Participants involved in appointment Slice: Unordered, Closed by value:type.coding.code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| participant:Patient |
1..1 | BackboneElement | Patient or customer | |
| type |
1..1 | CodeableConcept | Customer for whom the appointment has been booked. Binding: fipta-vs-appointmenttypecategory (required) | |
| coding |
1..1 | Coding | Role in appointment | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: https://pta.kanta.fi/fhir/CodeSystem/fipta-cs-appointmenttypecategory (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 (no extensions allowed) | |
| 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 | ||
| actor |
1..1 | Reference(AppointmentPatient) {r} | Person, Location/HealthcareService or Device | |
| 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 | ||
| required |
0..0 | required | optional | information-only | ||
| status |
1..1 | code | accepted | declined | tentative | needs-action Fixed Value: accepted (no extensions allowed) | |
| period |
0..0 | Participation period of the actor | ||
| participant:HealthcareService |
1..1 | BackboneElement | Healthcare service | |
| type |
1..1 | CodeableConcept | Healthcare service Binding: fipta-vs-appointmenttypecategory (required) | |
| coding |
1..1 | Coding | Role in appointment | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: https://pta.kanta.fi/fhir/CodeSystem/fipta-cs-appointmenttypecategory (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 2 (no extensions allowed) | |
| 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 | ||
| actor |
1..1 | Reference(EraAppointmentHealthcareService) {r} | Person, Location/HealthcareService or Device | |
| 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 | ||
| required |
0..0 | required | optional | information-only | ||
| status |
1..1 | code | accepted | declined | tentative | needs-action Fixed Value: accepted (no extensions allowed) | |
| period |
0..0 | Participation period of the actor | ||
| participant:Location |
0..1 | BackboneElement | Service point location | |
| type |
1..1 | CodeableConcept | Service point location details Binding: fipta-vs-appointmenttypecategory (required) | |
| coding |
1..1 | Coding | Role in appointment | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: https://pta.kanta.fi/fhir/CodeSystem/fipta-cs-appointmenttypecategory (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 3 (no extensions allowed) | |
| 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 | ||
| actor |
1..1 | Reference(AppointmentLocation) {r} | Person, Location/HealthcareService or Device | |
| 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 | ||
| required |
0..0 | required | optional | information-only | ||
| status |
1..1 | code | accepted | declined | tentative | needs-action Fixed Value: accepted (no extensions allowed) | |
| period |
0..0 | Participation period of the actor | ||
| requestedPeriod |
0..0 | Potential date/time interval(s) requested to allocate the appointment within | ||
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Status | Usage | ValueSet | Version | Source |
| Appointment.meta.security | Base | required | fipta-vs-visible | 📦1.0.0 | This IG |
| Appointment.status | Base | required | fipta-vs-appointmentstatus | 📦1.0.0 | This IG |
| Appointment.cancelationReason | Base | required | fipta-vs-cancelationreason | 📦1.0.0 | This IG |
| Appointment.participant:Patient.type | Base | required | fipta-vs-appointmenttypecategory | 📦1.0.0 | This IG |
| Appointment.participant:HealthcareService.type | Base | required | fipta-vs-appointmenttypecategory | 📦1.0.0 | This IG |
| Appointment.participant:Location.type | Base | required | fipta-vs-appointmenttypecategory | 📦1.0.0 | This IG |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| PTA-APP-1 | error | Appointment | The end time of the appointment cannot be before the start time of the appointment. |
start.exists() implies start <= end
|
| PTA-APP-2 | error | Appointment | The deadline for cancellation or rescheduling must be given in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. |
Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentMutabilityNotAfter').exists() implies Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentMutabilityNotAfter').value.toString().length()>10
|
| PTA-APP-3 | error | Appointment | The date and time by which the appointment is instructed to take place at the latest must be given in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. |
Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/BookingDeadline').exists() implies Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/BookingDeadline').value.toString().length()>10
|
| PTA-APP-4 | error | Appointment | The appointment identifier (Appointment.identifier) exceeds the allowed maximum length. |
Appointment.identifier.exists() implies Appointment.identifier.system.length()+Appointment.identifier.value.length() < 125
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Appointment |
C | 0..* | Appointment | Appointment information Constraints: app-2, app-3, app-4, PTA-APP-1, PTA-APP-2, PTA-APP-3, PTA-APP-4 | ||||
| id |
0..1 | id | Unique identifier of the appointment | |||||
| 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/EraAppointmentAppointment (no extensions allowed) | |||||
| security |
0..* | Coding | Display of appointment information Binding: fipta-vs-visible (required) | |||||
| 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 for information on disclosure of a minor's data to guardians | |||||
| display |
1..1 | string | Representation defined by the 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 |
1..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Appointment information to be presented in display form. ERA will overwrite this with the correct narrative. 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:remoteServiceURL |
0..1 | url | Link for joining the remote service URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/RemoteServiceURL | |||||
| extension:ServiceAdditionalInformation |
0..1 | string | Additional information on further care or the service process URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/ServiceAdditionalInformation | |||||
| extension:AppointmentReason |
0..1 | (Complex) | Reason for the appointment booking URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentReason | |||||
| extension:CareplanIdentifier |
0..1 | Identifier | Identifier of the plan related to the appointment URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/CareplanIdentifier | |||||
| extension:NotificationMedium |
0..* | Coding | Reminder method URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/NotificationMedium Binding: fipta-vs-notificationmedium (required) | |||||
| extension:CustomerJourney |
0..* | (Complex) | Identification details of the customer's service pathway URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/CustomerJourney | |||||
| extension:SelfServiceInfo |
0..1 | (Complex) | Web address of the e-service and information on the possibility to act on behalf of another person URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/SelfServiceInfo | |||||
| extension:AppointmentMutabilityNotAfter |
0..1 | dateTime | Deadline for cancellation or rescheduling URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentMutabilityNotAfter | |||||
| extension:QueueNo |
0..1 | string | Queue number URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/QueueNo | |||||
| extension:TicketNo |
0..1 | string | Ticket number URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/TicketNo | |||||
| extension:ChildAppointment |
0..* | Identifier | Sub-appointment identifier URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/ChildAppointment | |||||
| extension:AdditionalInformationURL |
0..* | url | Additional information address URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AdditionalInformationURL | |||||
| extension:PractitionerGender |
0..1 | Coding | Gender of the service provider URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/PractitionerGender Binding: fipta-vs-gender (required) | |||||
| extension:BookingDeadline |
0..1 | dateTime | Date and time by which the appointment is instructed to be made at the latest URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/BookingDeadline | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | Appointment identifier. If not provided, ERA will generate one. | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Namespace defined by the organization Example General: http://www.acme.com/identifiers/patient | |||||
| value |
1..1 | string | Appointment identifier Example General: 123456 | |||||
| status |
1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: fipta-vs-appointmentstatus (required) | |||||
| cancelationReason |
0..1 | CodeableConcept | Reason for cancellation of the appointment Binding: fipta-vs-cancelationreason (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 for the reason why the appointment was cancelled | |||||
| display |
1..1 | string | Reason why the appointment was cancelled | |||||
| start |
0..1 | instant | Start time of the appointment time interval | |||||
| end |
0..1 | instant | End time of the appointment time interval | |||||
| comment |
0..1 | string | Additional information | |||||
| patientInstruction |
0..1 | string | Patient instruction | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:PatientInstructionURL |
0..* | url | Link to patient instructions URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/PatientInstructionURL | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| basedOn |
0..* | Reference(ServiceRequest) | Identifier of the referral or request related to the appointment | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| identifier |
1..1 | Identifier | Identifier of the referral or request related to the appointment | |||||
| 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 | Namespace defined by the organization Example General: http://www.acme.com/identifiers/patient | |||||
| value |
1..1 | string | Referral or request identifier Example General: 123456 | |||||
| Slices for participant |
C | 1..* | BackboneElement | Participants involved in appointment Slice: Unordered, Closed by value:type.coding.code Constraints: app-1 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||
| participant:All Slices |
Content/Rules for all slices | |||||||
| 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 | |||||
| type |
0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | |||||
| actor |
0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | Person, Location/HealthcareService or Device | |||||
| required |
0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. | |||||
| status |
1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | |||||
| period |
0..1 | Period | Participation period of the actor | |||||
| participant:Patient |
C | 1..1 | BackboneElement | Patient or customer Constraints: app-1 | ||||
| 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 | |||||
| type |
1..1 | CodeableConcept | Customer for whom the appointment has been booked. Binding: fipta-vs-appointmenttypecategory (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 | Role in appointment | |||||
| 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 Fixed Value: https://pta.kanta.fi/fhir/CodeSystem/fipta-cs-appointmenttypecategory (no extensions allowed) | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 (no extensions allowed) | |||||
| display |
1..1 | string | Representation defined by the system | |||||
| actor |
1..1 | Reference(AppointmentPatient) {r} | Person, Location/HealthcareService or Device | |||||
| 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). | |||||
| status |
1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Fixed Value: accepted (no extensions allowed) | |||||
| participant:HealthcareService |
C | 1..1 | BackboneElement | Healthcare service Constraints: app-1 | ||||
| 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 | |||||
| type |
1..1 | CodeableConcept | Healthcare service Binding: fipta-vs-appointmenttypecategory (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 | Role in appointment | |||||
| 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 Fixed Value: https://pta.kanta.fi/fhir/CodeSystem/fipta-cs-appointmenttypecategory (no extensions allowed) | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 2 (no extensions allowed) | |||||
| display |
1..1 | string | Representation defined by the system | |||||
| actor |
1..1 | Reference(EraAppointmentHealthcareService) {r} | Person, Location/HealthcareService or Device | |||||
| 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). | |||||
| status |
1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Fixed Value: accepted (no extensions allowed) | |||||
| participant:Location |
C | 0..1 | BackboneElement | Service point location Constraints: app-1 | ||||
| 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 | |||||
| type |
1..1 | CodeableConcept | Service point location details Binding: fipta-vs-appointmenttypecategory (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 | Role in appointment | |||||
| 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 Fixed Value: https://pta.kanta.fi/fhir/CodeSystem/fipta-cs-appointmenttypecategory (no extensions allowed) | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 3 (no extensions allowed) | |||||
| display |
1..1 | string | Representation defined by the system | |||||
| actor |
1..1 | Reference(AppointmentLocation) {r} | Person, Location/HealthcareService or Device | |||||
| 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). | |||||
| status |
1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Fixed Value: accepted (no extensions allowed) | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Appointment.meta.security | Base | required | fipta-vs-visible | 📦1.0.0 | This IG |
| Appointment.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Appointment.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Appointment.status | Base | required | fipta-vs-appointmentstatus | 📦1.0.0 | This IG |
| Appointment.cancelationReason | Base | required | fipta-vs-cancelationreason | 📦1.0.0 | This IG |
| Appointment.reasonReference.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Appointment.participant.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Appointment.participant.required | Base | required | ParticipantRequired | 📍4.0.1 | FHIR Std. |
| Appointment.participant.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Appointment.participant:Patient.type | Base | required | fipta-vs-appointmenttypecategory | 📦1.0.0 | This IG |
| Appointment.participant:Patient.actor.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Appointment.participant:Patient.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Appointment.participant:HealthcareService.type | Base | required | fipta-vs-appointmenttypecategory | 📦1.0.0 | This IG |
| Appointment.participant:HealthcareService.actor.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Appointment.participant:HealthcareService.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Appointment.participant:Location.type | Base | required | fipta-vs-appointmenttypecategory | 📦1.0.0 | This IG |
| Appointment.participant:Location.actor.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Appointment.participant:Location.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| PTA-APP-1 | error | Appointment | The end time of the appointment cannot be before the start time of the appointment. |
start.exists() implies start <= end
|
| PTA-APP-2 | error | Appointment | The deadline for cancellation or rescheduling must be given in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. |
Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentMutabilityNotAfter').exists() implies Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentMutabilityNotAfter').value.toString().length()>10
|
| PTA-APP-3 | error | Appointment | The date and time by which the appointment is instructed to take place at the latest must be given in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. |
Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/BookingDeadline').exists() implies Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/BookingDeadline').value.toString().length()>10
|
| PTA-APP-4 | error | Appointment | The appointment identifier (Appointment.identifier) exceeds the allowed maximum length. |
Appointment.identifier.exists() implies Appointment.identifier.system.length()+Appointment.identifier.value.length() < 125
|
| app-1 | error | Appointment.participant, Appointment.participant:Patient, Appointment.participant:HealthcareService, Appointment.participant:Location | Either the type or actor on the participant SHALL be specified |
type.exists() or actor.exists()
|
| app-2 | error | Appointment | Either start and end are specified, or neither |
start.exists() = end.exists()
|
| app-3 | error | Appointment | Only proposed or cancelled appointments can be missing start/end dates |
(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
|
| app-4 | error | Appointment | Cancelation reason is only used for appointments that have been cancelled, or no-show |
Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
|
| dom-2 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Appointment | 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 | Appointment | 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 | Appointment | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Appointment | 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 Appointment
Summary
Mandatory: 17 elements(24 nested mandatory elements)
Fixed: 11 elements
Prohibited: 55 elements
Structures
This structure refers to these other structures:
- AppointmentPatient (https://pta.kanta.fi/fhir/StructureDefinition/AppointmentPatient)
- EraAppointmentHealthcareService (https://eradocumentation.atostek.com/StructureDefinition/EraAppointmentHealthcareService)
- AppointmentLocation (https://pta.kanta.fi/fhir/StructureDefinition/AppointmentLocation)
Extensions
This structure refers to these extensions:
- https://pta.kanta.fi/fhir/StructureDefinition/extension/RemoteServiceURL
- https://pta.kanta.fi/fhir/StructureDefinition/extension/ServiceAdditionalInformation
- https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentReason
- https://pta.kanta.fi/fhir/StructureDefinition/extension/CareplanIdentifier
- https://pta.kanta.fi/fhir/StructureDefinition/extension/NotificationMedium
- https://pta.kanta.fi/fhir/StructureDefinition/extension/CustomerJourney
- https://pta.kanta.fi/fhir/StructureDefinition/extension/SelfServiceInfo
- https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentMutabilityNotAfter
- https://pta.kanta.fi/fhir/StructureDefinition/extension/QueueNo
- https://pta.kanta.fi/fhir/StructureDefinition/extension/TicketNo
- https://pta.kanta.fi/fhir/StructureDefinition/extension/ChildAppointment
- https://pta.kanta.fi/fhir/StructureDefinition/extension/AdditionalInformationURL
- https://pta.kanta.fi/fhir/StructureDefinition/extension/PractitionerGender
- https://pta.kanta.fi/fhir/StructureDefinition/extension/BookingDeadline
- https://pta.kanta.fi/fhir/StructureDefinition/extension/PatientInstructionURL
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of Appointment.participant (Closed)
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Appointment |
C | 0..* | Appointment | Appointment information Constraints: app-2, app-3, app-4, PTA-APP-1, PTA-APP-2, PTA-APP-3, PTA-APP-4 | ||||
| id |
0..1 | id | Unique identifier of the appointment | |||||
| 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/EraAppointmentAppointment (no extensions allowed) | |||||
| security |
0..* | Coding | Display of appointment information Binding: fipta-vs-visible (required) | |||||
| system |
1..1 | uri | Identity of the terminology system | |||||
| code |
1..1 | code | Code value for information on disclosure of a minor's data to guardians | |||||
| display |
1..1 | string | Representation defined by the system | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
1..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Appointment information to be presented in display form. ERA will overwrite this with the correct narrative. This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| extension:remoteServiceURL |
0..1 | url | Link for joining the remote service URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/RemoteServiceURL | |||||
| extension:ServiceAdditionalInformation |
0..1 | string | Additional information on further care or the service process URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/ServiceAdditionalInformation | |||||
| extension:AppointmentReason |
0..1 | (Complex) | Reason for the appointment booking URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentReason | |||||
| extension:CareplanIdentifier |
0..1 | Identifier | Identifier of the plan related to the appointment URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/CareplanIdentifier | |||||
| extension:NotificationMedium |
0..* | Coding | Reminder method URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/NotificationMedium Binding: fipta-vs-notificationmedium (required) | |||||
| extension:CustomerJourney |
0..* | (Complex) | Identification details of the customer's service pathway URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/CustomerJourney | |||||
| extension:SelfServiceInfo |
0..1 | (Complex) | Web address of the e-service and information on the possibility to act on behalf of another person URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/SelfServiceInfo | |||||
| extension:AppointmentMutabilityNotAfter |
0..1 | dateTime | Deadline for cancellation or rescheduling URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentMutabilityNotAfter | |||||
| extension:QueueNo |
0..1 | string | Queue number URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/QueueNo | |||||
| extension:TicketNo |
0..1 | string | Ticket number URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/TicketNo | |||||
| extension:ChildAppointment |
0..* | Identifier | Sub-appointment identifier URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/ChildAppointment | |||||
| extension:AdditionalInformationURL |
0..* | url | Additional information address URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AdditionalInformationURL | |||||
| extension:PractitionerGender |
0..1 | Coding | Gender of the service provider URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/PractitionerGender Binding: fipta-vs-gender (required) | |||||
| extension:BookingDeadline |
0..1 | dateTime | Date and time by which the appointment is instructed to be made at the latest URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/BookingDeadline | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | Appointment identifier. If not provided, ERA will generate one. | |||||
| system |
1..1 | uri | Namespace defined by the organization Example General: http://www.acme.com/identifiers/patient | |||||
| value |
1..1 | string | Appointment identifier Example General: 123456 | |||||
| status |
1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: fipta-vs-appointmentstatus (required) | |||||
| cancelationReason |
0..1 | CodeableConcept | Reason for cancellation of the appointment Binding: fipta-vs-cancelationreason (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 for the reason why the appointment was cancelled | |||||
| display |
1..1 | string | Reason why the appointment was cancelled | |||||
| start |
0..1 | instant | Start time of the appointment time interval | |||||
| end |
0..1 | instant | End time of the appointment time interval | |||||
| comment |
0..1 | string | Additional information | |||||
| patientInstruction |
0..1 | string | Patient instruction | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| extension:PatientInstructionURL |
0..* | url | Link to patient instructions URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/PatientInstructionURL | |||||
| basedOn |
0..* | Reference(ServiceRequest) | Identifier of the referral or request related to the appointment | |||||
| identifier |
1..1 | Identifier | Identifier of the referral or request related to the appointment | |||||
| system |
1..1 | uri | Namespace defined by the organization Example General: http://www.acme.com/identifiers/patient | |||||
| value |
1..1 | string | Referral or request identifier Example General: 123456 | |||||
| Slices for participant |
C | 1..* | BackboneElement | Participants involved in appointment Slice: Unordered, Closed by value:type.coding.code Constraints: app-1 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||
| participant:All Slices |
Content/Rules for all slices | |||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| status |
1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | |||||
| participant:Patient |
C | 1..1 | BackboneElement | Patient or customer Constraints: app-1 | ||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| type |
1..1 | CodeableConcept | Customer for whom the appointment has been booked. Binding: fipta-vs-appointmenttypecategory (required) | |||||
| coding |
1..1 | Coding | Role in appointment | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: https://pta.kanta.fi/fhir/CodeSystem/fipta-cs-appointmenttypecategory (no extensions allowed) | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 (no extensions allowed) | |||||
| display |
1..1 | string | Representation defined by the system | |||||
| actor |
1..1 | Reference(AppointmentPatient) {r} | Person, Location/HealthcareService or Device | |||||
| reference |
C | 1..1 | string | Reference to the resource to be used | ||||
| status |
1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Fixed Value: accepted (no extensions allowed) | |||||
| participant:HealthcareService |
C | 1..1 | BackboneElement | Healthcare service Constraints: app-1 | ||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| type |
1..1 | CodeableConcept | Healthcare service Binding: fipta-vs-appointmenttypecategory (required) | |||||
| coding |
1..1 | Coding | Role in appointment | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: https://pta.kanta.fi/fhir/CodeSystem/fipta-cs-appointmenttypecategory (no extensions allowed) | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 2 (no extensions allowed) | |||||
| display |
1..1 | string | Representation defined by the system | |||||
| actor |
1..1 | Reference(EraAppointmentHealthcareService) {r} | Person, Location/HealthcareService or Device | |||||
| reference |
C | 1..1 | string | Reference to the resource to be used | ||||
| status |
1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Fixed Value: accepted (no extensions allowed) | |||||
| participant:Location |
C | 0..1 | BackboneElement | Service point location Constraints: app-1 | ||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| type |
1..1 | CodeableConcept | Service point location details Binding: fipta-vs-appointmenttypecategory (required) | |||||
| coding |
1..1 | Coding | Role in appointment | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: https://pta.kanta.fi/fhir/CodeSystem/fipta-cs-appointmenttypecategory (no extensions allowed) | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 3 (no extensions allowed) | |||||
| display |
1..1 | string | Representation defined by the system | |||||
| actor |
1..1 | Reference(AppointmentLocation) {r} | Person, Location/HealthcareService or Device | |||||
| reference |
C | 1..1 | string | Reference to the resource to be used | ||||
| status |
1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Fixed Value: accepted (no extensions allowed) | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Appointment.meta.security | Base | required | fipta-vs-visible | 📦1.0.0 | This IG |
| Appointment.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Appointment.status | Base | required | fipta-vs-appointmentstatus | 📦1.0.0 | This IG |
| Appointment.cancelationReason | Base | required | fipta-vs-cancelationreason | 📦1.0.0 | This IG |
| Appointment.participant.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Appointment.participant:Patient.type | Base | required | fipta-vs-appointmenttypecategory | 📦1.0.0 | This IG |
| Appointment.participant:Patient.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Appointment.participant:HealthcareService.type | Base | required | fipta-vs-appointmenttypecategory | 📦1.0.0 | This IG |
| Appointment.participant:HealthcareService.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Appointment.participant:Location.type | Base | required | fipta-vs-appointmenttypecategory | 📦1.0.0 | This IG |
| Appointment.participant:Location.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| PTA-APP-1 | error | Appointment | The end time of the appointment cannot be before the start time of the appointment. |
start.exists() implies start <= end
|
| PTA-APP-2 | error | Appointment | The deadline for cancellation or rescheduling must be given in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. |
Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentMutabilityNotAfter').exists() implies Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentMutabilityNotAfter').value.toString().length()>10
|
| PTA-APP-3 | error | Appointment | The date and time by which the appointment is instructed to take place at the latest must be given in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. |
Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/BookingDeadline').exists() implies Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/BookingDeadline').value.toString().length()>10
|
| PTA-APP-4 | error | Appointment | The appointment identifier (Appointment.identifier) exceeds the allowed maximum length. |
Appointment.identifier.exists() implies Appointment.identifier.system.length()+Appointment.identifier.value.length() < 125
|
| app-1 | error | Appointment.participant, Appointment.participant:Patient, Appointment.participant:HealthcareService, Appointment.participant:Location | Either the type or actor on the participant SHALL be specified |
type.exists() or actor.exists()
|
| app-2 | error | Appointment | Either start and end are specified, or neither |
start.exists() = end.exists()
|
| app-3 | error | Appointment | Only proposed or cancelled appointments can be missing start/end dates |
(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
|
| app-4 | error | Appointment | Cancelation reason is only used for appointments that have been cancelled, or no-show |
Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
|
| dom-2 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Appointment | 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 | Appointment | 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 | Appointment | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Appointment | 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 Appointment
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Appointment |
C | 0..* | Appointment | Appointment information Constraints: PTA-APP-1, PTA-APP-2, PTA-APP-3, PTA-APP-4 |
| id |
0..1 | id | Unique identifier of the appointment | |
| 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/EraAppointmentAppointment (no extensions allowed) | |
| security |
0..* | Coding | Display of appointment information Binding: fipta-vs-visible (required) | |
| 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 | Code value for information on disclosure of a minor's data to guardians | |
| display |
1..1 | string | Representation defined by the system | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| language |
1..1 | code | Language of the resource content | |
| text |
0..1 | Narrative | Appointment information to be presented in display form. ERA will overwrite this with the correct narrative. | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:remoteServiceURL |
0..1 | url | Link for joining the remote service URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/RemoteServiceURL | |
| extension:ServiceAdditionalInformation |
0..1 | string | Additional information on further care or the service process URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/ServiceAdditionalInformation | |
| extension:AppointmentReason |
0..1 | (Complex) | Reason for the appointment booking URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentReason | |
| extension:CareplanIdentifier |
0..1 | Identifier | Identifier of the plan related to the appointment URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/CareplanIdentifier | |
| extension:NotificationMedium |
0..* | Coding | Reminder method URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/NotificationMedium Binding: fipta-vs-notificationmedium (required) | |
| extension:CustomerJourney |
0..* | (Complex) | Identification details of the customer's service pathway URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/CustomerJourney | |
| extension:SelfServiceInfo |
0..1 | (Complex) | Web address of the e-service and information on the possibility to act on behalf of another person URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/SelfServiceInfo | |
| extension:AppointmentMutabilityNotAfter |
0..1 | dateTime | Deadline for cancellation or rescheduling URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentMutabilityNotAfter | |
| extension:QueueNo |
0..1 | string | Queue number URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/QueueNo | |
| extension:TicketNo |
0..1 | string | Ticket number URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/TicketNo | |
| extension:ChildAppointment |
0..* | Identifier | Sub-appointment identifier URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/ChildAppointment | |
| extension:AdditionalInformationURL |
0..* | url | Additional information address URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AdditionalInformationURL | |
| extension:PractitionerGender |
0..1 | Coding | Gender of the service provider URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/PractitionerGender Binding: fipta-vs-gender (required) | |
| extension:BookingDeadline |
0..1 | dateTime | Date and time by which the appointment is instructed to be made at the latest URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/BookingDeadline | |
| identifier |
0..* | Identifier | Appointment identifier. If not provided, ERA will generate one. | |
| id |
0..0 | Unique id for inter-element referencing | ||
| use |
0..0 | usual | official | temp | secondary | old (If known) | ||
| type |
0..0 | Description of identifier | ||
| system |
1..1 | uri | Namespace defined by the organization | |
| value |
1..1 | string | Appointment identifier | |
| period |
0..0 | Time period when id is/was valid for use | ||
| assigner |
0..0 | Organization that issued id (may be just text) | ||
| status |
1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: fipta-vs-appointmentstatus (required) | |
| cancelationReason |
0..1 | CodeableConcept | Reason for cancellation of the appointment Binding: fipta-vs-cancelationreason (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 for the reason why the appointment was cancelled | |
| display |
1..1 | string | Reason why the appointment was cancelled | |
| userSelected |
0..0 | If this coding was chosen directly by the user | ||
| text |
0..0 | Plain text representation of the concept | ||
| serviceCategory |
0..0 | Service category | ||
| serviceType |
0..0 | Service name | ||
| specialty |
0..0 | The specialty of a practitioner that would be required to perform the service requested in this appointment | ||
| appointmentType |
0..0 | The style of appointment or patient that has been booked in the slot (not service type) | ||
| reasonCode |
0..0 | Coded reason this appointment is scheduled | ||
| reasonReference |
0..0 | Description of symptoms, the main reason for contact, and a description of the customer's risk information | ||
| priority |
0..0 | Used to make informed decisions if needing to re-prioritize | ||
| description |
0..0 | Shown on a subject line in a meeting request, or appointment list | ||
| supportingInformation |
0..0 | Additional information to support the appointment | ||
| start |
0..1 | instant | Start time of the appointment time interval | |
| end |
0..1 | instant | End time of the appointment time interval | |
| minutesDuration |
0..0 | Can be less than start/end (e.g. estimate) | ||
| slot |
0..0 | The slots that this appointment is filling | ||
| created |
0..0 | The date that this appointment was initially created | ||
| comment |
0..1 | string | Additional information | |
| patientInstruction |
0..1 | string | Patient instruction | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:PatientInstructionURL |
0..* | url | Link to patient instructions URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/PatientInstructionURL | |
| basedOn |
0..* | Reference(ServiceRequest) | Identifier of the referral or request related to the appointment | |
| reference |
0..0 | Literal reference, Relative, internal or absolute URL | ||
| type |
0..0 | Type the reference refers to (e.g. "Patient") | ||
| identifier |
1..1 | Identifier | Identifier of the referral or request related to the appointment | |
| use |
0..0 | usual | official | temp | secondary | old (If known) | ||
| type |
0..0 | Description of identifier | ||
| system |
1..1 | uri | Namespace defined by the organization | |
| value |
1..1 | string | Referral or request identifier | |
| period |
0..0 | Time period when id is/was valid for use | ||
| assigner |
0..0 | Organization that issued id (may be just text) | ||
| display |
0..0 | Text alternative for the resource | ||
| Slices for participant |
1..* | BackboneElement | Participants involved in appointment Slice: Unordered, Closed by value:type.coding.code Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| participant:Patient |
1..1 | BackboneElement | Patient or customer | |
| type |
1..1 | CodeableConcept | Customer for whom the appointment has been booked. Binding: fipta-vs-appointmenttypecategory (required) | |
| coding |
1..1 | Coding | Role in appointment | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: https://pta.kanta.fi/fhir/CodeSystem/fipta-cs-appointmenttypecategory (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 (no extensions allowed) | |
| 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 | ||
| actor |
1..1 | Reference(AppointmentPatient) {r} | Person, Location/HealthcareService or Device | |
| 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 | ||
| required |
0..0 | required | optional | information-only | ||
| status |
1..1 | code | accepted | declined | tentative | needs-action Fixed Value: accepted (no extensions allowed) | |
| period |
0..0 | Participation period of the actor | ||
| participant:HealthcareService |
1..1 | BackboneElement | Healthcare service | |
| type |
1..1 | CodeableConcept | Healthcare service Binding: fipta-vs-appointmenttypecategory (required) | |
| coding |
1..1 | Coding | Role in appointment | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: https://pta.kanta.fi/fhir/CodeSystem/fipta-cs-appointmenttypecategory (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 2 (no extensions allowed) | |
| 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 | ||
| actor |
1..1 | Reference(EraAppointmentHealthcareService) {r} | Person, Location/HealthcareService or Device | |
| 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 | ||
| required |
0..0 | required | optional | information-only | ||
| status |
1..1 | code | accepted | declined | tentative | needs-action Fixed Value: accepted (no extensions allowed) | |
| period |
0..0 | Participation period of the actor | ||
| participant:Location |
0..1 | BackboneElement | Service point location | |
| type |
1..1 | CodeableConcept | Service point location details Binding: fipta-vs-appointmenttypecategory (required) | |
| coding |
1..1 | Coding | Role in appointment | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: https://pta.kanta.fi/fhir/CodeSystem/fipta-cs-appointmenttypecategory (no extensions allowed) | |
| version |
0..0 | Version of the system - if relevant | ||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 3 (no extensions allowed) | |
| 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 | ||
| actor |
1..1 | Reference(AppointmentLocation) {r} | Person, Location/HealthcareService or Device | |
| 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 | ||
| required |
0..0 | required | optional | information-only | ||
| status |
1..1 | code | accepted | declined | tentative | needs-action Fixed Value: accepted (no extensions allowed) | |
| period |
0..0 | Participation period of the actor | ||
| requestedPeriod |
0..0 | Potential date/time interval(s) requested to allocate the appointment within | ||
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Status | Usage | ValueSet | Version | Source |
| Appointment.meta.security | Base | required | fipta-vs-visible | 📦1.0.0 | This IG |
| Appointment.status | Base | required | fipta-vs-appointmentstatus | 📦1.0.0 | This IG |
| Appointment.cancelationReason | Base | required | fipta-vs-cancelationreason | 📦1.0.0 | This IG |
| Appointment.participant:Patient.type | Base | required | fipta-vs-appointmenttypecategory | 📦1.0.0 | This IG |
| Appointment.participant:HealthcareService.type | Base | required | fipta-vs-appointmenttypecategory | 📦1.0.0 | This IG |
| Appointment.participant:Location.type | Base | required | fipta-vs-appointmenttypecategory | 📦1.0.0 | This IG |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| PTA-APP-1 | error | Appointment | The end time of the appointment cannot be before the start time of the appointment. |
start.exists() implies start <= end
|
| PTA-APP-2 | error | Appointment | The deadline for cancellation or rescheduling must be given in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. |
Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentMutabilityNotAfter').exists() implies Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentMutabilityNotAfter').value.toString().length()>10
|
| PTA-APP-3 | error | Appointment | The date and time by which the appointment is instructed to take place at the latest must be given in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. |
Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/BookingDeadline').exists() implies Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/BookingDeadline').value.toString().length()>10
|
| PTA-APP-4 | error | Appointment | The appointment identifier (Appointment.identifier) exceeds the allowed maximum length. |
Appointment.identifier.exists() implies Appointment.identifier.system.length()+Appointment.identifier.value.length() < 125
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Appointment |
C | 0..* | Appointment | Appointment information Constraints: app-2, app-3, app-4, PTA-APP-1, PTA-APP-2, PTA-APP-3, PTA-APP-4 | ||||
| id |
0..1 | id | Unique identifier of the appointment | |||||
| 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/EraAppointmentAppointment (no extensions allowed) | |||||
| security |
0..* | Coding | Display of appointment information Binding: fipta-vs-visible (required) | |||||
| 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 for information on disclosure of a minor's data to guardians | |||||
| display |
1..1 | string | Representation defined by the 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 |
1..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Appointment information to be presented in display form. ERA will overwrite this with the correct narrative. 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:remoteServiceURL |
0..1 | url | Link for joining the remote service URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/RemoteServiceURL | |||||
| extension:ServiceAdditionalInformation |
0..1 | string | Additional information on further care or the service process URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/ServiceAdditionalInformation | |||||
| extension:AppointmentReason |
0..1 | (Complex) | Reason for the appointment booking URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentReason | |||||
| extension:CareplanIdentifier |
0..1 | Identifier | Identifier of the plan related to the appointment URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/CareplanIdentifier | |||||
| extension:NotificationMedium |
0..* | Coding | Reminder method URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/NotificationMedium Binding: fipta-vs-notificationmedium (required) | |||||
| extension:CustomerJourney |
0..* | (Complex) | Identification details of the customer's service pathway URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/CustomerJourney | |||||
| extension:SelfServiceInfo |
0..1 | (Complex) | Web address of the e-service and information on the possibility to act on behalf of another person URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/SelfServiceInfo | |||||
| extension:AppointmentMutabilityNotAfter |
0..1 | dateTime | Deadline for cancellation or rescheduling URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentMutabilityNotAfter | |||||
| extension:QueueNo |
0..1 | string | Queue number URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/QueueNo | |||||
| extension:TicketNo |
0..1 | string | Ticket number URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/TicketNo | |||||
| extension:ChildAppointment |
0..* | Identifier | Sub-appointment identifier URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/ChildAppointment | |||||
| extension:AdditionalInformationURL |
0..* | url | Additional information address URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/AdditionalInformationURL | |||||
| extension:PractitionerGender |
0..1 | Coding | Gender of the service provider URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/PractitionerGender Binding: fipta-vs-gender (required) | |||||
| extension:BookingDeadline |
0..1 | dateTime | Date and time by which the appointment is instructed to be made at the latest URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/BookingDeadline | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | Appointment identifier. If not provided, ERA will generate one. | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
1..1 | uri | Namespace defined by the organization Example General: http://www.acme.com/identifiers/patient | |||||
| value |
1..1 | string | Appointment identifier Example General: 123456 | |||||
| status |
1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: fipta-vs-appointmentstatus (required) | |||||
| cancelationReason |
0..1 | CodeableConcept | Reason for cancellation of the appointment Binding: fipta-vs-cancelationreason (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 for the reason why the appointment was cancelled | |||||
| display |
1..1 | string | Reason why the appointment was cancelled | |||||
| start |
0..1 | instant | Start time of the appointment time interval | |||||
| end |
0..1 | instant | End time of the appointment time interval | |||||
| comment |
0..1 | string | Additional information | |||||
| patientInstruction |
0..1 | string | Patient instruction | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:PatientInstructionURL |
0..* | url | Link to patient instructions URL: https://pta.kanta.fi/fhir/StructureDefinition/extension/PatientInstructionURL | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| basedOn |
0..* | Reference(ServiceRequest) | Identifier of the referral or request related to the appointment | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| identifier |
1..1 | Identifier | Identifier of the referral or request related to the appointment | |||||
| 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 | Namespace defined by the organization Example General: http://www.acme.com/identifiers/patient | |||||
| value |
1..1 | string | Referral or request identifier Example General: 123456 | |||||
| Slices for participant |
C | 1..* | BackboneElement | Participants involved in appointment Slice: Unordered, Closed by value:type.coding.code Constraints: app-1 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||
| participant:All Slices |
Content/Rules for all slices | |||||||
| 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 | |||||
| type |
0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | |||||
| actor |
0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | Person, Location/HealthcareService or Device | |||||
| required |
0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. | |||||
| status |
1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | |||||
| period |
0..1 | Period | Participation period of the actor | |||||
| participant:Patient |
C | 1..1 | BackboneElement | Patient or customer Constraints: app-1 | ||||
| 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 | |||||
| type |
1..1 | CodeableConcept | Customer for whom the appointment has been booked. Binding: fipta-vs-appointmenttypecategory (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 | Role in appointment | |||||
| 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 Fixed Value: https://pta.kanta.fi/fhir/CodeSystem/fipta-cs-appointmenttypecategory (no extensions allowed) | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 1 (no extensions allowed) | |||||
| display |
1..1 | string | Representation defined by the system | |||||
| actor |
1..1 | Reference(AppointmentPatient) {r} | Person, Location/HealthcareService or Device | |||||
| 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). | |||||
| status |
1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Fixed Value: accepted (no extensions allowed) | |||||
| participant:HealthcareService |
C | 1..1 | BackboneElement | Healthcare service Constraints: app-1 | ||||
| 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 | |||||
| type |
1..1 | CodeableConcept | Healthcare service Binding: fipta-vs-appointmenttypecategory (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 | Role in appointment | |||||
| 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 Fixed Value: https://pta.kanta.fi/fhir/CodeSystem/fipta-cs-appointmenttypecategory (no extensions allowed) | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 2 (no extensions allowed) | |||||
| display |
1..1 | string | Representation defined by the system | |||||
| actor |
1..1 | Reference(EraAppointmentHealthcareService) {r} | Person, Location/HealthcareService or Device | |||||
| 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). | |||||
| status |
1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Fixed Value: accepted (no extensions allowed) | |||||
| participant:Location |
C | 0..1 | BackboneElement | Service point location Constraints: app-1 | ||||
| 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 | |||||
| type |
1..1 | CodeableConcept | Service point location details Binding: fipta-vs-appointmenttypecategory (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 | Role in appointment | |||||
| 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 Fixed Value: https://pta.kanta.fi/fhir/CodeSystem/fipta-cs-appointmenttypecategory (no extensions allowed) | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 3 (no extensions allowed) | |||||
| display |
1..1 | string | Representation defined by the system | |||||
| actor |
1..1 | Reference(AppointmentLocation) {r} | Person, Location/HealthcareService or Device | |||||
| 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). | |||||
| status |
1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. Fixed Value: accepted (no extensions allowed) | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Status | Usage | ValueSet | Version | Source |
| Appointment.meta.security | Base | required | fipta-vs-visible | 📦1.0.0 | This IG |
| Appointment.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Appointment.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Appointment.status | Base | required | fipta-vs-appointmentstatus | 📦1.0.0 | This IG |
| Appointment.cancelationReason | Base | required | fipta-vs-cancelationreason | 📦1.0.0 | This IG |
| Appointment.reasonReference.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Appointment.participant.type | Base | extensible | Participant type | 📍4.0.1 | FHIR Std. |
| Appointment.participant.required | Base | required | ParticipantRequired | 📍4.0.1 | FHIR Std. |
| Appointment.participant.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Appointment.participant:Patient.type | Base | required | fipta-vs-appointmenttypecategory | 📦1.0.0 | This IG |
| Appointment.participant:Patient.actor.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Appointment.participant:Patient.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Appointment.participant:HealthcareService.type | Base | required | fipta-vs-appointmenttypecategory | 📦1.0.0 | This IG |
| Appointment.participant:HealthcareService.actor.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Appointment.participant:HealthcareService.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
| Appointment.participant:Location.type | Base | required | fipta-vs-appointmenttypecategory | 📦1.0.0 | This IG |
| Appointment.participant:Location.actor.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Appointment.participant:Location.status | Base | required | ParticipationStatus | 📍4.0.1 | FHIR Std. |
Constraints
| Id | Grade | Path(s) | Description | Expression |
| PTA-APP-1 | error | Appointment | The end time of the appointment cannot be before the start time of the appointment. |
start.exists() implies start <= end
|
| PTA-APP-2 | error | Appointment | The deadline for cancellation or rescheduling must be given in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. |
Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentMutabilityNotAfter').exists() implies Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentMutabilityNotAfter').value.toString().length()>10
|
| PTA-APP-3 | error | Appointment | The date and time by which the appointment is instructed to take place at the latest must be given in the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. |
Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/BookingDeadline').exists() implies Appointment.extension.where(url='https://pta.kanta.fi/fhir/StructureDefinition/extension/BookingDeadline').value.toString().length()>10
|
| PTA-APP-4 | error | Appointment | The appointment identifier (Appointment.identifier) exceeds the allowed maximum length. |
Appointment.identifier.exists() implies Appointment.identifier.system.length()+Appointment.identifier.value.length() < 125
|
| app-1 | error | Appointment.participant, Appointment.participant:Patient, Appointment.participant:HealthcareService, Appointment.participant:Location | Either the type or actor on the participant SHALL be specified |
type.exists() or actor.exists()
|
| app-2 | error | Appointment | Either start and end are specified, or neither |
start.exists() = end.exists()
|
| app-3 | error | Appointment | Only proposed or cancelled appointments can be missing start/end dates |
(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
|
| app-4 | error | Appointment | Cancelation reason is only used for appointments that have been cancelled, or no-show |
Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled')
|
| dom-2 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Appointment | 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 | Appointment | 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 | Appointment | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Appointment | 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 Appointment
Summary
Mandatory: 17 elements(24 nested mandatory elements)
Fixed: 11 elements
Prohibited: 55 elements
Structures
This structure refers to these other structures:
- AppointmentPatient (https://pta.kanta.fi/fhir/StructureDefinition/AppointmentPatient)
- EraAppointmentHealthcareService (https://eradocumentation.atostek.com/StructureDefinition/EraAppointmentHealthcareService)
- AppointmentLocation (https://pta.kanta.fi/fhir/StructureDefinition/AppointmentLocation)
Extensions
This structure refers to these extensions:
- https://pta.kanta.fi/fhir/StructureDefinition/extension/RemoteServiceURL
- https://pta.kanta.fi/fhir/StructureDefinition/extension/ServiceAdditionalInformation
- https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentReason
- https://pta.kanta.fi/fhir/StructureDefinition/extension/CareplanIdentifier
- https://pta.kanta.fi/fhir/StructureDefinition/extension/NotificationMedium
- https://pta.kanta.fi/fhir/StructureDefinition/extension/CustomerJourney
- https://pta.kanta.fi/fhir/StructureDefinition/extension/SelfServiceInfo
- https://pta.kanta.fi/fhir/StructureDefinition/extension/AppointmentMutabilityNotAfter
- https://pta.kanta.fi/fhir/StructureDefinition/extension/QueueNo
- https://pta.kanta.fi/fhir/StructureDefinition/extension/TicketNo
- https://pta.kanta.fi/fhir/StructureDefinition/extension/ChildAppointment
- https://pta.kanta.fi/fhir/StructureDefinition/extension/AdditionalInformationURL
- https://pta.kanta.fi/fhir/StructureDefinition/extension/PractitionerGender
- https://pta.kanta.fi/fhir/StructureDefinition/extension/BookingDeadline
- https://pta.kanta.fi/fhir/StructureDefinition/extension/PatientInstructionURL
Slices
This structure defines the following Slices:
- The element 1 is sliced based on the value of Appointment.participant (Closed)
Other representations of profile: CSV, Excel, Schematron