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
Official URL: https://fhir.slade360.co.ke/fhir/StructureDefinition/sghi-appointment | Version: 0.1.0 | |||
Draft as of 2025-09-04 | Computable Name: SGHIAppointment |
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).
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) Constraints: app-2, app-3, app-4, app-5, app-6, app-7 |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
Σ | 1..* | Identifier | External Ids for this item |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
![]() ![]() ![]() ![]() |
Σ | 0..1 | SGHICodeableConcept | Description of identifier Binding: SGHI Standard Identifier Types (required) |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
ΣC | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() |
Σ | 1..1 | SGHIReference(SGHI Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() |
?!ΣC | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment. |
![]() ![]() ![]() |
ΣC | 0..1 | SGHICodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example) |
![]() ![]() ![]() |
Σ | 0..* | SGHICodeableConcept | Classification when becoming an encounter Binding: All LOINC Codes (required) |
![]() ![]() ![]() |
Σ | 0..* | SGHICodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) |
![]() ![]() ![]() |
Σ | 1..* | SGHICodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: sghi-speciality (required) |
![]() ![]() ![]() |
Σ | 1..1 | SGHICodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred) |
![]() ![]() ![]() |
Σ | 1..* | SGHICodeableReference(SGHI Condition | SGHI Observation) | Reason this appointment is scheduled Binding: All LOINC Codes (required) |
![]() ![]() ![]() |
1..1 | SGHICodeableConcept | Used to make informed decisions if needing to re-prioritize Binding: ActPriority (example): Indicates the urgency of the appointment. | |
![]() ![]() ![]() |
0..* | SGHIReference(SGHI Appointment Profile) | Appointment replaced by this Appointment | |
![]() ![]() ![]() |
0..1 | SGHIReference(SGHI Appointment Profile) | The previous appointment in a series | |
![]() ![]() ![]() |
C | 0..1 | SGHIReference(SGHI Appointment Profile) | The originating appointment in a recurring set of appointments |
![]() ![]() ![]() |
ΣC | 1..1 | instant | When appointment is to take place |
![]() ![]() ![]() |
ΣC | 0..1 | instant | When appointment is to conclude |
![]() ![]() ![]() |
1..1 | dateTime | The date that this appointment was initially created | |
![]() ![]() ![]() |
0..* | SGHIReference(SGHI ServiceRequest | SGHI MedicationRequest) | The request this appointment is allocated to assess | |
![]() ![]() ![]() |
Σ | 1..1 | SGHIReference(SGHI Patient) | The patient or group associated with the appointment |
![]() ![]() ![]() |
C | 1..* | BackboneElement | Participants involved in appointment Constraints: app-1 |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
ΣC | 0..* | SGHICodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. |
![]() ![]() ![]() ![]() |
ΣC | 1..1 | SGHIReference(SGHI Patient | SGHI Location | SGHI PractitionerRole) | The individual, device, location, or service participating in the appointment |
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. |
![]() |
Path | Conformance | ValueSet | URI |
Appointment.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use From the FHIR Standard | |
Appointment.identifier.type | required | SGHIIdentifierTypeshttps://fhir.slade360.co.ke/fhir/ValueSet/sghi-identifier-types From this IG | |
Appointment.status | required | AppointmentStatushttp://hl7.org/fhir/ValueSet/appointmentstatus|5.0.0 From the FHIR Standard | |
Appointment.cancellationReason | example | AppointmentCancellationReasonhttp://hl7.org/fhir/ValueSet/appointment-cancellation-reason From the FHIR Standard | |
Appointment.class | required | AllLoincCodes(a valid code from LOINC)https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes From this IG | |
Appointment.serviceCategory | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-category From the FHIR Standard | |
Appointment.specialty | required | SGHISpecialtyVs(a valid code from SGHI Specialty Code System)https://fhir.slade360.co.ke/fhir/ValueSet/sghi-speciality From this IG | |
Appointment.appointmentType | preferred | Hl7VSAppointmentReasonCodeshttp://terminology.hl7.org/ValueSet/v2-0276 | |
Appointment.reason | required | AllLoincCodes(a valid code from LOINC)https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes From this IG | |
Appointment.priority | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Appointment.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type From the FHIR Standard | |
Appointment.participant.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|5.0.0 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
app-1 | error | Appointment.participant | Either the type or actor on the participant SHALL be specified : type.exists() or actor.exists() | |
app-2 | error | Appointment | Either start and end are specified, or neither : start.exists() = end.exists() | |
app-3 | error | Appointment | Only proposed or cancelled appointments can be missing start/end dates : (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist')) | |
app-4 | error | Appointment | Cancellation reason is only used for appointments that have been cancelled, or noshow : cancellationReason.exists() implies (status='noshow' or status='cancelled') | |
app-5 | error | Appointment | The start must be less than or equal to the end : start.exists() implies start <= end | |
app-6 | best practice | Appointment | An appointment may have an originatingAppointment or recurrenceTemplate, but not both : originatingAppointment.exists().not() or recurrenceTemplate.exists().not() | |
app-7 | error | Appointment | Cancellation date is only used for appointments that have been cancelled, or noshow : cancellationDate.exists() implies (status='noshow' or status='cancelled') | |
dom-2 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Appointment | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().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 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Appointment | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Appointment
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) | |
![]() ![]() ![]() |
1..* | Identifier | External Ids for this item | |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |
![]() ![]() ![]() ![]() |
0..1 | SGHICodeableConcept | Description of identifier Binding: SGHI Standard Identifier Types (required) | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() ![]() ![]() |
1..1 | SGHIReference(SGHI Organization) | Organization that issued id (may be just text) | |
![]() ![]() ![]() |
0..1 | SGHICodeableConcept | The coded reason for the appointment being cancelled | |
![]() ![]() ![]() |
0..* | SGHICodeableConcept | Classification when becoming an encounter Binding: All LOINC Codes (required) | |
![]() ![]() ![]() |
0..* | SGHICodeableConcept | A broad categorization of the service that is to be performed during this appointment | |
![]() ![]() ![]() |
1..* | SGHICodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: sghi-speciality (required) | |
![]() ![]() ![]() |
1..1 | SGHICodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) | |
![]() ![]() ![]() |
1..* | SGHICodeableReference(SGHI Condition | SGHI Observation) | Reason this appointment is scheduled Binding: All LOINC Codes (required) | |
![]() ![]() ![]() |
1..1 | SGHICodeableConcept | Used to make informed decisions if needing to re-prioritize | |
![]() ![]() ![]() |
0..* | SGHIReference(SGHI Appointment Profile) | Appointment replaced by this Appointment | |
![]() ![]() ![]() |
0..1 | SGHIReference(SGHI Appointment Profile) | The previous appointment in a series | |
![]() ![]() ![]() |
0..1 | SGHIReference(SGHI Appointment Profile) | The originating appointment in a recurring set of appointments | |
![]() ![]() ![]() |
1..1 | instant | When appointment is to take place | |
![]() ![]() ![]() |
1..1 | dateTime | The date that this appointment was initially created | |
![]() ![]() ![]() |
0..* | SGHIReference(SGHI ServiceRequest | SGHI MedicationRequest) | The request this appointment is allocated to assess | |
![]() ![]() ![]() |
1..1 | SGHIReference(SGHI Patient) | The patient or group associated with the appointment | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..* | SGHICodeableConcept | Role of participant in the appointment | |
![]() ![]() ![]() ![]() |
1..1 | SGHIReference(SGHI Patient | SGHI Location | SGHI PractitionerRole) | The individual, device, location, or service participating in the appointment | |
![]() |
Path | Conformance | ValueSet | URI |
Appointment.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use From the FHIR Standard | |
Appointment.identifier.type | required | SGHIIdentifierTypeshttps://fhir.slade360.co.ke/fhir/ValueSet/sghi-identifier-types From this IG | |
Appointment.class | required | AllLoincCodes(a valid code from LOINC)https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes From this IG | |
Appointment.specialty | required | SGHISpecialtyVs(a valid code from SGHI Specialty Code System)https://fhir.slade360.co.ke/fhir/ValueSet/sghi-speciality From this IG | |
Appointment.reason | required | AllLoincCodes(a valid code from LOINC)https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes From this IG |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) Constraints: app-2, app-3, app-4, app-5, app-6, app-7 | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 1..* | Identifier | External Ids for this item | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | SGHICodeableConcept | Description of identifier Binding: SGHI Standard Identifier Types (required) | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | SGHIReference(SGHI Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
?!ΣC | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment. | ||||
![]() ![]() ![]() |
ΣC | 0..1 | SGHICodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example) | ||||
![]() ![]() ![]() |
Σ | 0..* | SGHICodeableConcept | Classification when becoming an encounter Binding: All LOINC Codes (required) | ||||
![]() ![]() ![]() |
Σ | 0..* | SGHICodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableReference(HealthcareService) | The specific service that is to be performed during this appointment Binding: ServiceType (example) | ||||
![]() ![]() ![]() |
Σ | 1..* | SGHICodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: sghi-speciality (required) | ||||
![]() ![]() ![]() |
Σ | 1..1 | SGHICodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred) | ||||
![]() ![]() ![]() |
Σ | 1..* | SGHICodeableReference(SGHI Condition | SGHI Observation) | Reason this appointment is scheduled Binding: All LOINC Codes (required) | ||||
![]() ![]() ![]() |
1..1 | SGHICodeableConcept | Used to make informed decisions if needing to re-prioritize Binding: ActPriority (example): Indicates the urgency of the appointment. | |||||
![]() ![]() ![]() |
0..1 | string | Shown on a subject line in a meeting request, or appointment list | |||||
![]() ![]() ![]() |
0..* | SGHIReference(SGHI Appointment Profile) | Appointment replaced by this Appointment | |||||
![]() ![]() ![]() |
0..* | VirtualServiceDetail | Connection details of a virtual service (e.g. conference call) | |||||
![]() ![]() ![]() |
0..* | Reference(Resource) | Additional information to support the appointment | |||||
![]() ![]() ![]() |
0..1 | SGHIReference(SGHI Appointment Profile) | The previous appointment in a series | |||||
![]() ![]() ![]() |
C | 0..1 | SGHIReference(SGHI Appointment Profile) | The originating appointment in a recurring set of appointments | ||||
![]() ![]() ![]() |
ΣC | 1..1 | instant | When appointment is to take place | ||||
![]() ![]() ![]() |
ΣC | 0..1 | instant | When appointment is to conclude | ||||
![]() ![]() ![]() |
0..1 | positiveInt | Can be less than start/end (e.g. estimate) | |||||
![]() ![]() ![]() |
0..* | Period | Potential date/time interval(s) requested to allocate the appointment within | |||||
![]() ![]() ![]() |
0..* | Reference(Slot) | The slots that this appointment is filling | |||||
![]() ![]() ![]() |
0..* | Reference(Account) | The set of accounts that may be used for billing for this Appointment | |||||
![]() ![]() ![]() |
1..1 | dateTime | The date that this appointment was initially created | |||||
![]() ![]() ![]() |
C | 0..1 | dateTime | When the appointment was cancelled | ||||
![]() ![]() ![]() |
0..* | Annotation | Additional comments | |||||
![]() ![]() ![]() |
0..* | CodeableReference(DocumentReference | Binary | Communication) | Detailed information and instructions for the patient | |||||
![]() ![]() ![]() |
0..* | SGHIReference(SGHI ServiceRequest | SGHI MedicationRequest) | The request this appointment is allocated to assess | |||||
![]() ![]() ![]() |
Σ | 1..1 | SGHIReference(SGHI Patient) | The patient or group associated with the appointment | ||||
![]() ![]() ![]() |
C | 1..* | BackboneElement | Participants involved in appointment Constraints: app-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..* | SGHICodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
![]() ![]() ![]() ![]() |
0..1 | Period | Participation period of the actor | |||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | SGHIReference(SGHI Patient | SGHI Location | SGHI PractitionerRole) | The individual, device, location, or service participating in the appointment | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | The participant is required to attend (optional when false) | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | ||||
![]() ![]() ![]() |
0..1 | positiveInt | The sequence number in the recurrence | |||||
![]() ![]() ![]() |
0..1 | boolean | Indicates that this appointment varies from a recurrence pattern | |||||
![]() ![]() ![]() |
C | 0..* | BackboneElement | Details of the recurrence pattern/template used to generate occurrences | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | The timezone of the occurrences Binding: IANATimezones (required): IANA Timezones (BCP 175) | |||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The frequency of the recurrence Binding: AppointmentRecurrenceType (preferred): IANA Timezones (BCP 175) | |||||
![]() ![]() ![]() ![]() |
0..1 | date | The date when the recurrence should end | |||||
![]() ![]() ![]() ![]() |
0..1 | positiveInt | The number of planned occurrences | |||||
![]() ![]() ![]() ![]() |
0..* | date | Specific dates for a recurring set of appointments (no template) | |||||
![]() ![]() ![]() ![]() |
0..1 | BackboneElement | Information about weekly recurring appointments | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | Recurs on Mondays | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | Recurs on Tuesday | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | Recurs on Wednesday | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | Recurs on Thursday | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | Recurs on Friday | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | Recurs on Saturday | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | Recurs on Sunday | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Recurs every nth week | |||||
![]() ![]() ![]() ![]() |
0..1 | BackboneElement | Information about monthly recurring appointments | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Recurs on a specific day of the month | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Indicates which week of the month the appointment should occur Binding: WeekOfMonth (required): The set of weeks in a month. | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Indicates which day of the week the appointment should occur Binding: DaysOfWeek (required): The days of the week. | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | positiveInt | Recurs every nth month | |||||
![]() ![]() ![]() ![]() |
0..1 | BackboneElement | Information about yearly recurring appointments | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | positiveInt | Recurs every nth year | |||||
![]() ![]() ![]() ![]() |
0..* | date | Any dates that should be excluded from the series | |||||
![]() ![]() ![]() ![]() |
0..* | positiveInt | Any recurrence IDs that should be excluded from the recurrence | |||||
![]() |
Path | Conformance | ValueSet | URI |
Appointment.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 From the FHIR Standard | |
Appointment.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use From the FHIR Standard | |
Appointment.identifier.type | required | SGHIIdentifierTypeshttps://fhir.slade360.co.ke/fhir/ValueSet/sghi-identifier-types From this IG | |
Appointment.status | required | AppointmentStatushttp://hl7.org/fhir/ValueSet/appointmentstatus|5.0.0 From the FHIR Standard | |
Appointment.cancellationReason | example | AppointmentCancellationReasonhttp://hl7.org/fhir/ValueSet/appointment-cancellation-reason From the FHIR Standard | |
Appointment.class | required | AllLoincCodes(a valid code from LOINC)https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes From this IG | |
Appointment.serviceCategory | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-category From the FHIR Standard | |
Appointment.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type From the FHIR Standard | |
Appointment.specialty | required | SGHISpecialtyVs(a valid code from SGHI Specialty Code System)https://fhir.slade360.co.ke/fhir/ValueSet/sghi-speciality From this IG | |
Appointment.appointmentType | preferred | Hl7VSAppointmentReasonCodeshttp://terminology.hl7.org/ValueSet/v2-0276 | |
Appointment.reason | required | AllLoincCodes(a valid code from LOINC)https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes From this IG | |
Appointment.priority | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Appointment.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type From the FHIR Standard | |
Appointment.participant.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|5.0.0 From the FHIR Standard | |
Appointment.recurrenceTemplate.timezone | required | IANATimezoneshttp://hl7.org/fhir/ValueSet/timezones|5.0.0 From the FHIR Standard | |
Appointment.recurrenceTemplate.recurrenceType | preferred | AppointmentRecurrenceTypehttp://hl7.org/fhir/ValueSet/appointment-recurrrence-type From the FHIR Standard | |
Appointment.recurrenceTemplate.monthlyTemplate.nthWeekOfMonth | required | WeekOfMonthhttp://hl7.org/fhir/ValueSet/week-of-month|5.0.0 From the FHIR Standard | |
Appointment.recurrenceTemplate.monthlyTemplate.dayOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|5.0.0 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
app-1 | error | Appointment.participant | Either the type or actor on the participant SHALL be specified : type.exists() or actor.exists() | |
app-2 | error | Appointment | Either start and end are specified, or neither : start.exists() = end.exists() | |
app-3 | error | Appointment | Only proposed or cancelled appointments can be missing start/end dates : (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist')) | |
app-4 | error | Appointment | Cancellation reason is only used for appointments that have been cancelled, or noshow : cancellationReason.exists() implies (status='noshow' or status='cancelled') | |
app-5 | error | Appointment | The start must be less than or equal to the end : start.exists() implies start <= end | |
app-6 | best practice | Appointment | An appointment may have an originatingAppointment or recurrenceTemplate, but not both : originatingAppointment.exists().not() or recurrenceTemplate.exists().not() | |
app-7 | error | Appointment | Cancellation date is only used for appointments that have been cancelled, or noshow : cancellationDate.exists() implies (status='noshow' or status='cancelled') | |
dom-2 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Appointment | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().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 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Appointment | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Appointment
Summary
Mandatory: 12 elements
Structures
This structure refers to these other structures:
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) Constraints: app-2, app-3, app-4, app-5, app-6, app-7 |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
Σ | 1..* | Identifier | External Ids for this item |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
![]() ![]() ![]() ![]() |
Σ | 0..1 | SGHICodeableConcept | Description of identifier Binding: SGHI Standard Identifier Types (required) |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
ΣC | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() |
Σ | 1..1 | SGHIReference(SGHI Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() |
?!ΣC | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment. |
![]() ![]() ![]() |
ΣC | 0..1 | SGHICodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example) |
![]() ![]() ![]() |
Σ | 0..* | SGHICodeableConcept | Classification when becoming an encounter Binding: All LOINC Codes (required) |
![]() ![]() ![]() |
Σ | 0..* | SGHICodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) |
![]() ![]() ![]() |
Σ | 1..* | SGHICodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: sghi-speciality (required) |
![]() ![]() ![]() |
Σ | 1..1 | SGHICodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred) |
![]() ![]() ![]() |
Σ | 1..* | SGHICodeableReference(SGHI Condition | SGHI Observation) | Reason this appointment is scheduled Binding: All LOINC Codes (required) |
![]() ![]() ![]() |
1..1 | SGHICodeableConcept | Used to make informed decisions if needing to re-prioritize Binding: ActPriority (example): Indicates the urgency of the appointment. | |
![]() ![]() ![]() |
0..* | SGHIReference(SGHI Appointment Profile) | Appointment replaced by this Appointment | |
![]() ![]() ![]() |
0..1 | SGHIReference(SGHI Appointment Profile) | The previous appointment in a series | |
![]() ![]() ![]() |
C | 0..1 | SGHIReference(SGHI Appointment Profile) | The originating appointment in a recurring set of appointments |
![]() ![]() ![]() |
ΣC | 1..1 | instant | When appointment is to take place |
![]() ![]() ![]() |
ΣC | 0..1 | instant | When appointment is to conclude |
![]() ![]() ![]() |
1..1 | dateTime | The date that this appointment was initially created | |
![]() ![]() ![]() |
0..* | SGHIReference(SGHI ServiceRequest | SGHI MedicationRequest) | The request this appointment is allocated to assess | |
![]() ![]() ![]() |
Σ | 1..1 | SGHIReference(SGHI Patient) | The patient or group associated with the appointment |
![]() ![]() ![]() |
C | 1..* | BackboneElement | Participants involved in appointment Constraints: app-1 |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
ΣC | 0..* | SGHICodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. |
![]() ![]() ![]() ![]() |
ΣC | 1..1 | SGHIReference(SGHI Patient | SGHI Location | SGHI PractitionerRole) | The individual, device, location, or service participating in the appointment |
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. |
![]() |
Path | Conformance | ValueSet | URI |
Appointment.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use From the FHIR Standard | |
Appointment.identifier.type | required | SGHIIdentifierTypeshttps://fhir.slade360.co.ke/fhir/ValueSet/sghi-identifier-types From this IG | |
Appointment.status | required | AppointmentStatushttp://hl7.org/fhir/ValueSet/appointmentstatus|5.0.0 From the FHIR Standard | |
Appointment.cancellationReason | example | AppointmentCancellationReasonhttp://hl7.org/fhir/ValueSet/appointment-cancellation-reason From the FHIR Standard | |
Appointment.class | required | AllLoincCodes(a valid code from LOINC)https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes From this IG | |
Appointment.serviceCategory | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-category From the FHIR Standard | |
Appointment.specialty | required | SGHISpecialtyVs(a valid code from SGHI Specialty Code System)https://fhir.slade360.co.ke/fhir/ValueSet/sghi-speciality From this IG | |
Appointment.appointmentType | preferred | Hl7VSAppointmentReasonCodeshttp://terminology.hl7.org/ValueSet/v2-0276 | |
Appointment.reason | required | AllLoincCodes(a valid code from LOINC)https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes From this IG | |
Appointment.priority | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Appointment.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type From the FHIR Standard | |
Appointment.participant.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|5.0.0 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
app-1 | error | Appointment.participant | Either the type or actor on the participant SHALL be specified : type.exists() or actor.exists() | |
app-2 | error | Appointment | Either start and end are specified, or neither : start.exists() = end.exists() | |
app-3 | error | Appointment | Only proposed or cancelled appointments can be missing start/end dates : (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist')) | |
app-4 | error | Appointment | Cancellation reason is only used for appointments that have been cancelled, or noshow : cancellationReason.exists() implies (status='noshow' or status='cancelled') | |
app-5 | error | Appointment | The start must be less than or equal to the end : start.exists() implies start <= end | |
app-6 | best practice | Appointment | An appointment may have an originatingAppointment or recurrenceTemplate, but not both : originatingAppointment.exists().not() or recurrenceTemplate.exists().not() | |
app-7 | error | Appointment | Cancellation date is only used for appointments that have been cancelled, or noshow : cancellationDate.exists() implies (status='noshow' or status='cancelled') | |
dom-2 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Appointment | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().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 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Appointment | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Differential View
This structure is derived from Appointment
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) | |
![]() ![]() ![]() |
1..* | Identifier | External Ids for this item | |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | |
![]() ![]() ![]() ![]() |
0..1 | SGHICodeableConcept | Description of identifier Binding: SGHI Standard Identifier Types (required) | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() ![]() ![]() |
1..1 | SGHIReference(SGHI Organization) | Organization that issued id (may be just text) | |
![]() ![]() ![]() |
0..1 | SGHICodeableConcept | The coded reason for the appointment being cancelled | |
![]() ![]() ![]() |
0..* | SGHICodeableConcept | Classification when becoming an encounter Binding: All LOINC Codes (required) | |
![]() ![]() ![]() |
0..* | SGHICodeableConcept | A broad categorization of the service that is to be performed during this appointment | |
![]() ![]() ![]() |
1..* | SGHICodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: sghi-speciality (required) | |
![]() ![]() ![]() |
1..1 | SGHICodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) | |
![]() ![]() ![]() |
1..* | SGHICodeableReference(SGHI Condition | SGHI Observation) | Reason this appointment is scheduled Binding: All LOINC Codes (required) | |
![]() ![]() ![]() |
1..1 | SGHICodeableConcept | Used to make informed decisions if needing to re-prioritize | |
![]() ![]() ![]() |
0..* | SGHIReference(SGHI Appointment Profile) | Appointment replaced by this Appointment | |
![]() ![]() ![]() |
0..1 | SGHIReference(SGHI Appointment Profile) | The previous appointment in a series | |
![]() ![]() ![]() |
0..1 | SGHIReference(SGHI Appointment Profile) | The originating appointment in a recurring set of appointments | |
![]() ![]() ![]() |
1..1 | instant | When appointment is to take place | |
![]() ![]() ![]() |
1..1 | dateTime | The date that this appointment was initially created | |
![]() ![]() ![]() |
0..* | SGHIReference(SGHI ServiceRequest | SGHI MedicationRequest) | The request this appointment is allocated to assess | |
![]() ![]() ![]() |
1..1 | SGHIReference(SGHI Patient) | The patient or group associated with the appointment | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..* | SGHICodeableConcept | Role of participant in the appointment | |
![]() ![]() ![]() ![]() |
1..1 | SGHIReference(SGHI Patient | SGHI Location | SGHI PractitionerRole) | The individual, device, location, or service participating in the appointment | |
![]() |
Path | Conformance | ValueSet | URI |
Appointment.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use From the FHIR Standard | |
Appointment.identifier.type | required | SGHIIdentifierTypeshttps://fhir.slade360.co.ke/fhir/ValueSet/sghi-identifier-types From this IG | |
Appointment.class | required | AllLoincCodes(a valid code from LOINC)https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes From this IG | |
Appointment.specialty | required | SGHISpecialtyVs(a valid code from SGHI Specialty Code System)https://fhir.slade360.co.ke/fhir/ValueSet/sghi-speciality From this IG | |
Appointment.reason | required | AllLoincCodes(a valid code from LOINC)https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes From this IG |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) Constraints: app-2, app-3, app-4, app-5, app-6, app-7 | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 1..* | Identifier | External Ids for this item | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | SGHICodeableConcept | Description of identifier Binding: SGHI Standard Identifier Types (required) | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | SGHIReference(SGHI Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
?!ΣC | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment. | ||||
![]() ![]() ![]() |
ΣC | 0..1 | SGHICodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example) | ||||
![]() ![]() ![]() |
Σ | 0..* | SGHICodeableConcept | Classification when becoming an encounter Binding: All LOINC Codes (required) | ||||
![]() ![]() ![]() |
Σ | 0..* | SGHICodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableReference(HealthcareService) | The specific service that is to be performed during this appointment Binding: ServiceType (example) | ||||
![]() ![]() ![]() |
Σ | 1..* | SGHICodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: sghi-speciality (required) | ||||
![]() ![]() ![]() |
Σ | 1..1 | SGHICodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred) | ||||
![]() ![]() ![]() |
Σ | 1..* | SGHICodeableReference(SGHI Condition | SGHI Observation) | Reason this appointment is scheduled Binding: All LOINC Codes (required) | ||||
![]() ![]() ![]() |
1..1 | SGHICodeableConcept | Used to make informed decisions if needing to re-prioritize Binding: ActPriority (example): Indicates the urgency of the appointment. | |||||
![]() ![]() ![]() |
0..1 | string | Shown on a subject line in a meeting request, or appointment list | |||||
![]() ![]() ![]() |
0..* | SGHIReference(SGHI Appointment Profile) | Appointment replaced by this Appointment | |||||
![]() ![]() ![]() |
0..* | VirtualServiceDetail | Connection details of a virtual service (e.g. conference call) | |||||
![]() ![]() ![]() |
0..* | Reference(Resource) | Additional information to support the appointment | |||||
![]() ![]() ![]() |
0..1 | SGHIReference(SGHI Appointment Profile) | The previous appointment in a series | |||||
![]() ![]() ![]() |
C | 0..1 | SGHIReference(SGHI Appointment Profile) | The originating appointment in a recurring set of appointments | ||||
![]() ![]() ![]() |
ΣC | 1..1 | instant | When appointment is to take place | ||||
![]() ![]() ![]() |
ΣC | 0..1 | instant | When appointment is to conclude | ||||
![]() ![]() ![]() |
0..1 | positiveInt | Can be less than start/end (e.g. estimate) | |||||
![]() ![]() ![]() |
0..* | Period | Potential date/time interval(s) requested to allocate the appointment within | |||||
![]() ![]() ![]() |
0..* | Reference(Slot) | The slots that this appointment is filling | |||||
![]() ![]() ![]() |
0..* | Reference(Account) | The set of accounts that may be used for billing for this Appointment | |||||
![]() ![]() ![]() |
1..1 | dateTime | The date that this appointment was initially created | |||||
![]() ![]() ![]() |
C | 0..1 | dateTime | When the appointment was cancelled | ||||
![]() ![]() ![]() |
0..* | Annotation | Additional comments | |||||
![]() ![]() ![]() |
0..* | CodeableReference(DocumentReference | Binary | Communication) | Detailed information and instructions for the patient | |||||
![]() ![]() ![]() |
0..* | SGHIReference(SGHI ServiceRequest | SGHI MedicationRequest) | The request this appointment is allocated to assess | |||||
![]() ![]() ![]() |
Σ | 1..1 | SGHIReference(SGHI Patient) | The patient or group associated with the appointment | ||||
![]() ![]() ![]() |
C | 1..* | BackboneElement | Participants involved in appointment Constraints: app-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..* | SGHICodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
![]() ![]() ![]() ![]() |
0..1 | Period | Participation period of the actor | |||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | SGHIReference(SGHI Patient | SGHI Location | SGHI PractitionerRole) | The individual, device, location, or service participating in the appointment | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | The participant is required to attend (optional when false) | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | ||||
![]() ![]() ![]() |
0..1 | positiveInt | The sequence number in the recurrence | |||||
![]() ![]() ![]() |
0..1 | boolean | Indicates that this appointment varies from a recurrence pattern | |||||
![]() ![]() ![]() |
C | 0..* | BackboneElement | Details of the recurrence pattern/template used to generate occurrences | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | The timezone of the occurrences Binding: IANATimezones (required): IANA Timezones (BCP 175) | |||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | The frequency of the recurrence Binding: AppointmentRecurrenceType (preferred): IANA Timezones (BCP 175) | |||||
![]() ![]() ![]() ![]() |
0..1 | date | The date when the recurrence should end | |||||
![]() ![]() ![]() ![]() |
0..1 | positiveInt | The number of planned occurrences | |||||
![]() ![]() ![]() ![]() |
0..* | date | Specific dates for a recurring set of appointments (no template) | |||||
![]() ![]() ![]() ![]() |
0..1 | BackboneElement | Information about weekly recurring appointments | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | Recurs on Mondays | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | Recurs on Tuesday | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | Recurs on Wednesday | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | Recurs on Thursday | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | Recurs on Friday | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | Recurs on Saturday | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | Recurs on Sunday | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Recurs every nth week | |||||
![]() ![]() ![]() ![]() |
0..1 | BackboneElement | Information about monthly recurring appointments | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Recurs on a specific day of the month | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Indicates which week of the month the appointment should occur Binding: WeekOfMonth (required): The set of weeks in a month. | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Indicates which day of the week the appointment should occur Binding: DaysOfWeek (required): The days of the week. | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | positiveInt | Recurs every nth month | |||||
![]() ![]() ![]() ![]() |
0..1 | BackboneElement | Information about yearly recurring appointments | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | positiveInt | Recurs every nth year | |||||
![]() ![]() ![]() ![]() |
0..* | date | Any dates that should be excluded from the series | |||||
![]() ![]() ![]() ![]() |
0..* | positiveInt | Any recurrence IDs that should be excluded from the recurrence | |||||
![]() |
Path | Conformance | ValueSet | URI |
Appointment.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 From the FHIR Standard | |
Appointment.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use From the FHIR Standard | |
Appointment.identifier.type | required | SGHIIdentifierTypeshttps://fhir.slade360.co.ke/fhir/ValueSet/sghi-identifier-types From this IG | |
Appointment.status | required | AppointmentStatushttp://hl7.org/fhir/ValueSet/appointmentstatus|5.0.0 From the FHIR Standard | |
Appointment.cancellationReason | example | AppointmentCancellationReasonhttp://hl7.org/fhir/ValueSet/appointment-cancellation-reason From the FHIR Standard | |
Appointment.class | required | AllLoincCodes(a valid code from LOINC)https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes From this IG | |
Appointment.serviceCategory | example | ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-category From the FHIR Standard | |
Appointment.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type From the FHIR Standard | |
Appointment.specialty | required | SGHISpecialtyVs(a valid code from SGHI Specialty Code System)https://fhir.slade360.co.ke/fhir/ValueSet/sghi-speciality From this IG | |
Appointment.appointmentType | preferred | Hl7VSAppointmentReasonCodeshttp://terminology.hl7.org/ValueSet/v2-0276 | |
Appointment.reason | required | AllLoincCodes(a valid code from LOINC)https://fhir.slade360.co.ke/fhir/ValueSet/all-loinc-codes From this IG | |
Appointment.priority | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Appointment.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type From the FHIR Standard | |
Appointment.participant.status | required | ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|5.0.0 From the FHIR Standard | |
Appointment.recurrenceTemplate.timezone | required | IANATimezoneshttp://hl7.org/fhir/ValueSet/timezones|5.0.0 From the FHIR Standard | |
Appointment.recurrenceTemplate.recurrenceType | preferred | AppointmentRecurrenceTypehttp://hl7.org/fhir/ValueSet/appointment-recurrrence-type From the FHIR Standard | |
Appointment.recurrenceTemplate.monthlyTemplate.nthWeekOfMonth | required | WeekOfMonthhttp://hl7.org/fhir/ValueSet/week-of-month|5.0.0 From the FHIR Standard | |
Appointment.recurrenceTemplate.monthlyTemplate.dayOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|5.0.0 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
app-1 | error | Appointment.participant | Either the type or actor on the participant SHALL be specified : type.exists() or actor.exists() | |
app-2 | error | Appointment | Either start and end are specified, or neither : start.exists() = end.exists() | |
app-3 | error | Appointment | Only proposed or cancelled appointments can be missing start/end dates : (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist')) | |
app-4 | error | Appointment | Cancellation reason is only used for appointments that have been cancelled, or noshow : cancellationReason.exists() implies (status='noshow' or status='cancelled') | |
app-5 | error | Appointment | The start must be less than or equal to the end : start.exists() implies start <= end | |
app-6 | best practice | Appointment | An appointment may have an originatingAppointment or recurrenceTemplate, but not both : originatingAppointment.exists().not() or recurrenceTemplate.exists().not() | |
app-7 | error | Appointment | Cancellation date is only used for appointments that have been cancelled, or noshow : cancellationDate.exists() implies (status='noshow' or status='cancelled') | |
dom-2 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Appointment | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().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 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Appointment | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Appointment
Summary
Mandatory: 12 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron