UKCoreAppointment (Appointment) | C | | Appointment | There are no (further) constraints on this element Element idAppointment Short descriptionA 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) DefinitionA 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).
Data typeAppointment Constraints- 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() Mappings- rim: Entity. Role, or Act
- workflow: Request
- rim: Act[@moodCode <= 'INT']
- ical: VEVENT
|
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idAppointment.id Short descriptionLogical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
CommentsThe only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Data typestring |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idAppointment.meta Short descriptionMetadata about the resource DefinitionThe 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.
Data typeMeta Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idAppointment.implicitRules Short descriptionA set of rules under which this content was created DefinitionA 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.
CommentsAsserting 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.
Data typeuri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
language | | 0..1 | codeBinding | There are no (further) constraints on this element Element idAppointment.language Short descriptionLanguage of the resource content DefinitionThe base language in which the resource is written.
CommentsLanguage 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).
Data typecode BindingCommonLanguages (preferred) Binding extensionsConstraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
|
text | | 0..1 | Narrative | There are no (further) constraints on this element Element idAppointment.text Short descriptionText summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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.
CommentsContained 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.
Data typeNarrative Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
contained | | 0..* | Resource | There are no (further) constraints on this element Element idAppointment.contained Short descriptionContained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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.
CommentsThis 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.
Data typeResource Mappings |
extension | C | 0..* | Extension | Element idAppointment.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Constraints- 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() Mappings |
bookingOrganization | C | 0..1 | Extension(Reference(Organization)) | Element idAppointment.extension:bookingOrganization Short descriptionAn extension to record the organisation booking the appointment Alternate namesextensions, user content DefinitionAn extension to record the organisation booking the appointment.
CommentsThere 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.
Data typeExtension(Reference(Organization)) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BookingOrganization ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- 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() Mappings |
deliveryChannel | C | 0..1 | Extension(CodeableConcept) | Element idAppointment.extension:deliveryChannel Short descriptionAn extension to record the delivery channel of a scheduled Appointment Alternate namesextensions, user content DefinitionAn extension to record the delivery channel of a scheduled Appointment.
CommentsThere 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.
Data typeExtension(CodeableConcept) Extension URLhttps://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeliveryChannel ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints- 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() Mappings |
modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idAppointment.modifierExtension Short descriptionExtensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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).
RequirementsModifier 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.
CommentsThere 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.
Data typeExtension Constraints- 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() Mappings |
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idAppointment.identifier Short descriptionExternal Ids for this item DefinitionThis 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).
Data typeIdentifier Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Request.identifier
- w5: FiveWs.identifier
- v2: SCH-1, SCH-2, ARQ-1, ARQ-2
- rim: .id
- ical: UID
|
status | S Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idAppointment.status Short descriptionproposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist DefinitionThe 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.
CommentsIf 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.
Data typecode BindingThe free/busy status of an appointment.
AppointmentStatus (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Request.status
- w5: FiveWs.status
- v2: SCH-25
- rim: .statusCode
- ical: STATUS
|
cancelationReason | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idAppointment.cancelationReason Short descriptionThe coded reason for the appointment being cancelled DefinitionThe 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.
Data typeCodeableConcept BindingAppointmentCancellationReason (example) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
serviceCategory | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idAppointment.serviceCategory Short descriptionA broad categorization of the service that is to be performed during this appointment DefinitionA broad categorization of the service that is to be performed during this appointment.
Data typeCodeableConcept BindingServiceCategory (example) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: n/a, might be inferred from the ServiceDeliveryLocation
- ical: CATEGORIES
|
serviceType | Σ | 0..* | CodeableConcept | There are no (further) constraints on this element Element idAppointment.serviceType Short descriptionThe specific service that is to be performed during this appointment DefinitionThe specific service that is to be performed during this appointment.
CommentsFor 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.
Data typeCodeableConcept BindingServiceType (example) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Request.code
- rim: n/a, might be inferred from the ServiceDeliveryLocation
|
specialty | S Σ | 0..* | CodeableConceptBinding | Element idAppointment.specialty Short descriptionThe specialty of a practitioner that would be required to perform the service requested in this appointment DefinitionThe specialty of a practitioner that would be required to perform the service requested in this appointment.
Data typeCodeableConcept BindingUKCorePracticeSettingCode (extensible) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- w5: FiveWs.class
- rim: .performer.AssignedPerson.code
|
appointmentType | S Σ | 0..1 | CodeableConceptBinding | Element idAppointment.appointmentType Short descriptionThe style of appointment or patient that has been booked in the slot (not service type) DefinitionThe style of appointment or patient that has been booked in the slot (not service type).
Data typeCodeableConcept BindingA set of codes that define an appointment reason.
UKCoreAppointmentReasonCode (extensible) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: ARQ-7
- rim: .code
- ical: CLASSIFICATION
|
reasonCode | S Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idAppointment.reasonCode Short descriptionCoded reason this appointment is scheduled DefinitionThe coded reason that this appointment is being scheduled. This is more clinical than administrative.
Data typeCodeableConcept BindingThe Reason for the appointment to take place.
EncounterReasonCodes (preferred) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Request.reasonCode
- v2: AIS-3, SCH-7
- rim: .reasonCode
|
reasonReference | S | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | There are no (further) constraints on this element Element idAppointment.reasonReference Short descriptionReason the appointment is to take place (resource) DefinitionReason 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.
Data typeReference(Condition | Procedure | Observation | ImmunizationRecommendation) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Request.reasonReference
- rim: .inboundRelationship[@typeCode = 'RSON'].observation
|
priority | | 0..1 | unsignedInt | There are no (further) constraints on this element Element idAppointment.priority Short descriptionUsed to make informed decisions if needing to re-prioritize DefinitionThe 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).
CommentsSeeking 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.
Data typeunsignedInt Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Request.priority
- w5: FiveWs.class
- v2: ARQ-12, SCH-11.6 / TQ1-9
- rim: .priorityCode
- ical: PRIORITY
|
description | | 0..1 | string | There are no (further) constraints on this element Element idAppointment.description Short descriptionShown on a subject line in a meeting request, or appointment list DefinitionThe 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.
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: NTE-3
- rim: .text
- ical: SUMMARY
|
supportingInformation | | 0..* | Reference(Resource) | There are no (further) constraints on this element Element idAppointment.supportingInformation Short descriptionAdditional information to support the appointment DefinitionAdditional information to support the appointment provided when making the appointment.
Data typeReference(Resource) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Request.supportingInfo
- w5: FiveWs.context
- rim: .inboundRelationship[@typeCode = 'SPRT'].observation
- ical: ATTACH
|
start | S Σ | 0..1 | instant | There are no (further) constraints on this element Element idAppointment.start Short descriptionWhen appointment is to take place DefinitionDate/Time that the appointment is to take place.
Data typeinstant Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Request.occurrence[x]
- w5: FiveWs.init
- v2: ARQ-11.1, SCH-11.4 / TQ1-7
- rim: .effectiveTime.low
- ical: DTSTART
|
end | Σ | 0..1 | instant | There are no (further) constraints on this element Element idAppointment.end Short descriptionWhen appointment is to conclude DefinitionDate/Time that the appointment is to conclude.
Data typeinstant Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Request.occurrence[x]
- w5: FiveWs.done[x]
- v2: SCH-11.5 / TQ1-8/ calculated based on the start and the duration which is in ARQ-9
- rim: .effectiveTime.high
- ical: DTEND
|
minutesDuration | | 0..1 | positiveInt | There are no (further) constraints on this element Element idAppointment.minutesDuration Short descriptionCan be less than start/end (e.g. estimate) DefinitionNumber 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.
Data typepositiveInt Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Request.occurrence[x]
- rim: .activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')].width
- ical: DURATION (e.g. PT15M)
|
slot | | 0..* | Reference(Slot) | There are no (further) constraints on this element Element idAppointment.slot Short descriptionThe slots that this appointment is filling DefinitionThe slots from the participants' schedules that will be filled by the appointment.
Data typeReference(Slot) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: .outboundRelationship[@typeCode = 'REFR'].act[@classCode = 'ACT'][@moodCode = 'SLOT']
|
created | | 0..1 | dateTime | There are no (further) constraints on this element Element idAppointment.created Short descriptionThe date that this appointment was initially created DefinitionThe 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.
CommentsThis property is required for many use cases where the age of an appointment is considered in processing workflows for scheduling and billing of appointments.
Data typedateTime Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Request.authoredOn
- rim: .author.time
- ical: CREATED
|
patientInstruction | | 0..1 | string | There are no (further) constraints on this element Element idAppointment.patientInstruction Short descriptionDetailed information and instructions for the patient DefinitionWhile 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).
Data typestring Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: NTE-3
- rim: .subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value
- ical: DESCRIPTION (for patient use)
|
basedOn | S | 0..* | Reference(ServiceRequest) | There are no (further) constraints on this element Element idAppointment.basedOn Short descriptionThe service request this appointment is allocated to assess Alternate namesincomingReferral DefinitionThe service request this appointment is allocated to assess (e.g. incoming referral or procedure request).
Data typeReference(ServiceRequest) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Request.basedOn
- rim: .outboundRelationship[@typeCode = 'FLFS'].act[@classCode < 'ActCareProvisionRequestType'][@moodCode = 'RQO']
|
participant | S C | 1..* | BackboneElement | There are no (further) constraints on this element Element idAppointment.participant Short descriptionParticipants involved in appointment DefinitionList of participants involved in the appointment.
Data typeBackboneElement Constraints- 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()) Mappings- workflow: Request.performer, Request.subject
- v2: PID, AIP, AIG, AIL
- rim: performer | reusableDevice | subject | location
- ical: ATTENDEE component to be created
|
id | | 0..1 | string | There are no (further) constraints on this element Element idAppointment.participant.id Short descriptionUnique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
extension | C | 0..* | Extension | There are no (further) constraints on this element Element idAppointment.participant.extension Short descriptionAdditional content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension Constraints- 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() Mappings |
modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idAppointment.participant.modifierExtension Short descriptionExtensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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).
RequirementsModifier 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.
CommentsThere 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.
Data typeExtension Constraints- 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() Mappings |
type | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idAppointment.participant.type Short descriptionRole of participant in the appointment DefinitionRole of participant in the appointment.
CommentsThe 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.
Data typeCodeableConcept BindingRole of participant in encounter.
ParticipantType (extensible) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: AIP-4, AIG-4
- rim: (performer | reusableDevice | subject | location).@typeCode
- ical: n/a
|
actor | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) | There are no (further) constraints on this element Element idAppointment.participant.actor Short descriptionPerson, Location/HealthcareService or Device DefinitionA Person, Location/HealthcareService or Device that is participating in the appointment.
Data typeReference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- w5: FiveWs.who
- v2: PID-3-Patient ID List | AIL-3 | AIG-3 | AIP-3
- rim: performer.person | reusableDevice.manufacturedDevice | subject.patient | location.serviceDeliveryLocation
- ical: ATTENDEE: (Need to provide the common name CN and also the MAILTO properties from the practitioner resource) where the participant type is not "information-only"
|
required | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idAppointment.participant.required Short descriptionrequired | optional | information-only DefinitionWhether 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.
Data typecode BindingIs the Participant required to attend the appointment.
ParticipantRequired (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- rim: (performer | reusableDevice | subject | location).@performInd
- ical: ROLE=REQ-PARTICIPANT (roleparam)
|
status | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idAppointment.participant.status Short descriptionaccepted | declined | tentative | needs-action DefinitionParticipation status of the actor.
Data typecode BindingThe Participation status of an appointment.
ParticipationStatus (required) Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- v2: AIP-12, AIG-14
- rim: (performer | reusableDevice | subject | location).statusCode
- ical: ATTENDEE;CN="John Doe";RSVP=TRUE:mailto:john@doe.com (rsvpparam | partstatparam)
|
period | | 0..1 | Period | There are no (further) constraints on this element Element idAppointment.participant.period Short descriptionParticipation period of the actor DefinitionParticipation period of the actor.
Data typePeriod Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings |
requestedPeriod | | 0..* | Period | There are no (further) constraints on this element Element idAppointment.requestedPeriod Short descriptionPotential date/time interval(s) requested to allocate the appointment within DefinitionA 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.
CommentsThis does not introduce a capacity for recurring appointments.
Data typePeriod Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) Mappings- workflow: Request.occurrence[x]
- v2: ARQ-11
- rim: .activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')]
|