Cumuluz Translate Implementation Guide
0.1.0 - ci-build

Cumuluz Translate Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: XibAppointment - Detailed Descriptions

Draft as of 2026-07-11

Definitions for the xib-Appointment resource profile.

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

0. Appointment
Definitie

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).

KortA 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)
Control0..*
Is modifierfalse
Samenvattingfalse
Invariantsapp-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: 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: 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().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: 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())
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: 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'))
2. Appointment.implicitRules
Definitie

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.

KortA set of rules under which this content was created
Opmerkingen

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 it's narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is modifiertrue omdat This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Appointment.modifierExtension
Definitie

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 manageable, 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).

KortExtensions that cannot be ignored
Opmerkingen

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.

Control0..*
TypeExtension
Is modifiertrue omdat Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Samenvattingfalse
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.

Alternatieve namenextensions, user content
Invariantsele-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())
6. Appointment.status
Definitie

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.

Kortproposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
Opmerkingen

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.

Control1..1
BindingDe codes MOETEN komen uit AppointmentStatushttp://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1
(required to http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1)

The free/busy status of an appointment.

Typecode
Is modifiertrue omdat 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
Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
Moet ondersteunentrue
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Appointment.serviceCategory
Definitie

A broad categorization of the service that is to be performed during this appointment.

KortA broad categorization of the service that is to be performed during this appointment
Control0..*
BindingVoor voorbeeldcodes, zie ServiceCategoryhttp://hl7.org/fhir/ValueSet/service-category|4.0.1
(example to http://hl7.org/fhir/ValueSet/service-category|4.0.1)
TypeCodeableConcept
Is modifierfalse
Moet ondersteunentrue
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Appointment.serviceType
Definitie

The specific service that is to be performed during this appointment.

KortThe specific service that is to be performed during this appointment
Opmerkingen

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.

Control0..*
BindingVoor voorbeeldcodes, zie ServiceTypehttp://hl7.org/fhir/ValueSet/service-type|4.0.1
(example to http://hl7.org/fhir/ValueSet/service-type|4.0.1)
TypeCodeableConcept
Is modifierfalse
Moet ondersteunentrue
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Appointment.start
Definitie

Date/Time that the appointment is to take place.

KortWhen appointment is to take place
Control0..1
Typeinstant
Is modifierfalse
Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
Moet ondersteunentrue
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Appointment.end
Definitie

Date/Time that the appointment is to conclude.

KortWhen appointment is to conclude
Control0..1
Typeinstant
Is modifierfalse
Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
Moet ondersteunentrue
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Appointment.participant
Definitie

List of participants involved in the appointment.

KortParticipants involved in appointment
Control1..*
TypeBackboneElement
Is modifierfalse
Moet ondersteunentrue
Samenvattingfalse
Invariantsapp-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()))
app-1: Either the type or actor on the participant SHALL be specified (type.exists() or actor.exists())
18. Appointment.participant.modifierExtension
Definitie

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 manageable, 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).

KortExtensions that cannot be ignored even if unrecognized
Opmerkingen

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.

Control0..*
TypeExtension
Is modifiertrue omdat Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Samenvattingtrue
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.

Alternatieve namenextensions, user content, modifiers
Invariantsele-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())
20. Appointment.participant.status
Definitie

Participation status of the actor.

Kortaccepted | declined | tentative | needs-action
Control1..1
BindingDe codes MOETEN komen uit ParticipationStatushttp://hl7.org/fhir/ValueSet/participationstatus|4.0.1
(required to http://hl7.org/fhir/ValueSet/participationstatus|4.0.1)

The Participation status of an appointment.

Typecode
Is modifierfalse
Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
Samenvattingtrue
Invariantsele-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.status
Moet ondersteunentrue
4. Appointment.serviceCategory
Moet ondersteunentrue
6. Appointment.serviceType
Moet ondersteunentrue
8. Appointment.start
Moet ondersteunentrue
10. Appointment.end
Moet ondersteunentrue
12. Appointment.participant
Moet ondersteunentrue

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

0. Appointment
Definitie

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).

KortA 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)
Control0..*
Is modifierfalse
Samenvattingfalse
Invariantsapp-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: 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: 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().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: 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
Definitie

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

KortLogical id of this artifact
Opmerkingen

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Control0..1
Typeid
Is modifierfalse
Samenvattingtrue
4. Appointment.meta
Definitie

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.

KortMetadata about the resource
Control0..1
TypeMeta
Is modifierfalse
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Appointment.implicitRules
Definitie

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.

KortA set of rules under which this content was created
Opmerkingen

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 it's narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is modifiertrue omdat This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Appointment.language
Definitie

The base language in which the resource is written.

KortLanguage of the resource content
Opmerkingen

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).

