SGHI FHIR Profile Implementation Guide
0.1.0 - ci-build

SGHI FHIR Profile Implementation Guide, published by Kathurima Kimathi. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/savannahghi/sil_fhir_profile_ig/ and changes regularly. See the Directory of published versions

## Resource Profile: SGHIAppointment - Detailed Descriptions

Draft as of 2026-04-27

Definitions for the appointment resource profile.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be foundhere

0. Appointment
Definition | 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).
Short | 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)
Control | 0..*
Is Modifier | false
Must Support | false
Summary | false
Invariants | app-2: Either start and end are specified, or neither (start.exists() = end.exists()) app-3: Only proposed or cancelled appointments can be missing start/end dates ((start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))) app-4: Cancellation reason is only used for appointments that have been cancelled, or noshow (cancellationReason.exists() implies (status='noshow' or status='cancelled')) app-5: The start must be less than or equal to the end (start.exists() implies start <= end) app-6: An appointment may have an originatingAppointment or recurrenceTemplate, but not both (originatingAppointment.exists().not() or recurrenceTemplate.exists().not()) app-7: Cancellation date is only used for appointments that have been cancelled, or noshow (cancellationDate.exists() implies (status='noshow' or status='cancelled')) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) 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 (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. Appointment.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Short | A set of rules under which this content was created
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.
Control | 0..1
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Appointment.contained
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.
Short | Contained, inline Resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.
Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
Type | Resource
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
6. Appointment.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Support | false
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. Appointment.identifier
Definition | This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
Short | External Ids for this item
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 10..*
Type | Identifier
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Appointment.identifier.use
Definition | The purpose of this identifier.
Short | usual | official | temp | secondary | old (If known)
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 (required to `http://hl7.org/fhir/ValueSet/identifier-use` )
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Appointment.identifier.type
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Short | Description of identifier
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Control | 0..1
Binding | The codes SHALL be taken from Unless not suitable, these codes SHALL be taken from SGHI Default Identifier Types http://hl7.org/fhir/ValueSet/identifier-type|5.0.0 (required to `https://fhir.slade360.co.ke/fhir/ValueSet/default-identifier-types` )
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Summary | true
Requirements | Allows users to make use of identifiers when the identifier system is not known.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Appointment.identifier.system
Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Short | The namespace for the identifier value
Comments | Identifier.system is always case sensitive.
Control | 10..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Example | General: http://www.acme.com/identifiers/patient
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Appointment.identifier.value
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Short | The value that is unique
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Control | 10..1 This element is affected by the following invariants: ident-1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Example | General: 123456
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. Appointment.identifier.assigner
Definition | Organization that issued/manages the identifier.
Short | Organization that issued id (may be just text)
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Control | 10..1
Type | Reference(SGHI Reference)(SGHI Organization, Organization)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Appointment.status
Definition | The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.
Short | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
Comments | If the Appointment's status is "cancelled" then all participants are expected to have their calendars released for the appointment period, and as such any Slots that were marked as BUSY can be re-set to FREE. This element is labeled as a modifier because the status contains the code entered-in-error that mark the Appointment as not currently valid.
Control | 1..1 This element is affected by the following invariants: app-4, app-3, app-7
Binding | The codes SHALL be taken from AppointmentStatus http://hl7.org/fhir/ValueSet/appointmentstatus|5.0.0 (required to `http://hl7.org/fhir/ValueSet/appointmentstatus|5.0.0` ) The free/busy status of an appointment.
Type | code
Is Modifier | true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Appointment.cancellationReason
Definition | The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply.
Short | The coded reason for the appointment being cancelled
Control | 0..1 This element is affected by the following invariants: app-4
Binding | For example codes, see AppointmentCancellationReason http://hl7.org/fhir/ValueSet/appointment-cancellation-reason|5.0.0 (example to `http://hl7.org/fhir/ValueSet/appointment-cancellation-reason|5.0.0` )
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. Appointment.class
Definition | Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.
Short | Classification when becoming an encounter
Control | 0..*
Binding | The codes SHALL be taken from The codes SHOULD be taken from All LOINC Codes http://terminology.hl7.org/ValueSet/EncounterClass (required to `https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes` )
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. Appointment.serviceCategory
Definition | A broad categorization of the service that is to be performed during this appointment.
Short | A broad categorization of the service that is to be performed during this appointment
Control | 0..*
Binding | For example codes, see ServiceCategory http://hl7.org/fhir/ValueSet/service-category|5.0.0 (example to `http://hl7.org/fhir/ValueSet/service-category|5.0.0` )
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. Appointment.specialty
Definition | The specialty of a practitioner that would be required to perform the service requested in this appointment.
Short | The specialty of a practitioner that would be required to perform the service requested in this appointment
Control | 0..*
Binding | The codes SHALL be taken from The codes SHOULD be taken from speciality http://hl7.org/fhir/ValueSet/c80-practice-codes|5.0.0 (required to `https://fhir.slade360.co.ke/fhir/ValueSet/speciality` )
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. Appointment.appointmentType
Definition | The style of appointment or patient that has been booked in the slot (not service type).
Short | The style of appointment or patient that has been booked in the slot (not service type)
Control | 10..1
Binding | The codes SHOULD be taken from hl7VS-appointmentReasonCodes http://terminology.hl7.org/ValueSet/v2-0276 (preferred to `http://terminology.hl7.org/ValueSet/v2-0276` )
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. Appointment.reason
Definition | The reason that this appointment is being scheduled. This is more clinical than administrative. This can be coded, or as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.
Short | Reason this appointment is scheduled
Control | 0..*
Binding | The codes SHALL be taken from The codes SHOULD be taken from All LOINC Codes http://hl7.org/fhir/ValueSet/encounter-reason|5.0.0 (required to `https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes` )
Type | CodeableReference(SGHI CodeableReference)(SGHI Condition, SGHI Observation, Condition, Procedure, Observation, ImmunizationRecommendation)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. Appointment.priority
Definition | The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).
Short | Used to make informed decisions if needing to re-prioritize
Comments | Seeking implementer feedback on this property and how interoperable it is. Using an extension to record a CodeableConcept for named values may be tested at a future connectathon.
Control | 10..1
Binding | For example codes, see ActPriority http://terminology.hl7.org/ValueSet/v3-ActPriority (example to `http://terminology.hl7.org/ValueSet/v3-ActPriority` ) Indicates the urgency of the appointment.
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. Appointment.replaces
Definition | Appointment replaced by this Appointment in cases where there is a cancellation, the details of the cancellation can be found in the cancellationReason property (on the referenced resource).
Short | Appointment replaced by this Appointment
Control | 0..*
Type | Reference(SGHI Reference)(SGHI Appointment Profile, Appointment)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. Appointment.previousAppointment
Definition | The previous appointment in a series of related appointments.
Short | The previous appointment in a series
Comments | This property is intended for use when representing a series of related appointments. For example, in a nuclear medicine procedure, where there is an appointment for the injection of the isotopes, and then a subsequent appointment for the scan, the scan appointment would refer to the injection appointment via Appointment.previousAppointment. For representing recurring appointments, see the guidance on recurring vs. series appointments.
Control | 0..1
Type | Reference(SGHI Reference)(SGHI Appointment Profile, Appointment)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. Appointment.originatingAppointment
Definition | The originating appointment in a recurring set of related appointments.
Short | The originating appointment in a recurring set of appointments
Comments | This property is intended for use when representing a recurring set of related appointments. For example, a patient undergoing physical therapy may have a recurring appointment every Tuesday and Thursday. Each occurrence of the set will refer to the originating appointment, which contains the recurring template information. For representing appointment series, see the guidance on recurring vs. series appointments.
Control | 0..1 This element is affected by the following invariants: app-6
Type | Reference(SGHI Reference)(SGHI Appointment Profile, Appointment)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. Appointment.start
Definition | Date/Time that the appointment is to take place.
Short | When appointment is to take place
Comments | If actual start/end times are not known then the requested period start/end can be used.
Control | 10..1 This element is affected by the following invariants: app-5, app-3, app-2
Type | instant
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. Appointment.end
Definition | Date/Time that the appointment is to conclude.
Short | When appointment is to conclude
Comments | If actual start/end times are not known then the requested period start/end can be used.
Control | 0..1 This element is affected by the following invariants: app-5, app-3, app-2
Type | instant
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. Appointment.created
Definition | The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.
Short | The date that this appointment was initially created
Comments | This property is required for many use cases where the age of an appointment is considered in processing workflows for scheduling and billing of appointments.
Control | 10..1
Type | dateTime
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. Appointment.basedOn
Definition | The request this appointment is allocated to assess (e.g. incoming referral or procedure request).
Short | The request this appointment is allocated to assess
Control | 0..*
Type | Reference(SGHI Reference)(SGHI ServiceRequest, SGHI MedicationRequest, CarePlan, DeviceRequest, MedicationRequest, ServiceRequest)
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | incomingReferral
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. Appointment.subject
Definition | The patient or group associated with the appointment, if they are to be present (usually) then they should also be included in the participant backbone element.
Short | The patient or group associated with the appointment
Control | 10..1
Type | Reference(SGHI Reference)(SGHI Patient, Patient, Group)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. Appointment.participant
Definition | List of participants involved in the appointment.
Short | Participants involved in appointment
Control | 1..*
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | false
Invariants | app-1: Either the type or actor on the participant SHALL be specified (type.exists() or actor.exists()) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. Appointment.participant.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
56. Appointment.participant.type
Definition | Role of participant in the appointment.
Short | Role of participant in the appointment
Comments | The role of the participant can be used to declare what the actor will be doing in the scope of this appointment. If the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning. This value SHALL be the same when creating an AppointmentResponse so that they can be matched, and subsequently update the Appointment.
Control | 0..* This element is affected by the following invariants: app-1
Binding | Unless not suitable, these codes SHALL be taken from ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type|5.0.0 (extensible to `http://hl7.org/fhir/ValueSet/encounter-participant-type|5.0.0` ) Role of participant in encounter.
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. Appointment.participant.actor
Definition | The individual, device, location, or service participating in the appointment.
Short | The individual, device, location, or service participating in the appointment
Comments | Where a CareTeam is provided, this does not imply that the entire team is included, just a single member from the group with the appropriate role. Where multiple members are required, please include the CareTeam the required number of times.
Control | 0..1 This element is affected by the following invariants: app-1
Type | Reference(SGHI Reference)(SGHI Patient, SGHI Practitioner, SGHI Location, SGHI PractitionerRole, Patient, Group, Practitioner, PractitionerRole, CareTeam, RelatedPerson, Device, HealthcareService, Location)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
60. Appointment.participant.status
Definition | Participation status of the actor.
Short | accepted | declined | tentative | needs-action
Control | 1..1
Binding | The codes SHALL be taken from ParticipationStatus http://hl7.org/fhir/ValueSet/participationstatus|5.0.0 (required to `http://hl7.org/fhir/ValueSet/participationstatus|5.0.0` ) The Participation status of an appointment.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be foundhere

