0.1.0 - ci-build
            
          
KISUMUHIEFHIRIG, published by intellisoftkenya. 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/IntelliSOFT-Consulting/Kisumu-County-HIE-FHIR-IG/ and changes regularly. See the Directory of published versions
| Official URL: http://fhir.kisumuhealth.co.ke/StructureDefinition/ksm-patient-appointment | Version: 0.1.0 | |||
| Draft as of 2025-09-02 | Computable Name: Ksm-PatientAppointment | |||
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:   | 
|---|---|---|---|---|
|   Appointment | C | 0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) Constraints: app-2, app-3, app-4 | 
|    implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | 
|    modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | 
|    status | ?!SΣ | 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. | 
|    cancelationReason | SΣ | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example) | 
|    appointmentType | SΣ | 0..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred) | 
|    reasonCode | SΣ | 0..1 | CodeableConcept | Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. | 
|    reasonReference | 0..* | Reference(ObservationProfile | ANC Condition) | Reason the appointment is to take place (resource) | |
|    start | SΣ | 1..1 | instant | When appointment is to take place | 
|    end | SΣ | 1..1 | instant | When appointment is to conclude | 
|    created | S | 0..1 | dateTime | The date that this appointment was initially created | 
|    participant | C | 1..* | BackboneElement | Participants involved in appointment Constraints: app-1 | 
|     modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
|     status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | 
|  Documentation for this format | ||||
| Path | Conformance | ValueSet | URI | 
| Appointment.status | required | AppointmentStatus http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1From the FHIR Standard | |
| Appointment.cancelationReason | example | AppointmentCancellationReason http://hl7.org/fhir/ValueSet/appointment-cancellation-reasonFrom the FHIR Standard | |
| Appointment.appointmentType | preferred | Hl7VSAppointmentReasonCodes http://terminology.hl7.org/ValueSet/v2-0276 | |
| Appointment.reasonCode | preferred | EncounterReasonCodes http://hl7.org/fhir/ValueSet/encounter-reasonFrom the FHIR Standard | |
| Appointment.participant.status | required | ParticipationStatus http://hl7.org/fhir/ValueSet/participationstatus|4.0.1From 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 | Cancelation reason is only used for appointments that have been cancelled, or no-show : Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled') | |
| dom-2 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Appointment | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Appointment | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | 
This structure is derived from Appointment
| Name | Flags | Card. | Type | Description & Constraints    Filter:   | 
|---|---|---|---|---|
|   Appointment | 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) | |
|    status | S | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist | 
|    cancelationReason | S | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled | 
|    appointmentType | S | 0..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) | 
|    reasonCode | S | 0..1 | CodeableConcept | Coded reason this appointment is scheduled | 
|    reasonReference | 0..* | Reference(ObservationProfile | ANC Condition) | Reason the appointment is to take place (resource) | |
|    start | S | 1..1 | instant | When appointment is to take place | 
|    end | S | 1..1 | instant | When appointment is to conclude | 
|    created | S | 0..1 | dateTime | The date that this appointment was initially created | 
|  Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints    Filter:   | ||||
|---|---|---|---|---|---|---|---|---|
|   Appointment | C | 0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) Constraints: app-2, app-3, app-4 | ||||
|    id | Σ | 0..1 | id | Logical id of this artifact | ||||
|    meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
|    implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
|    language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language. 
 | |||||
|    text | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
|    contained | 0..* | Resource | Contained, inline Resources | |||||
|    extension | 0..* | Extension | Additional content defined by implementations | |||||
|    modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
|    identifier | Σ | 0..* | Identifier | External Ids for this item | ||||
|    status | ?!SΣ | 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. | ||||
|    cancelationReason | SΣ | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example) | ||||
|    serviceCategory | Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) | ||||
|    serviceType | Σ | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: ServiceType (example) | ||||
|    specialty | Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred) | ||||
|    appointmentType | SΣ | 0..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred) | ||||
|    reasonCode | SΣ | 0..1 | CodeableConcept | Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. | ||||
|    reasonReference | 0..* | Reference(ObservationProfile | ANC Condition) | Reason the appointment is to take place (resource) | |||||
|    priority | 0..1 | unsignedInt | Used to make informed decisions if needing to re-prioritize | |||||
|    description | 0..1 | string | Shown on a subject line in a meeting request, or appointment list | |||||
|    supportingInformation | 0..* | Reference(Resource) | Additional information to support the appointment | |||||
|    start | SΣ | 1..1 | instant | When appointment is to take place | ||||
|    end | SΣ | 1..1 | instant | When appointment is to conclude | ||||
|    minutesDuration | 0..1 | positiveInt | Can be less than start/end (e.g. estimate) | |||||
|    slot | 0..* | Reference(Slot) | The slots that this appointment is filling | |||||
|    created | S | 0..1 | dateTime | The date that this appointment was initially created | ||||
|    comment | 0..1 | string | Additional comments | |||||
|    patientInstruction | 0..1 | string | Detailed information and instructions for the patient | |||||
|    basedOn | 0..* | Reference(ServiceRequest) | The service request this appointment is allocated to assess | |||||
|    participant | C | 1..* | BackboneElement | Participants involved in appointment Constraints: app-1 | ||||
|     id | 0..1 | string | Unique id for inter-element referencing | |||||
|     extension | 0..* | Extension | Additional content defined by implementations | |||||
|     modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
|     type | Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
|     actor | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | Person, Location/HealthcareService or Device | ||||
|     required | Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. | ||||
|     status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | ||||
|     period | 0..1 | Period | Participation period of the actor | |||||
|    requestedPeriod | 0..* | Period | Potential date/time interval(s) requested to allocate the appointment within | |||||
|  Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Appointment.language | preferred | CommonLanguages http://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard 
 | ||||
