HL7 FHIR Implementation Guide: Public Health IG Release 1 - BE Realm | STU1
1.0.0 - STU1

Publication Build: This will be filled in by the publication tooling

## Resource Profile: BePopulationScreeningAppointment - Detailed Descriptions

Draft as of 2023-06-27 | Maturity Level: 1

Definitions for the be-populationscreening-appointment resource profile.

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

Guidance on how to interpret the contents of this table can be found here.

1. Appointment
2. Appointment.identifier
Note | This is a business identifier, not a resource identifier (see discussion)
Must Support | true
3. Appointment.serviceCategory
Must Support | true
4. Appointment.serviceType
Must Support | true
5. Appointment.reasonCode
Must Support | true
6. Appointment.start
Must Support | true
7. Appointment.participant
Slicing | This element introduces a set of slices on Appointment.participant. The slices are unordered and Open, and can be differentiated using the following discriminators: type @ actor.resolve()
8. Appointment.participant:patient
SliceName | patient
Control | 1..1
Must Support | true
9. Appointment.participant:patient.actor
Control | 0..?
Type | Reference(BePatient)
10. Appointment.participant:location
SliceName | location
Control | 0..1
Must Support | true
11. Appointment.participant:location.actor
Control | 0..?
Type | Reference(Location)

Guidance on how to interpret the contents of this table can be found here.

1. Appointment
Definition | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).
Control | 0..*
Summary | false
Invariants | Defined on this element 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')) 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.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Control | 0..1
Type | uri
Is Modifier | true
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
3. Appointment.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | false
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
4. Appointment.identifier
Definition | This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Must Support | true
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. Appointment.status
Definition | The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.
Control | 1..1
Binding | The codes SHALL be taken from AppointmentStatus The free/busy status of an appointment.
Type | code
Is Modifier | true
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Comments | If the Appointment's status is "cancelled" then all participants are expected to have their calendars released for the appointment period, and as such any Slots that were marked as BUSY can be re-set to FREE. This element is labeled as a modifier because the status contains the code entered-in-error that mark the Appointment as not currently valid.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. Appointment.serviceCategory
Definition | A broad categorization of the service that is to be performed during this appointment.
Control | 0..*
Binding | For example codes, see ServiceCategory
Type | CodeableConcept
Must Support | true
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. Appointment.serviceType
Definition | The specific service that is to be performed during this appointment.
Control | 0..*
Binding | For example codes, see ServiceType
Type | CodeableConcept
Must Support | true
Summary | true
Comments | For a provider to provider appointment the code "FOLLOWUP" may be appropriate, as this is expected to be discussing some patient that was seen in the past.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
8. Appointment.reasonCode
Definition | The coded reason that this appointment is being scheduled. This is more clinical than administrative.
Control | 0..*
Binding | The codes SHOULD be taken from EncounterReasonCodes The Reason for the appointment to take place.
Type | CodeableConcept
Must Support | true
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
9. Appointment.start
Definition | Date/Time that the appointment is to take place.
Control | 0..1
Type | instant
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
10. Appointment.participant
Definition | List of participants involved in the appointment.
Control | 1..*
Type | BackboneElement
Summary | false
Invariants | Defined on this element app-1: Either the type or actor on the participant SHALL be specified (: type.exists() or actor.exists()) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on Appointment.participant. The slices are unordered and Open, and can be differentiated using the following discriminators: type @ actor.resolve()
11. Appointment.participant.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
12. Appointment.participant.status
Definition | Participation status of the actor.
Control | 1..1
Binding | The codes SHALL be taken from ParticipationStatus The Participation status of an appointment.
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. Appointment.participant:patient
SliceName | patient
Definition | List of participants involved in the appointment.
Control | 1..1*
Type | BackboneElement
Must Support | true
Summary | false
Invariants | Defined on this element app-1: Either the type or actor on the participant SHALL be specified (: type.exists() or actor.exists()) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. Appointment.participant:patient.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
15. Appointment.participant:patient.actor
Definition | A Person, Location/HealthcareService or Device that is participating in the appointment.
Control | 0..1
Type | Reference(BePatient|Patient|Practitioner|PractitionerRole|RelatedPerson|Device|HealthcareService|Location)
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. Appointment.participant:patient.status
Definition | Participation status of the actor.
Control | 1..1
Binding | The codes SHALL be taken from ParticipationStatus The Participation status of an appointment.
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
17. Appointment.participant:location
SliceName | location
Definition | List of participants involved in the appointment.
Control | 01..1*
Type | BackboneElement
Must Support | true
Summary | false
Invariants | Defined on this element app-1: Either the type or actor on the participant SHALL be specified (: type.exists() or actor.exists()) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
18. Appointment.participant:location.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
19. Appointment.participant:location.actor
Definition | A Person, Location/HealthcareService or Device that is participating in the appointment.
Control | 0..1
Type | Reference(Location|Patient|Practitioner|PractitionerRole|RelatedPerson|Device|HealthcareService)
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
20. Appointment.participant:location.status
Definition | Participation status of the actor.
Control | 1..1
Binding | The codes SHALL be taken from ParticipationStatus The Participation status of an appointment.
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here.

1. Appointment
Definition | A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).
Control | 0..*
Summary | false
2. Appointment.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Control | 0..1
Type | id
Summary | true
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
3. Appointment.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Control | 0..1
Type | Meta
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. Appointment.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Control | 0..1
Type | uri
Is Modifier | true
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. Appointment.language
Definition | The base language in which the resource is written.
Control | 0..1
Binding | The codes SHOULD be taken from CommonLanguages A human language
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. Appointment.text
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Control | 0..1
Type | Narrative
Summary | false
Alternate Names | narrative, html, xhtml, display
Comments | 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. Appointment.contained
Definition | 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.
Control | 0..*
Type | Resource
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
8. Appointment.extension
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and 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.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
9. Appointment.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | false
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. Appointment.identifier
Definition | This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Must Support | true
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
11. Appointment.status
Definition | The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.
Control | 1..1
Binding | The codes SHALL be taken from AppointmentStatus The free/busy status of an appointment
Type | code
Is Modifier | true
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Comments | If the Appointment's status is "cancelled" then all participants are expected to have their calendars released for the appointment period, and as such any Slots that were marked as BUSY can be re-set to FREE. This element is labeled as a modifier because the status contains the code entered-in-error that mark the Appointment as not currently valid.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
12. Appointment.cancelationReason
Definition | The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply.
Control | 0..1
Binding | For example codes, see AppointmentCancellationReason
Type | CodeableConcept
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. Appointment.serviceCategory
Definition | A broad categorization of the service that is to be performed during this appointment.
Control | 0..*
Binding | For example codes, see ServiceCategory
Type | CodeableConcept
Must Support | true
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. Appointment.serviceType
Definition | The specific service that is to be performed during this appointment.
Control | 0..*
Binding | For example codes, see ServiceType
Type | CodeableConcept
Must Support | true
Summary | true
Comments | For a provider to provider appointment the code "FOLLOWUP" may be appropriate, as this is expected to be discussing some patient that was seen in the past.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. Appointment.specialty
Definition | The specialty of a practitioner that would be required to perform the service requested in this appointment.
Control | 0..*
Binding | The codes SHOULD be taken from PracticeSettingCodeValueSet
Type | CodeableConcept
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. Appointment.appointmentType
Definition | The style of appointment or patient that has been booked in the slot (not service type).
Control | 0..1
Binding | The codes SHOULD be taken from hl7VS-appointmentReasonCodes
Type | CodeableConcept
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
17. Appointment.reasonCode
Definition | The coded reason that this appointment is being scheduled. This is more clinical than administrative.
Control | 0..*
Binding | The codes SHOULD be taken from EncounterReasonCodes The Reason for the appointment to take place
Type | CodeableConcept
Must Support | true
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
18. Appointment.reasonReference
Definition | 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.
Control | 0..*
Type | Reference(Condition|Procedure|Observation|ImmunizationRecommendation)
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
19. Appointment.priority
Definition | The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).
Control | 0..1
Type | unsignedInt
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Comments | Seeking implementer feedback on this property and how interoperable it is. Using an extension to record a CodeableConcept for named values may be tested at a future connectathon.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
20. Appointment.description
Definition | The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
21. Appointment.supportingInformation
Definition | Additional information to support the appointment provided when making the appointment.
Control | 0..*
Type | Reference(Resource)
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. Appointment.start
Definition | Date/Time that the appointment is to take place.
Control | 0..1
Type | instant
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
23. Appointment.end
Definition | Date/Time that the appointment is to conclude.
Control | 0..1
Type | instant
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
24. Appointment.minutesDuration
Definition | Number of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.
Control | 0..1
Type | positiveInt
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
25. Appointment.slot
Definition | The slots from the participants' schedules that will be filled by the appointment.
Control | 0..*
Type | Reference(Slot)
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
26. Appointment.created
Definition | The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.
Control | 0..1
Type | dateTime
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Comments | This property is required for many use cases where the age of an appointment is considered in processing workflows for scheduling and billing of appointments.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
27. Appointment.comment
Definition | Additional comments about the appointment.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Comments | 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
28. Appointment.patientInstruction
Definition | 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).
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
29. Appointment.basedOn
Definition | The service request this appointment is allocated to assess (e.g. incoming referral or procedure request).
Control | 0..*
Type | Reference(ServiceRequest)
Summary | false
Alternate Names | incomingReferral
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
30. Appointment.participant
Definition | List of participants involved in the appointment.
Control | 1..*
Type | BackboneElement
Summary | false
Invariants | Defined on this element app-1: Either the type or actor on the participant SHALL be specified (: type.exists() or actor.exists()) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on Appointment.participant. The slices are unordered and Open, and can be differentiated using the following discriminators: type @ actor.resolve()
31. Appointment.participant.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
32. Appointment.participant.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
33. Appointment.participant.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
34. Appointment.participant.type
Definition | Role of participant in the appointment.
Control | 0..*
Binding | The codes SHALL be taken from ParticipantType; other codes may be used where these codes are not suitable Role of participant in encounter
Type | CodeableConcept
Summary | true
Comments | The role of the participant can be used to declare what the actor will be doing in the scope of this appointment. If the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning. This value SHALL be the same when creating an AppointmentResponse so that they can be matched, and subsequently update the Appointment.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
35. Appointment.participant.actor
Definition | A Person, Location/HealthcareService or Device that is participating in the appointment.
Control | 0..1
Type | Reference(Patient|Practitioner|PractitionerRole|RelatedPerson|Device|HealthcareService|Location)
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
36. Appointment.participant.required
Definition | 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.
Control | 0..1
Binding | The codes SHALL be taken from ParticipantRequired Is the Participant required to attend the appointment
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
37. Appointment.participant.status
Definition | Participation status of the actor.
Control | 1..1
Binding | The codes SHALL be taken from ParticipationStatus The Participation status of an appointment
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
38. Appointment.participant.period
Definition | Participation period of the actor.
Control | 0..1
Type | Period
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
39. Appointment.participant:patient
SliceName | patient
Definition | List of participants involved in the appointment.
Control | 1..1
Type | BackboneElement
Must Support | true
Summary | false
Invariants | Defined on this element app-1: Either the type or actor on the participant SHALL be specified (: type.exists() or actor.exists()) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
40. Appointment.participant:patient.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
41. Appointment.participant:patient.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
42. Appointment.participant:patient.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
43. Appointment.participant:patient.type
Definition | Role of participant in the appointment.
Control | 0..*
Binding | The codes SHALL be taken from ParticipantType; other codes may be used where these codes are not suitable Role of participant in encounter
Type | CodeableConcept
Summary | true
Comments | The role of the participant can be used to declare what the actor will be doing in the scope of this appointment. If the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning. This value SHALL be the same when creating an AppointmentResponse so that they can be matched, and subsequently update the Appointment.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
44. Appointment.participant:patient.actor
Definition | A Person, Location/HealthcareService or Device that is participating in the appointment.
Control | 0..1
Type | Reference(BePatient)
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
45. Appointment.participant:patient.required
Definition | 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.
Control | 0..1
Binding | The codes SHALL be taken from ParticipantRequired Is the Participant required to attend the appointment
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
46. Appointment.participant:patient.status
Definition | Participation status of the actor.
Control | 1..1
Binding | The codes SHALL be taken from ParticipationStatus The Participation status of an appointment
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
47. Appointment.participant:patient.period
Definition | Participation period of the actor.
Control | 0..1
Type | Period
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
48. Appointment.participant:location
SliceName | location
Definition | List of participants involved in the appointment.
Control | 0..1
Type | BackboneElement
Must Support | true
Summary | false
Invariants | Defined on this element app-1: Either the type or actor on the participant SHALL be specified (: type.exists() or actor.exists()) ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
49. Appointment.participant:location.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
Summary | false
50. Appointment.participant:location.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
Control | 0..*
Type | Extension
Summary | false
Alternate Names | extensions, user content
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
51. Appointment.participant:location.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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).
Control | 0..*
Type | Extension
Is Modifier | true
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
52. Appointment.participant:location.type
Definition | Role of participant in the appointment.
Control | 0..*
Binding | The codes SHALL be taken from ParticipantType; other codes may be used where these codes are not suitable Role of participant in encounter
Type | CodeableConcept
Summary | true
Comments | The role of the participant can be used to declare what the actor will be doing in the scope of this appointment. If the actor is not specified, then it is expected that the actor will be filled in at a later stage of planning. This value SHALL be the same when creating an AppointmentResponse so that they can be matched, and subsequently update the Appointment.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
53. Appointment.participant:location.actor
Definition | A Person, Location/HealthcareService or Device that is participating in the appointment.
Control | 0..1
Type | Reference(Location)
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
54. Appointment.participant:location.required
Definition | 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.
Control | 0..1
Binding | The codes SHALL be taken from ParticipantRequired Is the Participant required to attend the appointment
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
55. Appointment.participant:location.status
Definition | Participation status of the actor.
Control | 1..1
Binding | The codes SHALL be taken from ParticipationStatus The Participation status of an appointment
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
56. Appointment.participant:location.period
Definition | Participation period of the actor.
Control | 0..1
Type | Period
Summary | false
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
57. Appointment.requestedPeriod
Definition | A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. The duration (usually in minutes) could also be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time. However, in other situations the duration may be calculated by the scheduling system.
Control | 0..*
Type | Period
Summary | false
Comments | This does not introduce a capacity for recurring appointments.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))