0. Appointment
2. Appointment.identifier
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 1..?
4. Appointment.identifier.use
Binding | The codes SHALL be taken from IdentifierUse (required to `http://hl7.org/fhir/ValueSet/identifier-use` )
6. Appointment.identifier.type
Binding | The codes SHALL be taken from SGHI Default Identifier Types (required to `https://fhir.slade360.co.ke/fhir/ValueSet/default-identifier-types` )
Type | CodeableConcept(SGHI CodeableConcept)
8. Appointment.identifier.system
Control | 1..?
10. Appointment.identifier.value
Control | 1..?
12. Appointment.identifier.assigner
Control | 1..?
Type | Reference(SGHI Reference)(SGHI Organization)
14. Appointment.cancellationReason
Type | CodeableConcept(SGHI CodeableConcept)
16. Appointment.class
Binding | The codes SHALL be taken from All LOINC Codes (required to `https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes` )
Type | CodeableConcept(SGHI CodeableConcept)
18. Appointment.serviceCategory
Type | CodeableConcept(SGHI CodeableConcept)
20. Appointment.specialty
Binding | The codes SHALL be taken from speciality (required to `https://fhir.slade360.co.ke/fhir/ValueSet/speciality` )
Type | CodeableConcept(SGHI CodeableConcept)
22. Appointment.appointmentType
Control | 1..?
Type | CodeableConcept(SGHI CodeableConcept)
24. Appointment.reason
Binding | The codes SHALL be taken from All LOINC Codes (required to `https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes` )
Type | CodeableReference(SGHI CodeableReference)(SGHI Condition, SGHI Observation)
26. Appointment.priority
Control | 1..?
Type | CodeableConcept(SGHI CodeableConcept)
28. Appointment.replaces
Type | Reference(SGHI Reference)(SGHI Appointment Profile)
30. Appointment.previousAppointment
Type | Reference(SGHI Reference)(SGHI Appointment Profile)
32. Appointment.originatingAppointment
Type | Reference(SGHI Reference)(SGHI Appointment Profile)
34. Appointment.start
Control | 1..?
36. Appointment.created
Control | 1..?
38. Appointment.basedOn
Type | Reference(SGHI Reference)(SGHI ServiceRequest, SGHI MedicationRequest)
40. Appointment.subject
Control | 1..?
Type | Reference(SGHI Reference)(SGHI Patient)
42. Appointment.participant
44. Appointment.participant.type
Type | CodeableConcept(SGHI CodeableConcept)
46. Appointment.participant.actor
Type | Reference(SGHI Reference)(SGHI Patient, SGHI Practitioner, SGHI Location, SGHI PractitionerRole)