| Appointment.status | required | AppointmentStatus http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1From the FHIR Standard | ||||
| Appointment.cancelationReason | example | AppointmentCancellationReason http://hl7.org/fhir/ValueSet/appointment-cancellation-reasonFrom the FHIR Standard | ||||
| Appointment.serviceCategory | example | ServiceCategory http://hl7.org/fhir/ValueSet/service-categoryFrom the FHIR Standard | ||||
| Appointment.serviceType | example | ServiceType http://hl7.org/fhir/ValueSet/service-typeFrom the FHIR Standard | ||||
| Appointment.specialty | preferred | PracticeSettingCodeValueSet http://hl7.org/fhir/ValueSet/c80-practice-codesFrom the FHIR Standard | ||||
| Appointment.appointmentType | preferred | Hl7VSAppointmentReasonCodes http://terminology.hl7.org/ValueSet/v2-0276 | ||||
| Appointment.reasonCode | preferred | EncounterReasonCodes http://hl7.org/fhir/ValueSet/encounter-reasonFrom the FHIR Standard | ||||
| Appointment.participant.type | extensible | ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-typeFrom the FHIR Standard | ||||
| Appointment.participant.required | required | ParticipantRequired http://hl7.org/fhir/ValueSet/participantrequired|4.0.1From the FHIR Standard | ||||
| Appointment.participant.status | required | ParticipationStatus http://hl7.org/fhir/ValueSet/participationstatus|4.0.1From 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 | Cancelation reason is only used for appointments that have been cancelled, or no-show : Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled') | |
| dom-2 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Appointment | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Appointment | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | 
This structure is derived from Appointment
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints    Filter:   | 
|---|---|---|---|---|
|   Appointment | C | 0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) Constraints: app-2, app-3, app-4 | 
|    implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | 
|    modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | 
|    status | ?!SΣ | 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. | 
|    cancelationReason | SΣ | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example) | 
|    appointmentType | SΣ | 0..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred) | 
|    reasonCode | SΣ | 0..1 | CodeableConcept | Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. | 
|    reasonReference | 0..* | Reference(ObservationProfile | ANC Condition) | Reason the appointment is to take place (resource) | |
|    start | SΣ | 1..1 | instant | When appointment is to take place | 
|    end | SΣ | 1..1 | instant | When appointment is to conclude | 
|    created | S | 0..1 | dateTime | The date that this appointment was initially created | 
|    participant | C | 1..* | BackboneElement | Participants involved in appointment Constraints: app-1 | 
|     modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
|     status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | 
|  Documentation for this format | ||||
| Path | Conformance | ValueSet | URI | 
| Appointment.status | required | AppointmentStatus http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1From the FHIR Standard | |
| Appointment.cancelationReason | example | AppointmentCancellationReason http://hl7.org/fhir/ValueSet/appointment-cancellation-reasonFrom the FHIR Standard | |
| Appointment.appointmentType | preferred | Hl7VSAppointmentReasonCodes http://terminology.hl7.org/ValueSet/v2-0276 | |
| Appointment.reasonCode | preferred | EncounterReasonCodes http://hl7.org/fhir/ValueSet/encounter-reasonFrom the FHIR Standard | |
| Appointment.participant.status | required | ParticipationStatus http://hl7.org/fhir/ValueSet/participationstatus|4.0.1From 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 | Cancelation reason is only used for appointments that have been cancelled, or no-show : Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled') | |
| dom-2 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Appointment | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Appointment | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | 
Differential View
This structure is derived from Appointment
| Name | Flags | Card. | Type | Description & Constraints    Filter:   | 
|---|---|---|---|---|
|   Appointment | 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) | |
|    status | S | 1..1 | code | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist | 
|    cancelationReason | S | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled | 
|    appointmentType | S | 0..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) | 
|    reasonCode | S | 0..1 | CodeableConcept | Coded reason this appointment is scheduled | 
|    reasonReference | 0..* | Reference(ObservationProfile | ANC Condition) | Reason the appointment is to take place (resource) | |
|    start | S | 1..1 | instant | When appointment is to take place | 
|    end | S | 1..1 | instant | When appointment is to conclude | 
|    created | S | 0..1 | dateTime | The date that this appointment was initially created | 
|  Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints    Filter:   | ||||
|---|---|---|---|---|---|---|---|---|
|   Appointment | C | 0..* | Appointment | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s) Constraints: app-2, app-3, app-4 | ||||
|    id | Σ | 0..1 | id | Logical id of this artifact | ||||
|    meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
|    implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
|    language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language. 
 | |||||
