AddCommunication Implementation Guide
2.2 - version 2.2
AddCommunication Implementation Guide
2.2 - version 2.2
This page is part of the Release of AddCommunication IG (v2.2: Release) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions
| Official URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/ReminderAppointment | Version: 2.2 | |||
| Draft as of 2025-02-04 | Computable Name: ReminderAppointment | |||
Profile to hold information about appointments related to a reminder
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Appointment |
C | 0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-4: Cancellation reason is only used for appointments that have been cancelled, or noshow app-5: The start must be less than or equal to the end app-6: An appointment may have an originatingAppointment or recurrenceTemplate, but not both app-7: Cancellation date is only used for appointments that have been cancelled, or noshow dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| contained |
0..* | Resource | Contained, inline Resources | |
  Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
   CareServiceCode |
1..1 | (Complex) | Care Service Code URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceCode ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
  extension |
0..0 | |||
| url |
1..1 | uri | "http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceCode" | |
  Slices for value[x] |
1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children | |
  value[x]:valueCodeableConcept |
1..1 | CodeableConcept | Codable concept for Care service code ele-1: All FHIR elements must have a @value or children | |
 CareServiceArea |
1..1 | (Complex) | Care Service Area URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceArea ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceArea" | |
| Slices for value[x] |
1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children | |
| value[x]:valueCodeableConcept |
1..1 | CodeableConcept | Codable concept for Care service area ele-1: All FHIR elements must have a @value or children | |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| status |
?!ΣC | 1..1 | code | Status of the apppointment. Not used by API Binding: AppointmentStatus (required): The free/busy status of an appointment. ele-1: All FHIR elements must have a @value or children |
 appointmentType |
Σ | 1..1 | CodeableConcept | Type of appointment CLINIC|PHONE|VIDEO|OTHER Binding: Kalla Apppointment Types (required) ele-1: All FHIR elements must have a @value or children |
| start |
ΣC | 1..1 | instant | Appointment start time ele-1: All FHIR elements must have a @value or children |
| end |
ΣC | 1..1 | instant | Apponintment end time ele-1: All FHIR elements must have a @value or children |
| minutesDuration |
1..1 | positiveInt | Duration in minutes ele-1: All FHIR elements must have a @value or children | |
 participant |
C | 1..1 | BackboneElement | Participating HealthCareService app-1: Either the type or actor on the participant SHALL be specified ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 actor |
ΣC | 1..1 | Reference(HealthcareService) | Reference to HealthCareService ele-1: All FHIR elements must have a @value or children |
 status |
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Appointment.status | required | AppointmentStatushttp://hl7.org/fhir/ValueSet/appointmentstatus|5.0.0from the FHIR Standard | |
| Appointment.appointmentType | required | KallaAppointmentTypehttp://bki.skane.se/invanartjanster/fhir/ValueSet/appointment-typefrom this IG | |
| Appointment.participant.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|5.0.0from the FHIR Standard |
This structure is derived from Appointment
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Appointment |
Appointment | |||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
| CareServiceCode |
1..1 | (Complex) | Care Service Code URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceCode | |
| Slices for value[x] |
Content/Rules for all slices | |||
| value[x]:valueCodeableConcept |
1..1 | CodeableConcept | Codable concept for Care service code | |
 coding |