Control0..1
BindingDe codes ZOUDEN MOETEN komen uit CommonLanguages
(preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

A human language.

Additionele bindingsDoel
AllLanguagesMax binding
Typecode
Is modifierfalse
Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
Samenvattingfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. Appointment.text
Definitie

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.

KortText summary of the resource, for human interpretation
Opmerkingen

Contained resources do not have 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.

Control0..1
TypeNarrative
Is modifierfalse
Samenvattingfalse
Alternatieve namennarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Appointment.contained
Definitie

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

KortContained, inline Resources
Opmerkingen

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.

Control0..*
TypeResource
Is modifierfalse
Samenvattingfalse
Alternatieve nameninline resources, anonymous resources, contained resources
14. Appointment.extension
Definitie

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 manageable, 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.

KortAdditional content defined by implementations
Opmerkingen

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.

Control0..*
TypeExtension
Is modifierfalse
Samenvattingfalse
Alternatieve namenextensions, user content
Invariantsele-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
Definitie

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 manageable, 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).

KortExtensions that cannot be ignored
Opmerkingen

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.

Control0..*
TypeExtension
Is modifiertrue omdat Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Samenvattingfalse
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.

Alternatieve namenextensions, user content
Invariantsele-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
Definitie

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).

KortExternal Ids for this item
NotitieDit is een business-identifier, geen resource-identifier (zie discussie)
Control0..*
TypeIdentifier
Is modifierfalse
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Appointment.status
Definitie

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.

Kortproposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
Opmerkingen

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.

Control1..1
BindingDe codes MOETEN komen uit AppointmentStatus
(required to http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1)

The free/busy status of an appointment.

Typecode
Is modifiertrue omdat 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
Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
Moet ondersteunentrue
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Appointment.cancelationReason
Definitie

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.

KortThe coded reason for the appointment being cancelled
Control0..1
BindingVoor voorbeeldcodes, zie AppointmentCancellationReason
(example to http://hl7.org/fhir/ValueSet/appointment-cancellation-reason|4.0.1)
TypeCodeableConcept
Is modifierfalse
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. Appointment.serviceCategory
Definitie

A broad categorization of the service that is to be performed during this appointment.

KortA broad categorization of the service that is to be performed during this appointment
Control0..*
BindingVoor voorbeeldcodes, zie ServiceCategory
(example to http://hl7.org/fhir/ValueSet/service-category|4.0.1)
TypeCodeableConcept
Is modifierfalse
Moet ondersteunentrue
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. Appointment.serviceType
Definitie

The specific service that is to be performed during this appointment.

KortThe specific service that is to be performed during this appointment
Opmerkingen

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.

Control0..*
BindingVoor voorbeeldcodes, zie ServiceType
(example to http://hl7.org/fhir/ValueSet/service-type|4.0.1)
TypeCodeableConcept
Is modifierfalse
Moet ondersteunentrue
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. Appointment.specialty
Definitie

The specialty of a practitioner that would be required to perform the service requested in this appointment.

KortThe specialty of a practitioner that would be required to perform the service requested in this appointment
Control0..*
BindingDe codes ZOUDEN MOETEN komen uit PracticeSettingCodeValueSet
(preferred to http://hl7.org/fhir/ValueSet/c80-practice-codes|4.0.1)
TypeCodeableConcept
Is modifierfalse
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. Appointment.appointmentType
Definitie

The style of appointment or patient that has been booked in the slot (not service type).

KortThe style of appointment or patient that has been booked in the slot (not service type)
Control0..1
BindingDe codes ZOUDEN MOETEN komen uit hl7VS-appointmentReasonCodes
(preferred to http://terminology.hl7.org/ValueSet/v2-0276)
TypeCodeableConcept
Is modifierfalse
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. Appointment.reasonCode
Definitie

The coded reason that this appointment is being scheduled. This is more clinical than administrative.

KortCoded reason this appointment is scheduled
Control0..*
BindingDe codes ZOUDEN MOETEN komen uit EncounterReasonCodes
(preferred to http://hl7.org/fhir/ValueSet/encounter-reason|4.0.1)

The Reason for the appointment to take place.

TypeCodeableConcept
Is modifierfalse
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. Appointment.reasonReference
Definitie

Reason the appointment has been scheduled to take place, 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.

KortReason the appointment is to take place (resource)
Control0..*
TypeReference(Condition, Procedure, Observation, ImmunizationRecommendation)
Is modifierfalse
Samenvattingfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. Appointment.priority
Definitie

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).

KortUsed to make informed decisions if needing to re-prioritize
Opmerkingen

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.

Control0..1
TypeunsignedInt
Is modifierfalse
Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
Samenvattingfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. Appointment.description
Definitie

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 comment field.

KortShown on a subject line in a meeting request, or appointment list
Control0..1
Typestring
Is modifierfalse
Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
Samenvattingfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. Appointment.supportingInformation
Definitie

Additional information to support the appointment provided when making the appointment.

KortAdditional information to support the appointment
Control0..*
TypeReference(Resource)
Is modifierfalse
Samenvattingfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. Appointment.start
Definitie

Date/Time that the appointment is to take place.

KortWhen appointment is to take place
Control0..1
Typeinstant
Is modifierfalse
Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
Moet ondersteunentrue
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. Appointment.end
Definitie

Date/Time that the appointment is to conclude.

KortWhen appointment is to conclude
Control0..1
Typeinstant
Is modifierfalse
Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
Moet ondersteunentrue
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. Appointment.minutesDuration
Definitie

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.

KortCan be less than start/end (e.g. estimate)
Control0..1
TypepositiveInt
Is modifierfalse
Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
Samenvattingfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
48. Appointment.slot
Definitie

The slots from the participants' schedules that will be filled by the appointment.

KortThe slots that this appointment is filling
Control0..*
TypeReference(Slot)
Is modifierfalse
Samenvattingfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. Appointment.created
Definitie

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.

KortThe date that this appointment was initially created
Opmerkingen

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.

Control0..1
TypedateTime
Is modifierfalse
Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
Samenvattingfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. Appointment.comment
Definitie

Additional comments about the appointment.

KortAdditional comments
Opmerkingen

Additional text to aid in facilitating the appointment. For instance, a comment 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.

Control0..1
Typestring
Is modifierfalse
Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
Samenvattingfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. Appointment.patientInstruction
Definitie

While Appointment.comment 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).

KortDetailed information and instructions for the patient
Control0..1
Typestring
Is modifierfalse
Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
Samenvattingfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
56. Appointment.basedOn
Definitie

The service request this appointment is allocated to assess (e.g. incoming referral or procedure request).

KortThe service request this appointment is allocated to assess
Control0..*
TypeReference(ServiceRequest)
Is modifierfalse
Samenvattingfalse
Alternatieve namenincomingReferral
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. Appointment.participant
Definitie

List of participants involved in the appointment.

KortParticipants involved in appointment
Control1..*
TypeBackboneElement
Is modifierfalse
Moet ondersteunentrue
Samenvattingfalse
Invariantsapp-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()))
60. Appointment.participant.id
Definitie

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

KortUnique id for inter-element referencing
Control0..1
Typestring
Is modifierfalse
Xml-formaatIn xml wordt dit attribuut gerepresenteerd als attribuut.
Samenvattingfalse
62. Appointment.participant.extension
Definitie

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 manageable, 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.

KortAdditional content defined by implementations
Opmerkingen

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.

Control0..*
TypeExtension
Is modifierfalse
Samenvattingfalse
Alternatieve namenextensions, user content
Invariantsele-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())
64. Appointment.participant.modifierExtension
Definitie

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 manageable, 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).