Guidance on how to interpret the contents of this table can be foundhere

0. Appointment
Definition | 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).
Short | 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)
Control | 0..*
Is Modifier | false
Must Support | false
Summary | false
Invariants | app-2: Either start and end are specified, or neither (`start.exists() = end.exists()`) app-3: Only proposed or cancelled appointments can be missing start/end dates (`(start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))`) app-4: Cancellation reason is only used for appointments that have been cancelled, or noshow (`cancellationReason.exists() implies (status='noshow' or status='cancelled')`) app-5: The start must be less than or equal to the end (`start.exists() implies start <= end`) app-6: An appointment may have an originatingAppointment or recurrenceTemplate, but not both (`originatingAppointment.exists().not() or recurrenceTemplate.exists().not()`) app-7: Cancellation date is only used for appointments that have been cancelled, or noshow (`cancellationDate.exists() implies (status='noshow' or status='cancelled')`) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (`contained.contained.empty()`) 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 (`contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`) dom-4: 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: If a resource is contained in another resource, it SHALL NOT have a security label (`contained.meta.security.empty()`) dom-6: A resource should have narrative for robust management (`text.`div`.exists()`)
2. Appointment.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Short | Logical id of this artifact
Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.
Control | 0..1
Type | id
Is Modifier | false
Must Support | false
Summary | true
4. Appointment.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Short | Metadata about the resource
Control | 0..1
Type | Meta
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
6. Appointment.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Short | A set of rules under which this content was created
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.
Control | 0..1
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
8. Appointment.language
Definition | The base language in which the resource is written.
Short | Language of the resource content
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Control | 0..1
Binding | The codes SHALL be taken from AllLanguages (required to `http://hl7.org/fhir/ValueSet/all-languages|5.0.0` ) IETF language tag for a human language
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
10. Appointment.text
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Short | Text summary of the resource, for human interpretation
Comments | Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Control | 0..1 This element is affected by the following invariants: dom-6
Type | Narrative
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | narrative, html, xhtml, display
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
12. Appointment.contained
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.
Short | Contained, inline Resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.
Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
Type | Resource
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
14. Appointment.extension
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
16. Appointment.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Support | false
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
18. Appointment.identifier
Definition | This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
Short | External Ids for this item
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 1..*
Type | Identifier
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
20. Appointment.identifier.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | id
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
22. Appointment.identifier.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `Appointment.identifier.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
24. Appointment.identifier.use
Definition | The purpose of this identifier.
Short | usual | official | temp | secondary | old (If known)
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse (required to `http://hl7.org/fhir/ValueSet/identifier-use` )
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
26. Appointment.identifier.type
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Short | Description of identifier
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Control | 0..1
Binding | The codes SHALL be taken from SGHI Default Identifier Types (required to `https://fhir.slade360.co.ke/fhir/ValueSet/default-identifier-types` )
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Summary | true
Requirements | Allows users to make use of identifiers when the identifier system is not known.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
28. Appointment.identifier.system
Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Short | The namespace for the identifier value
Comments | Identifier.system is always case sensitive.
Control | 1..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Example | General: http://www.acme.com/identifiers/patient
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
30. Appointment.identifier.value
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Short | The value that is unique
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Control | 1..1 This element is affected by the following invariants: ident-1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Example | General: 123456
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
32. Appointment.identifier.period
Definition | Time period during which identifier is/was valid for use.
Short | Time period when id is/was valid for use
Control | 0..1
Type | Period
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
34. Appointment.identifier.assigner
Definition | Organization that issued/manages the identifier.
Short | Organization that issued id (may be just text)
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Control | 1..1
Type | Reference(SGHI Reference)(SGHI Organization)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
36. Appointment.status
Definition | The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.
Short | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
Comments | If the Appointment's status is "cancelled" then all participants are expected to have their calendars released for the appointment period, and as such any Slots that were marked as BUSY can be re-set to FREE. This element is labeled as a modifier because the status contains the code entered-in-error that mark the Appointment as not currently valid.
Control | 1..1 This element is affected by the following invariants: app-4, app-3, app-7
Binding | The codes SHALL be taken from AppointmentStatus (required to `http://hl7.org/fhir/ValueSet/appointmentstatus|5.0.0` ) The free/busy status of an appointment.
Type | code
Is Modifier | true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
38. Appointment.cancellationReason
Definition | The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply.
Short | The coded reason for the appointment being cancelled
Control | 0..1 This element is affected by the following invariants: app-4
Binding | For example codes, see AppointmentCancellationReason (example to `http://hl7.org/fhir/ValueSet/appointment-cancellation-reason|5.0.0` )
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
40. Appointment.class
Definition | Concepts representing classification of patient encounter such as ambulatory (outpatient), inpatient, emergency, home health or others due to local variations.
Short | Classification when becoming an encounter
Control | 0..*
Binding | The codes SHALL be taken from All LOINC Codes (required to `https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes` )
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
42. Appointment.serviceCategory
Definition | A broad categorization of the service that is to be performed during this appointment.
Short | A broad categorization of the service that is to be performed during this appointment
Control | 0..*
Binding | For example codes, see ServiceCategory (example to `http://hl7.org/fhir/ValueSet/service-category|5.0.0` )
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
44. Appointment.serviceType
Definition | The specific service that is to be performed during this appointment.
Short | The specific service that is to be performed during this appointment
Comments | For a provider to provider appointment the code "FOLLOWUP" may be appropriate, as this is expected to be discussing some patient that was seen in the past.
Control | 0..*
Binding | For example codes, see ServiceType (example to `http://hl7.org/fhir/ValueSet/service-type|5.0.0` )
Type | CodeableReference(HealthcareService)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
46. Appointment.specialty
Definition | The specialty of a practitioner that would be required to perform the service requested in this appointment.
Short | The specialty of a practitioner that would be required to perform the service requested in this appointment
Control | 0..*
Binding | The codes SHALL be taken from speciality (required to `https://fhir.slade360.co.ke/fhir/ValueSet/speciality` )
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
48. Appointment.appointmentType
Definition | The style of appointment or patient that has been booked in the slot (not service type).
Short | The style of appointment or patient that has been booked in the slot (not service type)
Control | 1..1
Binding | The codes SHOULD be taken from hl7VS-appointmentReasonCodes (preferred to `http://terminology.hl7.org/ValueSet/v2-0276` )
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
50. Appointment.reason
Definition | The reason that this appointment is being scheduled. This is more clinical than administrative. This can be coded, or as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.
Short | Reason this appointment is scheduled
Control | 0..*
Binding | The codes SHALL be taken from All LOINC Codes (required to `https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes` )
Type | CodeableReference(SGHI CodeableReference)(SGHI Condition, SGHI Observation)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
52. Appointment.priority
Definition | The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).
Short | Used to make informed decisions if needing to re-prioritize
Comments | Seeking implementer feedback on this property and how interoperable it is. Using an extension to record a CodeableConcept for named values may be tested at a future connectathon.
Control | 1..1
Binding | For example codes, see ActPriority (example to `http://terminology.hl7.org/ValueSet/v3-ActPriority` ) Indicates the urgency of the appointment.
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
54. Appointment.description
Definition | The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the note field.
Short | Shown on a subject line in a meeting request, or appointment list
Control | 0..1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
56. Appointment.replaces
Definition | Appointment replaced by this Appointment in cases where there is a cancellation, the details of the cancellation can be found in the cancellationReason property (on the referenced resource).
Short | Appointment replaced by this Appointment
Control | 0..*
Type | Reference(SGHI Reference)(SGHI Appointment Profile)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
58. Appointment.virtualService
Definition | Connection details of a virtual service (e.g. conference call).
Short | Connection details of a virtual service (e.g. conference call)
Comments | There are two types of virtual meetings that often exist: a persistent, virtual meeting room that can only be used for a single purpose at a time, and a dynamic virtual meeting room that is generated on demand for a specific purpose. Implementers may consider using Location.virtualService for persistent meeting rooms. If each participant would have a different meeting link, an extension using the VirtualServiceContactDetail can be applied to the Appointment.participant BackboneElement.
Control | 0..*
Type | VirtualServiceDetail
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
60. Appointment.supportingInformation
Definition | Additional information to support the appointment provided when making the appointment.
Short | Additional information to support the appointment
Control | 0..*
Type | Reference(Resource)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
62. Appointment.previousAppointment
Definition | The previous appointment in a series of related appointments.
Short | The previous appointment in a series
Comments | This property is intended for use when representing a series of related appointments. For example, in a nuclear medicine procedure, where there is an appointment for the injection of the isotopes, and then a subsequent appointment for the scan, the scan appointment would refer to the injection appointment via Appointment.previousAppointment. For representing recurring appointments, see the guidance on recurring vs. series appointments.
Control | 0..1
Type | Reference(SGHI Reference)(SGHI Appointment Profile)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
64. Appointment.originatingAppointment
Definition | The originating appointment in a recurring set of related appointments.
Short | The originating appointment in a recurring set of appointments
Comments | This property is intended for use when representing a recurring set of related appointments. For example, a patient undergoing physical therapy may have a recurring appointment every Tuesday and Thursday. Each occurrence of the set will refer to the originating appointment, which contains the recurring template information. For representing appointment series, see the guidance on recurring vs. series appointments.
Control | 0..1 This element is affected by the following invariants: app-6
Type | Reference(SGHI Reference)(SGHI Appointment Profile)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
66. Appointment.start
Definition | Date/Time that the appointment is to take place.
Short | When appointment is to take place
Comments | If actual start/end times are not known then the requested period start/end can be used.
Control | 1..1 This element is affected by the following invariants: app-5, app-3, app-2
Type | instant
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
68. Appointment.end
Definition | Date/Time that the appointment is to conclude.
Short | When appointment is to conclude
Comments | If actual start/end times are not known then the requested period start/end can be used.
Control | 0..1 This element is affected by the following invariants: app-5, app-3, app-2
Type | instant
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
70. Appointment.minutesDuration
Definition | Number of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.
Short | Can be less than start/end (e.g. estimate)
Control | 0..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
72. Appointment.requestedPeriod
Definition | A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. The duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system.
Short | Potential date/time interval(s) requested to allocate the appointment within
Comments | This does not introduce a capacity for recurring appointments.
Control | 0..*
Type | Period
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
74. Appointment.slot
Definition | The slots from the participants' schedules that will be filled by the appointment.
Short | The slots that this appointment is filling
Control | 0..*
Type | Reference(Slot)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
76. Appointment.account
Definition | The set of accounts that is expected to be used for billing the activities that result from this Appointment.
Short | The set of accounts that may be used for billing for this Appointment
Comments | The specified account(s) could be those identified during pre-registration workflows in preparation for an upcoming Encounter.
Control | 0..*
Type | Reference(Account)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
78. Appointment.created
Definition | The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.
Short | The date that this appointment was initially created
Comments | This property is required for many use cases where the age of an appointment is considered in processing workflows for scheduling and billing of appointments.
Control | 1..1
Type | dateTime
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
80. Appointment.cancellationDate
Definition | The date/time describing when the appointment was cancelled.
Short | When the appointment was cancelled
Comments | If the appointment was cancelled multiple times, this would reflect the most recent cancellation.
Control | 0..1 This element is affected by the following invariants: app-7
Type | dateTime
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
82. Appointment.note
Definition | Additional notes/comments about the appointment.
Short | Additional comments
Comments | Additional text to aid in facilitating the appointment. For instance, a note might be, "patient should proceed immediately to infusion room upon arrival" Where this is a planned appointment and the start/end dates are not set then this field can be used to provide additional guidance on the details of the appointment request, including any restrictions on when to book it. Typically only the concept.text will be used, however occasionally a reference to some generic documentation (or specific) and also supports coded instructions if/when they are required.
Control | 0..*
Type | Annotation
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
84. Appointment.patientInstruction
Definition | While Appointment.note contains information for internal use, Appointment.patientInstructions is used to capture patient facing information about the Appointment (e.g. please bring your referral or fast from 8pm night before).
Short | Detailed information and instructions for the patient
Control | 0..*
Type | CodeableReference(DocumentReference, Binary, Communication)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
86. Appointment.basedOn
Definition | The request this appointment is allocated to assess (e.g. incoming referral or procedure request).
Short | The request this appointment is allocated to assess
Control | 0..*
Type | Reference(SGHI Reference)(SGHI ServiceRequest, SGHI MedicationRequest)
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | incomingReferral
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
88. Appointment.subject
Definition | The patient or group associated with the appointment, if they are to be present (usually) then they should also be included in the participant backbone element.
Short | The patient or group associated with the appointment
Control | 1..1
Type | Reference(SGHI Reference)(SGHI Patient)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
90. Appointment.participant
Definition | List of participants involved in the appointment.
Short | Participants involved in appointment
Control | 1..*
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | false
Invariants | app-1: Either the type or actor on the participant SHALL be specified (`type.exists() or actor.exists()`) ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
92. Appointment.participant.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
94. Appointment.participant.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
96. Appointment.participant.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
98. Appointment.participant.type
Definition | Role of participant in the appointment.
Short | Role of participant in the appointment
Comments | The role of the participant can be used to declare what the actor will be doing in the scope of this appointment. If the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning. This value SHALL be the same when creating an AppointmentResponse so that they can be matched, and subsequently update the Appointment.
Control | 0..* This element is affected by the following invariants: app-1
Binding | Unless not suitable, these codes SHALL be taken from ParticipantType (extensible to `http://hl7.org/fhir/ValueSet/encounter-participant-type|5.0.0` ) Role of participant in encounter.
Type | CodeableConcept(SGHI CodeableConcept)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
100. Appointment.participant.period
Definition | Participation period of the actor.
Short | Participation period of the actor
Control | 0..1
Type | Period
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
102. Appointment.participant.actor
Definition | The individual, device, location, or service participating in the appointment.
Short | The individual, device, location, or service participating in the appointment
Comments | Where a CareTeam is provided, this does not imply that the entire team is included, just a single member from the group with the appropriate role. Where multiple members are required, please include the CareTeam the required number of times.
Control | 0..1 This element is affected by the following invariants: app-1
Type | Reference(SGHI Reference)(SGHI Patient, SGHI Practitioner, SGHI Location, SGHI PractitionerRole)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
104. Appointment.participant.required
Definition | Whether this participant is required to be present at the meeting. If false, the participant is optional.
Short | The participant is required to attend (optional when false)
Comments | For the use-case where two doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present include the patient in the subject field, but do not include them as a participant - this was formerly done prior to R5 with required='information-only'.
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
106. Appointment.participant.status
Definition | Participation status of the actor.
Short | accepted | declined | tentative | needs-action
Control | 1..1
Binding | The codes SHALL be taken from ParticipationStatus (required to `http://hl7.org/fhir/ValueSet/participationstatus|5.0.0` ) The Participation status of an appointment.
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
108. Appointment.recurrenceId
Definition | The sequence number that identifies a specific appointment in a recurring pattern.
Short | The sequence number in the recurrence
Control | 0..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
110. Appointment.occurrenceChanged
Definition | This appointment varies from the recurring pattern.
Short | Indicates that this appointment varies from a recurrence pattern
Comments | For example, if a patient has physical therapy appointments every Tuesday and Thursday, but due to a national holiday, a single occurrence was rescheduled to a different day, while the rest of the recurring series remained on Tuesday / Thursday.
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
112. Appointment.recurrenceTemplate
Definition | The details of the recurrence pattern or template that is used to generate recurring appointments.
Short | Details of the recurrence pattern/template used to generate occurrences
Control | 0..* This element is affected by the following invariants: app-6
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
114. Appointment.recurrenceTemplate.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
116. Appointment.recurrenceTemplate.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
118. Appointment.recurrenceTemplate.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
120. Appointment.recurrenceTemplate.timezone
Definition | The timezone of the recurring appointment occurrences.
Short | The timezone of the occurrences
Control | 0..1
Binding | The codes SHALL be taken from IANATimezones (required to `http://hl7.org/fhir/ValueSet/timezones|5.0.0` ) IANA Timezones (BCP 175)
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
122. Appointment.recurrenceTemplate.recurrenceType
Definition | How often the appointment series should recur.
Short | The frequency of the recurrence
Control | 1..1
Binding | The codes SHOULD be taken from AppointmentRecurrenceType (preferred to `http://hl7.org/fhir/ValueSet/appointment-recurrrence-type|5.0.0` ) IANA Timezones (BCP 175)
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
124. Appointment.recurrenceTemplate.lastOccurrenceDate
Definition | Recurring appointments will not occur after this date.
Short | The date when the recurrence should end
Control | 0..1
Type | date
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
126. Appointment.recurrenceTemplate.occurrenceCount
Definition | How many appointments are planned in the recurrence.
Short | The number of planned occurrences
Control | 0..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
128. Appointment.recurrenceTemplate.occurrenceDate
Definition | The list of specific dates that will have appointments generated.
Short | Specific dates for a recurring set of appointments (no template)
Control | 0..*
Type | date
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
130. Appointment.recurrenceTemplate.weeklyTemplate
Definition | Information about weekly recurring appointments.
Short | Information about weekly recurring appointments
Control | 0..1
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
132. Appointment.recurrenceTemplate.weeklyTemplate.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
134. Appointment.recurrenceTemplate.weeklyTemplate.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
136. Appointment.recurrenceTemplate.weeklyTemplate.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
138. Appointment.recurrenceTemplate.weeklyTemplate.monday
Definition | Indicates that recurring appointments should occur on Mondays.
Short | Recurs on Mondays
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
140. Appointment.recurrenceTemplate.weeklyTemplate.tuesday
Definition | Indicates that recurring appointments should occur on Tuesdays.
Short | Recurs on Tuesday
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
142. Appointment.recurrenceTemplate.weeklyTemplate.wednesday
Definition | Indicates that recurring appointments should occur on Wednesdays.
Short | Recurs on Wednesday
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
144. Appointment.recurrenceTemplate.weeklyTemplate.thursday
Definition | Indicates that recurring appointments should occur on Thursdays.
Short | Recurs on Thursday
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
146. Appointment.recurrenceTemplate.weeklyTemplate.friday
Definition | Indicates that recurring appointments should occur on Fridays.
Short | Recurs on Friday
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
148. Appointment.recurrenceTemplate.weeklyTemplate.saturday
Definition | Indicates that recurring appointments should occur on Saturdays.
Short | Recurs on Saturday
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
150. Appointment.recurrenceTemplate.weeklyTemplate.sunday
Definition | Indicates that recurring appointments should occur on Sundays.
Short | Recurs on Sunday
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
152. Appointment.recurrenceTemplate.weeklyTemplate.weekInterval
Definition | The interval defines if the recurrence is every nth week. The default is every week, so it is expected that this value will be 2 or more. e.g. For recurring every second week this interval would be 2, or every third week the interval would be 3.
Short | Recurs every nth week
Control | 0..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
154. Appointment.recurrenceTemplate.monthlyTemplate
Definition | Information about monthly recurring appointments.
Short | Information about monthly recurring appointments
Control | 0..1
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
156. Appointment.recurrenceTemplate.monthlyTemplate.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
158. Appointment.recurrenceTemplate.monthlyTemplate.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
160. Appointment.recurrenceTemplate.monthlyTemplate.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
162. Appointment.recurrenceTemplate.monthlyTemplate.dayOfMonth
Definition | Indicates that appointments in the series of recurring appointments should occur on a specific day of the month.
Short | Recurs on a specific day of the month
Control | 0..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
164. Appointment.recurrenceTemplate.monthlyTemplate.nthWeekOfMonth
Definition | Indicates which week within a month the appointments in the series of recurring appointments should occur on.
Short | Indicates which week of the month the appointment should occur
Control | 0..1
Binding | The codes SHALL be taken from WeekOfMonth (required to `http://hl7.org/fhir/ValueSet/week-of-month|5.0.0` ) The set of weeks in a month.
Type | Coding
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
166. Appointment.recurrenceTemplate.monthlyTemplate.dayOfWeek
Definition | Indicates which day of the week the recurring appointments should occur each nth week.
Short | Indicates which day of the week the appointment should occur
Comments | This property is intended to be used with Appointment.recurrenceTemplate.monthly.nthWeek.
Control | 0..1
Binding | The codes SHALL be taken from DaysOfWeek (required to `http://hl7.org/fhir/ValueSet/days-of-week|5.0.0` ) The days of the week.
Type | Coding
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
168. Appointment.recurrenceTemplate.monthlyTemplate.monthInterval
Definition | Indicates that recurring appointments should occur every nth month.
Short | Recurs every nth month
Control | 1..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
170. Appointment.recurrenceTemplate.yearlyTemplate
Definition | Information about yearly recurring appointments.
Short | Information about yearly recurring appointments
Control | 0..1
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
172. Appointment.recurrenceTemplate.yearlyTemplate.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
174. Appointment.recurrenceTemplate.yearlyTemplate.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
176. Appointment.recurrenceTemplate.yearlyTemplate.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
178. Appointment.recurrenceTemplate.yearlyTemplate.yearInterval
Definition | Appointment recurs every nth year.
Short | Recurs every nth year
Control | 1..1
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
180. Appointment.recurrenceTemplate.excludingDate
Definition | Any dates, such as holidays, that should be excluded from the recurrence.
Short | Any dates that should be excluded from the series
Comments | excludingDate is an alternative to excludingRecurrenceId. You may say either that 12/25/XXXX should be excluded using excludingDate, or you may indicate the recurrenceId of the appointment that would fall on the excluded date in the excludingRecurrenceId property.
Control | 0..*
Type | date
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
182. Appointment.recurrenceTemplate.excludingRecurrenceId
Definition | Any dates, such as holidays, that should be excluded from the recurrence.
Short | Any recurrence IDs that should be excluded from the recurrence
Comments | excludingRecurrenceId is an alternative to excludingDate. You may say either that 12/25/XXXX should be excluded using excludingDate, or you may indicate the recurrenceId of the appointment that would fall on the excluded date in the excludingRecurrenceId property.
Control | 0..*
Type | positiveInt
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)