FHIR Clincal Guidelines (v0.1.0) (STU1 Ballot)

This page is part of the Clinical Guidelines (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

D.4.1.4 StructureDefinition: cpg-appointment - Detailed Descriptions

Definitions for the StructureDefinition-cpg-appointment Profile.

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

Control0..*
InvariantsDefined 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.id
Definition

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

Control0..1
Typeid
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.

Control0..1
TypeMeta
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.

Control0..1
Typeuri
Is Modifiertrue
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.

5. Appointment.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language.
The codes SHOULD be taken from CommonLanguages
Max Binding: AllLanguages
Typecode
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).

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.

Control0..1
TypeNarrative
Alternate Namesnarrative, 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.

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.

Control0..*
TypeResource
Alternate Namesinline 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

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on Appointment.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
9. Appointment.extension:instantiatesCanonical
SliceNameinstantiatesCanonical
Definition

The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by the event or request resource.

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(instantiatesCanonical) (Extension Type: canonical(ActivityDefinition | Measure | OperationDefinition | PlanDefinition | Questionnaire))
Must Supporttrue
InvariantsDefined 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.extension:strengthOfRecommendation
SliceNamestrengthOfRecommendation
Definition

The strength of the recommendation assigned to this reference. The code system used specifies the rating scale used to rate this recommendation while the code specifies the actual recommendation rating (represented as a coded value) associated with this recommendation.

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(strengthOfRecommendation) (Extension Type: CodeableConcept)
Must Supporttrue
InvariantsDefined 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())
11. Appointment.extension:qualityOfEvidence
SliceNamequalityOfEvidence
Definition

The quality of the evidence described. The code system used specifies the quality scale used to grade this evidence source while the code specifies the actual quality score (represented as a coded value) associated with the evidence.

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(qualityOfEvidence) (Extension Type: CodeableConcept)
Must Supporttrue
InvariantsDefined 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.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).

Control0..*
TypeExtension
Is Modifiertrue
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 Namesextensions, 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.

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

NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..*
TypeIdentifier
Must Supporttrue
14. 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.

Control1..1
BindingThe free/busy status of an appointment.
The codes SHALL be taken from AppointmentStatus
Typecode
Is Modifiertrue
Must Supporttrue
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.

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

Control0..1
BindingFor example codes, see AppointmentCancellationReason
TypeCodeableConcept
16. Appointment.serviceCategory
Definition

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

Control0..*
BindingFor example codes, see ServiceCategory
TypeCodeableConcept
17. Appointment.serviceType
Definition

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

Control0..*
BindingFor example codes, see ServiceType
TypeCodeableConcept
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.

18. Appointment.specialty
Definition

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

Control0..*
BindingThe codes SHOULD be taken from PracticeSettingCodeValueSet
TypeCodeableConcept
19. Appointment.appointmentType
Definition

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

Control0..1
BindingThe codes SHOULD be taken from v2 Appointment Reason Codes
TypeCodeableConcept
20. Appointment.reasonCode
Definition

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

Control0..*
BindingThe Reason for the appointment to take place.
The codes SHOULD be taken from EncounterReasonCodes
TypeCodeableConcept
21. 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.

Control0..*
TypeReference(Condition | Procedure | Observation | ImmunizationRecommendation)
22. 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).

Control0..1
TypeunsignedInt
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.

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

Control0..1
Typestring
24. Appointment.supportingInformation
Definition

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

Control0..*
TypeReference(Resource)
Must Supporttrue
25. Appointment.start
Definition

Date/Time that the appointment is to take place.

Control0..1
Typeinstant
26. Appointment.end
Definition

Date/Time that the appointment is to conclude.

Control0..1
Typeinstant
27. 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.

Control0..1
TypepositiveInt
28. Appointment.slot
Definition

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

Control0..*
TypeReference(Slot)
29. 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.

Control0..1
TypedateTime
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.

30. Appointment.comment
Definition

Additional comments about the appointment.

Control0..1
Typestring
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.

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

Control0..1
Typestring
32. Appointment.basedOn
Definition

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

Control0..*
TypeReference(ServiceRequest)
Alternate NamesincomingReferral
33. Appointment.participant
Definition

List of participants involved in the appointment.

Control1..*
TypeBackboneElement
InvariantsDefined 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()))
34. 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.

Control0..1
Typestring
35. 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.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

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

Control0..*
TypeExtension
Is Modifiertrue
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 Namesextensions, 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.

37. Appointment.participant.type
Definition

Role of participant in the appointment.

Control0..*
BindingRole of participant in encounter.
The codes SHALL be taken from ParticipantType; other codes may be used where these codes are not suitable
TypeCodeableConcept
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.

38. Appointment.participant.actor
Definition

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

Control0..1
TypeReference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location)
39. 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.

Control0..1
BindingIs the Participant required to attend the appointment.
The codes SHALL be taken from ParticipantRequired
Typecode
40. Appointment.participant.status
Definition

Participation status of the actor.

Control1..1
BindingThe Participation status of an appointment.
The codes SHALL be taken from ParticipationStatus
Typecode
41. Appointment.participant.period
Definition

Participation period of the actor.

Control0..1
TypePeriod
42. 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.

Control0..*
TypePeriod
Comments

This does not introduce a capacity for recurring appointments.