||||
| system |
0..1 | uri | Code System | |
| code |
1..1 | code | Code | |
| display |
0..1 | string | Display value | |
| CareServiceArea |
1..1 | (Complex) | Care Service Area URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceArea | |
| Slices for value[x] |
Content/Rules for all slices | |||
| value[x]:valueCodeableConcept |
1..1 | CodeableConcept | Codable concept for Care service area | |
| coding |
||||
| system |
0..1 | uri | Code System | |
| code |
1..1 | code | Code | |
| display |
0..1 | string | Display value | |
| status |
1..1 | code | Status of the apppointment. Not used by API | |
| appointmentType |
1..1 | CodeableConcept | Type of appointment CLINIC|PHONE|VIDEO|OTHER Binding: Kalla Apppointment Types (required) | |
| start |
1..1 | instant | Appointment start time | |
| end |
1..1 | instant | Apponintment end time | |
| minutesDuration |
1..1 | positiveInt | Duration in minutes | |
| participant |
1..1 | BackboneElement | Participating HealthCareService | |
| actor |
1..1 | Reference(HealthcareService) | Reference to HealthCareService | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Appointment.appointmentType | required | KallaAppointmentTypehttp://bki.skane.se/invanartjanster/fhir/ValueSet/appointment-typefrom this IG |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Appointment |
C | 0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-4: Cancellation reason is only used for appointments that have been cancelled, or noshow app-5: The start must be less than or equal to the end app-6: An appointment may have an originatingAppointment or recurrenceTemplate, but not both app-7: Cancellation date is only used for appointments that have been cancelled, or noshow | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| CareServiceCode |
1..1 | (Complex) | Care Service Code URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceCode | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceCode" | |||||
| Slices for value[x] |
1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
| value[x]:valueCodeableConcept |
1..1 | CodeableConcept | Codable concept for Care service code | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
 coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
 id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 0..1 | uri | Code System | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
ΣC | 1..1 | code | Code | ||||
| display |
ΣC | 0..1 | string | Display value | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
 text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| CareServiceArea |
1..1 | (Complex) | Care Service Area URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceArea | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceArea" | |||||
| Slices for value[x] |
1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
| value[x]:valueCodeableConcept |
1..1 | CodeableConcept | Codable concept for Care service area | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 0..1 | uri | Code System | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
ΣC | 1..1 | code | Code Binding: https://tirs.skane.se/sdv-millennium/id/codevalueset/34 (required) | ||||
| display |
ΣC | 0..1 | string | Display value | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | External Ids for this item | ||||
| status |
?!ΣC | 1..1 | code | Status of the apppointment. Not used by API Binding: AppointmentStatus (required): The free/busy status of an appointment. | ||||
| cancellationReason |
ΣC | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example) | ||||
| class |
Σ | 0..* | CodeableConcept | Classification when becoming an encounter Binding: http://terminology.hl7.org/ValueSet/EncounterClass (preferred): Classification of the encounter. | ||||
| serviceCategory |
Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) | ||||
| serviceType |
Σ | 0..* | CodeableReference(HealthcareService) | The specific service that is to be performed during this appointment Binding: ServiceType (example) | ||||
| specialty |
Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred) | ||||
| appointmentType |
Σ | 1..1 | CodeableConcept | Type of appointment CLINIC|PHONE|VIDEO|OTHER Binding: Kalla Apppointment Types (required) | ||||
| reason |
Σ | 0..* | CodeableReference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. | ||||
| priority |
0..1 | CodeableConcept | Used to make informed decisions if needing to re-prioritize Binding: ActPriority (example): Indicates the urgency of the appointment. | |||||
| description |
0..1 | string | Shown on a subject line in a meeting request, or appointment list | |||||
| replaces |
0..* | Reference(Appointment) | Appointment replaced by this Appointment | |||||
| virtualService |
0..* | VirtualServiceDetail | Connection details of a virtual service (e.g. conference call) | |||||
| supportingInformation |
0..* | Reference(Resource) | Additional information to support the appointment | |||||
| previousAppointment |
0..1 | Reference(Appointment) | The previous appointment in a series | |||||
| originatingAppointment |
C | 0..1 | Reference(Appointment) | The originating appointment in a recurring set of appointments | ||||
| start |
ΣC | 1..1 | instant | Appointment start time | ||||
| end |
ΣC | 1..1 | instant | Apponintment end time | ||||
| minutesDuration |
1..1 | positiveInt | Duration in minutes | |||||
| requestedPeriod |
0..* | Period | Potential date/time interval(s) requested to allocate the appointment within | |||||
| slot |
0..* | Reference(Slot) | The slots that this appointment is filling | |||||
| account |
0..* | Reference(Account) | The set of accounts that may be used for billing for this Appointment | |||||
| created |
0..1 | dateTime | The date that this appointment was initially created | |||||
| cancellationDate |
C | 0..1 | dateTime | When the appointment was cancelled | ||||
| note |
0..* | Annotation | Additional comments | |||||
| patientInstruction |
0..* | CodeableReference(DocumentReference | Binary | Communication) | Detailed information and instructions for the patient | |||||
| basedOn |
0..* | Reference(CarePlan | DeviceRequest | MedicationRequest | ServiceRequest) | The request this appointment is allocated to assess | |||||
| subject |
Σ | 0..1 | Reference(Patient | Group) | The patient or group associated with the appointment | ||||
| participant |
C | 1..1 | BackboneElement | Participating HealthCareService app-1: Either the type or actor on the participant SHALL be specified | ||||
| 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 |
ΣC | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
| period |
0..1 | Period | Participation period of the actor | |||||
| actor |
ΣC | 1..1 | Reference(HealthcareService) | Reference to HealthCareService | ||||
| required |
Σ | 0..1 | boolean | The participant is required to attend (optional when false) | ||||
| status |
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | ||||
| recurrenceId |
0..1 | positiveInt | The sequence number in the recurrence | |||||
| occurrenceChanged |
0..1 | boolean | Indicates that this appointment varies from a recurrence pattern | |||||
| recurrenceTemplate |
C | 0..* | BackboneElement | Details of the recurrence pattern/template used to generate occurrences | ||||
| 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 | ||||
| timezone |
0..1 | CodeableConcept | The timezone of the occurrences Binding: IANATimezones (required): IANA Timezones (BCP 175) | |||||
| recurrenceType |
1..1 | CodeableConcept | The frequency of the recurrence Binding: AppointmentRecurrenceType (preferred): IANA Timezones (BCP 175) | |||||
| lastOccurrenceDate |
0..1 | date | The date when the recurrence should end | |||||
| occurrenceCount |
0..1 | positiveInt | The number of planned occurrences | |||||
| occurrenceDate |
0..* | date | Specific dates for a recurring set of appointments (no template) | |||||
| weeklyTemplate |
0..1 | BackboneElement | Information about weekly recurring appointments | |||||
| 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 | ||||
| monday |
0..1 | boolean | Recurs on Mondays | |||||
| tuesday |
0..1 | boolean | Recurs on Tuesday | |||||
| wednesday |
0..1 | boolean | Recurs on Wednesday | |||||
| thursday |
0..1 | boolean | Recurs on Thursday | |||||
| friday |
0..1 | boolean | Recurs on Friday | |||||
| saturday |
0..1 | boolean | Recurs on Saturday | |||||
| sunday |
0..1 | boolean | Recurs on Sunday | |||||
| weekInterval |
0..1 | positiveInt | Recurs every nth week | |||||
| monthlyTemplate |
0..1 | BackboneElement | Information about monthly recurring appointments | |||||
| 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 | ||||
| dayOfMonth |
0..1 | positiveInt | Recurs on a specific day of the month | |||||
| nthWeekOfMonth |
0..1 | Coding | Indicates which week of the month the appointment should occur Binding: WeekOfMonth (required): The set of weeks in a month. | |||||
| dayOfWeek |
0..1 | Coding | Indicates which day of the week the appointment should occur Binding: DaysOfWeek (required): The days of the week. | |||||
| monthInterval |
1..1 | positiveInt | Recurs every nth month | |||||
| yearlyTemplate |
0..1 | BackboneElement | Information about yearly recurring appointments | |||||
| 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 | ||||
| yearInterval |
1..1 | positiveInt | Recurs every nth year | |||||
| excludingDate |
0..* | date | Any dates that should be excluded from the series | |||||
| excludingRecurrenceId |
0..* | positiveInt | Any recurrence IDs that should be excluded from the recurrence | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI |
| Appointment.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0from the FHIR Standard | |
| Appointment.extension:CareServiceArea.value[x]:valueCodeableConcept.coding.code | required | https://tirs.skane.se/sdv-millennium/id/codevalueset/34https://tirs.skane.se/sdv-millennium/id/codevalueset/34 | |
| Appointment.status | required | AppointmentStatushttp://hl7.org/fhir/ValueSet/appointmentstatus|5.0.0from the FHIR Standard | |
| Appointment.cancellationReason | example | AppointmentCancellationReasonhttp://hl7.org/fhir/ValueSet/appointment-cancellation-reasonfrom the FHIR Standard | |
| Appointment.class | preferred | http://terminology.hl7.org/ValueSet/EncounterClasshttp://terminology.hl7.org/ValueSet/EncounterClass | |
| Appointment.serviceCategory | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-categoryfrom the FHIR Standard | |
| Appointment.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-typefrom the FHIR Standard | |
| Appointment.specialty | preferred | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codesfrom the FHIR Standard | |
| Appointment.appointmentType | required | KallaAppointmentTypehttp://bki.skane.se/invanartjanster/fhir/ValueSet/appointment-typefrom this IG | |
| Appointment.reason | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reasonfrom the FHIR Standard | |
| Appointment.priority | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
| Appointment.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-typefrom the FHIR Standard | |
| Appointment.participant.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|5.0.0from the FHIR Standard | |
| Appointment.recurrenceTemplate.timezone | required | IANATimezoneshttp://hl7.org/fhir/ValueSet/timezones|5.0.0from the FHIR Standard | |
| Appointment.recurrenceTemplate.recurrenceType | preferred | AppointmentRecurrenceTypehttp://hl7.org/fhir/ValueSet/appointment-recurrrence-typefrom the FHIR Standard | |
| Appointment.recurrenceTemplate.monthlyTemplate.nthWeekOfMonth | required | WeekOfMonthhttp://hl7.org/fhir/ValueSet/week-of-month|5.0.0from the FHIR Standard | |
| Appointment.recurrenceTemplate.monthlyTemplate.dayOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|5.0.0from the FHIR Standard |
This structure is derived from Appointment
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Appointment |
C | 0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-4: Cancellation reason is only used for appointments that have been cancelled, or noshow app-5: The start must be less than or equal to the end app-6: An appointment may have an originatingAppointment or recurrenceTemplate, but not both app-7: Cancellation date is only used for appointments that have been cancelled, or noshow dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| contained |
0..* | Resource | Contained, inline Resources | |
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| CareServiceCode |
1..1 | (Complex) | Care Service Code URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceCode ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceCode" | |
| Slices for value[x] |
1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children | |
| value[x]:valueCodeableConcept |
1..1 | CodeableConcept | Codable concept for Care service code ele-1: All FHIR elements must have a @value or children | |
| CareServiceArea |
1..1 | (Complex) | Care Service Area URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceArea ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceArea" | |
| Slices for value[x] |
1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children | |
| value[x]:valueCodeableConcept |
1..1 | CodeableConcept | Codable concept for Care service area ele-1: All FHIR elements must have a @value or children | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| status |
?!ΣC | 1..1 | code | Status of the apppointment. Not used by API Binding: AppointmentStatus (required): The free/busy status of an appointment. ele-1: All FHIR elements must have a @value or children |
| appointmentType |
Σ | 1..1 | CodeableConcept | Type of appointment CLINIC|PHONE|VIDEO|OTHER Binding: Kalla Apppointment Types (required) ele-1: All FHIR elements must have a @value or children |
| start |
ΣC | 1..1 | instant | Appointment start time ele-1: All FHIR elements must have a @value or children |
| end |
ΣC | 1..1 | instant | Apponintment end time ele-1: All FHIR elements must have a @value or children |
| minutesDuration |
1..1 | positiveInt | Duration in minutes ele-1: All FHIR elements must have a @value or children | |
| participant |
C | 1..1 | BackboneElement | Participating HealthCareService app-1: Either the type or actor on the participant SHALL be specified ele-1: All FHIR elements must have a @value or children |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| actor |
ΣC | 1..1 | Reference(HealthcareService) | Reference to HealthCareService ele-1: All FHIR elements must have a @value or children |
| status |
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Appointment.status | required | AppointmentStatushttp://hl7.org/fhir/ValueSet/appointmentstatus|5.0.0from the FHIR Standard | |
| Appointment.appointmentType | required | KallaAppointmentTypehttp://bki.skane.se/invanartjanster/fhir/ValueSet/appointment-typefrom this IG | |
| Appointment.participant.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|5.0.0from the FHIR Standard |
Differential View
This structure is derived from Appointment
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Appointment |
Appointment | |||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
| CareServiceCode |
1..1 | (Complex) | Care Service Code URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceCode | |
| Slices for value[x] |
Content/Rules for all slices | |||
| value[x]:valueCodeableConcept |
1..1 | CodeableConcept | Codable concept for Care service code | |
| coding |
||||
| system |
0..1 | uri | Code System | |
| code |
1..1 | code | Code | |
| display |
0..1 | string | Display value | |
| CareServiceArea |
1..1 | (Complex) | Care Service Area URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceArea | |
| Slices for value[x] |
Content/Rules for all slices | |||
| value[x]:valueCodeableConcept |
1..1 | CodeableConcept | Codable concept for Care service area | |
| coding |
||||
| system |
0..1 | uri | Code System | |
| code |
1..1 | code | Code | |
| display |
0..1 | string | Display value | |
| status |
1..1 | code | Status of the apppointment. Not used by API | |
| appointmentType |
1..1 | CodeableConcept | Type of appointment CLINIC|PHONE|VIDEO|OTHER Binding: Kalla Apppointment Types (required) | |
| start |
1..1 | instant | Appointment start time | |
| end |
1..1 | instant | Apponintment end time | |
| minutesDuration |
1..1 | positiveInt | Duration in minutes | |
| participant |
1..1 | BackboneElement | Participating HealthCareService | |
| actor |
1..1 | Reference(HealthcareService) | Reference to HealthCareService | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Appointment.appointmentType | required | KallaAppointmentTypehttp://bki.skane.se/invanartjanster/fhir/ValueSet/appointment-typefrom this IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Appointment |
C | 0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-4: Cancellation reason is only used for appointments that have been cancelled, or noshow app-5: The start must be less than or equal to the end app-6: An appointment may have an originatingAppointment or recurrenceTemplate, but not both app-7: Cancellation date is only used for appointments that have been cancelled, or noshow | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| CareServiceCode |
1..1 | (Complex) | Care Service Code URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceCode | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceCode" | |||||
| Slices for value[x] |
1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
| value[x]:valueCodeableConcept |
1..1 | CodeableConcept | Codable concept for Care service code | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 0..1 | uri | Code System | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
ΣC | 1..1 | code | Code | ||||
| display |
ΣC | 0..1 | string | Display value | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| CareServiceArea |
1..1 | (Complex) | Care Service Area URL: http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceArea | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://bki.skane.se/invanartjanster/fhir/StructureDefinition/extCareServiceArea" | |||||
| Slices for value[x] |
1..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
| value[x]:valueCodeableConcept |
1..1 | CodeableConcept | Codable concept for Care service area | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 0..1 | uri | Code System | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
ΣC | 1..1 | code | Code Binding: https://tirs.skane.se/sdv-millennium/id/codevalueset/34 (required) | ||||
| display |
ΣC | 0..1 | string | Display value | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..* | Identifier | External Ids for this item | ||||
| status |
?!ΣC | 1..1 | code | Status of the apppointment. Not used by API Binding: AppointmentStatus (required): The free/busy status of an appointment. | ||||
| cancellationReason |
ΣC | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example) | ||||
| class |
Σ | 0..* | CodeableConcept | Classification when becoming an encounter Binding: http://terminology.hl7.org/ValueSet/EncounterClass (preferred): Classification of the encounter. | ||||
| serviceCategory |
Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) | ||||
| serviceType |
Σ | 0..* | CodeableReference(HealthcareService) | The specific service that is to be performed during this appointment Binding: ServiceType (example) | ||||
| specialty |
Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred) | ||||
| appointmentType |
Σ | 1..1 | CodeableConcept | Type of appointment CLINIC|PHONE|VIDEO|OTHER Binding: Kalla Apppointment Types (required) | ||||
| reason |
Σ | 0..* | CodeableReference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. | ||||
| priority |
0..1 | CodeableConcept | Used to make informed decisions if needing to re-prioritize Binding: ActPriority (example): Indicates the urgency of the appointment. | |||||
| description |
0..1 | string | Shown on a subject line in a meeting request, or appointment list | |||||
| replaces |
0..* | Reference(Appointment) | Appointment replaced by this Appointment | |||||
| virtualService |
0..* | VirtualServiceDetail | Connection details of a virtual service (e.g. conference call) | |||||
| supportingInformation |
0..* | Reference(Resource) | Additional information to support the appointment | |||||
| previousAppointment |
0..1 | Reference(Appointment) | The previous appointment in a series | |||||
| originatingAppointment |
C | 0..1 | Reference(Appointment) | The originating appointment in a recurring set of appointments | ||||
| start |
ΣC | 1..1 | instant | Appointment start time | ||||
| end |
ΣC | 1..1 | instant | Apponintment end time | ||||
| minutesDuration |
1..1 | positiveInt | Duration in minutes | |||||
| requestedPeriod |
0..* | Period | Potential date/time interval(s) requested to allocate the appointment within | |||||
| slot |
0..* | Reference(Slot) | The slots that this appointment is filling | |||||
| account |
0..* | Reference(Account) | The set of accounts that may be used for billing for this Appointment | |||||
| created |
0..1 | dateTime | The date that this appointment was initially created | |||||
| cancellationDate |
C | 0..1 | dateTime | When the appointment was cancelled | ||||
| note |
0..* | Annotation | Additional comments | |||||
| patientInstruction |
0..* | CodeableReference(DocumentReference | Binary | Communication) | Detailed information and instructions for the patient | |||||
| basedOn |
0..* | Reference(CarePlan | DeviceRequest | MedicationRequest | ServiceRequest) | The request this appointment is allocated to assess | |||||
| subject |
Σ | 0..1 | Reference(Patient | Group) | The patient or group associated with the appointment | ||||
| participant |
C | 1..1 | BackboneElement | Participating HealthCareService app-1: Either the type or actor on the participant SHALL be specified | ||||
| 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 |
ΣC | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
| period |
0..1 | Period | Participation period of the actor | |||||
| actor |
ΣC | 1..1 | Reference(HealthcareService) | Reference to HealthCareService | ||||
| required |
Σ | 0..1 | boolean | The participant is required to attend (optional when false) | ||||
| status |
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | ||||
| recurrenceId |
0..1 | positiveInt | The sequence number in the recurrence | |||||
| occurrenceChanged |
0..1 | boolean | Indicates that this appointment varies from a recurrence pattern | |||||
| recurrenceTemplate |
C | 0..* | BackboneElement | Details of the recurrence pattern/template used to generate occurrences | ||||
| 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 | ||||
| timezone |
0..1 | CodeableConcept | The timezone of the occurrences Binding: IANATimezones (required): IANA Timezones (BCP 175) | |||||
| recurrenceType |
1..1 | CodeableConcept | The frequency of the recurrence Binding: AppointmentRecurrenceType (preferred): IANA Timezones (BCP 175) | |||||
| lastOccurrenceDate |
0..1 | date | The date when the recurrence should end | |||||
| occurrenceCount |
0..1 | positiveInt | The number of planned occurrences | |||||
| occurrenceDate |
0..* | date | Specific dates for a recurring set of appointments (no template) | |||||
| weeklyTemplate |
0..1 | BackboneElement | Information about weekly recurring appointments | |||||
| 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 | ||||
| monday |
0..1 | boolean | Recurs on Mondays | |||||
| tuesday |
0..1 | boolean | Recurs on Tuesday | |||||
| wednesday |
0..1 | boolean | Recurs on Wednesday | |||||
| thursday |
0..1 | boolean | Recurs on Thursday | |||||
| friday |
0..1 | boolean | Recurs on Friday | |||||
| saturday |
0..1 | boolean | Recurs on Saturday | |||||
| sunday |
0..1 | boolean | Recurs on Sunday | |||||
| weekInterval |
0..1 | positiveInt | Recurs every nth week | |||||
| monthlyTemplate |
0..1 | BackboneElement | Information about monthly recurring appointments | |||||
| 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 | ||||
| dayOfMonth |
0..1 | positiveInt | Recurs on a specific day of the month | |||||
| nthWeekOfMonth |
0..1 | Coding | Indicates which week of the month the appointment should occur Binding: WeekOfMonth (required): The set of weeks in a month. | |||||
| dayOfWeek |
0..1 | Coding | Indicates which day of the week the appointment should occur Binding: DaysOfWeek (required): The days of the week. | |||||
| monthInterval |
1..1 | positiveInt | Recurs every nth month | |||||
| yearlyTemplate |
0..1 | BackboneElement | Information about yearly recurring appointments | |||||
| 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 | ||||
| yearInterval |
1..1 | positiveInt | Recurs every nth year | |||||
| excludingDate |
0..* | date | Any dates that should be excluded from the series | |||||
| excludingRecurrenceId |
0..* | positiveInt | Any recurrence IDs that should be excluded from the recurrence | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI |
| Appointment.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0from the FHIR Standard | |
| Appointment.extension:CareServiceArea.value[x]:valueCodeableConcept.coding.code | required | https://tirs.skane.se/sdv-millennium/id/codevalueset/34https://tirs.skane.se/sdv-millennium/id/codevalueset/34 | |
| Appointment.status | required | AppointmentStatushttp://hl7.org/fhir/ValueSet/appointmentstatus|5.0.0from the FHIR Standard | |
| Appointment.cancellationReason | example | AppointmentCancellationReasonhttp://hl7.org/fhir/ValueSet/appointment-cancellation-reasonfrom the FHIR Standard | |
| Appointment.class | preferred | http://terminology.hl7.org/ValueSet/EncounterClasshttp://terminology.hl7.org/ValueSet/EncounterClass | |
| Appointment.serviceCategory | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-categoryfrom the FHIR Standard | |
| Appointment.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-typefrom the FHIR Standard | |
| Appointment.specialty | preferred | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codesfrom the FHIR Standard | |
| Appointment.appointmentType | required | KallaAppointmentTypehttp://bki.skane.se/invanartjanster/fhir/ValueSet/appointment-typefrom this IG | |
| Appointment.reason | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reasonfrom the FHIR Standard | |
| Appointment.priority | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
| Appointment.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-typefrom the FHIR Standard | |
| Appointment.participant.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|5.0.0from the FHIR Standard | |
| Appointment.recurrenceTemplate.timezone | required | IANATimezoneshttp://hl7.org/fhir/ValueSet/timezones|5.0.0from the FHIR Standard | |
| Appointment.recurrenceTemplate.recurrenceType | preferred | AppointmentRecurrenceTypehttp://hl7.org/fhir/ValueSet/appointment-recurrrence-typefrom the FHIR Standard | |
| Appointment.recurrenceTemplate.monthlyTemplate.nthWeekOfMonth | required | WeekOfMonthhttp://hl7.org/fhir/ValueSet/week-of-month|5.0.0from the FHIR Standard | |
| Appointment.recurrenceTemplate.monthlyTemplate.dayOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|5.0.0from the FHIR Standard |
This structure is derived from Appointment
Other representations of profile: CSV, Excel, Schematron