|    text | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
|    contained | 0..* | Resource | Contained, inline Resources | |||||
|    extension | 0..* | Extension | Additional content defined by implementations | |||||
|    modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
|    identifier | Σ | 0..* | Identifier | External Ids for this item | ||||
|    status | ?!SΣ | 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. | ||||
|    cancelationReason | SΣ | 0..1 | CodeableConcept | The coded reason for the appointment being cancelled Binding: AppointmentCancellationReason (example) | ||||
|    serviceCategory | Σ | 0..* | CodeableConcept | A broad categorization of the service that is to be performed during this appointment Binding: ServiceCategory (example) | ||||
|    serviceType | Σ | 0..* | CodeableConcept | The specific service that is to be performed during this appointment Binding: ServiceType (example) | ||||
|    specialty | Σ | 0..* | CodeableConcept | The specialty of a practitioner that would be required to perform the service requested in this appointment Binding: PracticeSettingCodeValueSet (preferred) | ||||
|    appointmentType | SΣ | 0..1 | CodeableConcept | The style of appointment or patient that has been booked in the slot (not service type) Binding: hl7VS-appointmentReasonCodes (preferred) | ||||
|    reasonCode | SΣ | 0..1 | CodeableConcept | Coded reason this appointment is scheduled Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place. | ||||
|    reasonReference | 0..* | Reference(ObservationProfile | ANC Condition) | Reason the appointment is to take place (resource) | |||||
|    priority | 0..1 | unsignedInt | Used to make informed decisions if needing to re-prioritize | |||||
|    description | 0..1 | string | Shown on a subject line in a meeting request, or appointment list | |||||
|    supportingInformation | 0..* | Reference(Resource) | Additional information to support the appointment | |||||
|    start | SΣ | 1..1 | instant | When appointment is to take place | ||||
|    end | SΣ | 1..1 | instant | When appointment is to conclude | ||||
|    minutesDuration | 0..1 | positiveInt | Can be less than start/end (e.g. estimate) | |||||
|    slot | 0..* | Reference(Slot) | The slots that this appointment is filling | |||||
|    created | S | 0..1 | dateTime | The date that this appointment was initially created | ||||
|    comment | 0..1 | string | Additional comments | |||||
|    patientInstruction | 0..1 | string | Detailed information and instructions for the patient | |||||
|    basedOn | 0..* | Reference(ServiceRequest) | The service request this appointment is allocated to assess | |||||
|    participant | C | 1..* | BackboneElement | Participants involved in appointment Constraints: app-1 | ||||
|     id | 0..1 | string | Unique id for inter-element referencing | |||||
|     extension | 0..* | Extension | Additional content defined by implementations | |||||
|     modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
|     type | Σ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
|     actor | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | Person, Location/HealthcareService or Device | ||||
|     required | Σ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required): Is the Participant required to attend the appointment. | ||||
|     status | Σ | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. | ||||
|     period | 0..1 | Period | Participation period of the actor | |||||
|    requestedPeriod | 0..* | Period | Potential date/time interval(s) requested to allocate the appointment within | |||||
|  Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Appointment.language | preferred | CommonLanguages http://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard 
 | ||||
| Appointment.status | required | AppointmentStatus http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1From the FHIR Standard | ||||
| Appointment.cancelationReason | example | AppointmentCancellationReason http://hl7.org/fhir/ValueSet/appointment-cancellation-reasonFrom the FHIR Standard | ||||
| Appointment.serviceCategory | example | ServiceCategory http://hl7.org/fhir/ValueSet/service-categoryFrom the FHIR Standard | ||||
| Appointment.serviceType | example | ServiceType http://hl7.org/fhir/ValueSet/service-typeFrom the FHIR Standard | ||||
| Appointment.specialty | preferred | PracticeSettingCodeValueSet http://hl7.org/fhir/ValueSet/c80-practice-codesFrom the FHIR Standard | ||||
| Appointment.appointmentType | preferred | Hl7VSAppointmentReasonCodes http://terminology.hl7.org/ValueSet/v2-0276 | ||||
| Appointment.reasonCode | preferred | EncounterReasonCodes http://hl7.org/fhir/ValueSet/encounter-reasonFrom the FHIR Standard | ||||
| Appointment.participant.type | extensible | ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-typeFrom the FHIR Standard | ||||
| Appointment.participant.required | required | ParticipantRequired http://hl7.org/fhir/ValueSet/participantrequired|4.0.1From the FHIR Standard | ||||
| Appointment.participant.status | required | ParticipationStatus http://hl7.org/fhir/ValueSet/participationstatus|4.0.1From 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 | Cancelation reason is only used for appointments that have been cancelled, or no-show : Appointment.cancelationReason.exists() implies (Appointment.status='no-show' or Appointment.status='cancelled') | |
| dom-2 | error | Appointment | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Appointment | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Appointment | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Appointment | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | 
This structure is derived from Appointment
Other representations of profile: CSV, Excel, Schematron