KortExtensions that cannot be ignored even if unrecognized
Opmerkingen

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.

Control0..*
TypeExtension
Is modifiertrue omdat Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Samenvattingtrue
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.

Alternatieve namenextensions, user content, modifiers
Invariantsele-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())
66. Appointment.participant.type
Definitie

Role of participant in the appointment.

KortRole of participant in the appointment
Opmerkingen

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.

Control0..*
BindingTenzij dat niet past, MOETEN deze codes worden gehaald uit ParticipantType
(extensible to http://hl7.org/fhir/ValueSet/encounter-participant-type|4.0.1)

Role of participant in encounter.

TypeCodeableConcept
Is modifierfalse
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
68. Appointment.participant.actor
Definitie

A Person, Location/HealthcareService or Device that is participating in the appointment.

KortPerson, Location/HealthcareService or Device
Control0..1
TypeReference(Patient, Practitioner, PractitionerRole, RelatedPerson, Device, HealthcareService, Location)
Is modifierfalse
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
70. Appointment.participant.required
Definitie

Whether this participant is required to be present at the meeting. This covers a 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.

Kortrequired | optional | information-only
Control0..1
BindingDe codes MOETEN komen uit ParticipantRequired
(required to http://hl7.org/fhir/ValueSet/participantrequired|4.0.1)

Is the Participant required to attend the appointment.

Typecode
Is modifierfalse
Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
72. Appointment.participant.status
Definitie

Participation status of the actor.

Kortaccepted | declined | tentative | needs-action
Control1..1
BindingDe codes MOETEN komen uit ParticipationStatus
(required to http://hl7.org/fhir/ValueSet/participationstatus|4.0.1)

The Participation status of an appointment.

Typecode
Is modifierfalse
Primitieve waardeDit primitieve element kan aanwezig zijn of niet, of worden vervangen door een extensie
Samenvattingtrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
74. Appointment.participant.period
Definitie

Participation period of the actor.

KortParticipation period of the actor
Control0..1
TypePeriod
Is modifierfalse
Samenvattingfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
76. Appointment.requestedPeriod
Definitie

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.

KortPotential date/time interval(s) requested to allocate the appointment within
Opmerkingen

This does not introduce a capacity for recurring appointments.

Control0..*
TypePeriod
Is modifierfalse
Samenvattingfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))