extension shown: fhir [x]

Appointment

Defined in the fhir.schema.org extension.
Canonical URL: http://schema.org/Appointment

Thing > Resource > DomainResource > Appointment
workflow.scheduling > Appointment

Base StructureDefinition for Appointment Resource

Usage: Fewer than 10 domains
PropertyExpected TypeDescription
Properties from Appointment
Appointment.comment Text Additional comments about the appointment.
Appointment.description Text 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.
Appointment.end DateTime Date/Time that the appointment is to conclude.
Appointment.identifier Identifier 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).
Appointment.minutesDuration positiveInt Number of minutes that the appointment is to take. This can be less than the duration between the start and end times (where actual time of appointment is only an estimate or is a planned appointment request).
Appointment.participant BackboneElement List of participants involved in the appointment.
Appointment.participant.actor Patient  or
RelatedPerson  or
Device  or
HealthcareService  or
Practitioner  or
Location 
A Person, Location/HealthcareService or Device that is participating in the appointment.
Appointment.participant.required participantrequired Is this participant required to be present at the meeting. This covers a use-case where 2 doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present.
Appointment.participant.status participationstatus Participation status of the Patient.
Appointment.participant.type encounter-participant-type Role of participant in the appointment.
Appointment.priority unsignedInt 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).
Appointment.reason encounter-reason The reason that this appointment is being scheduled. This is more clinical than administrative.
Appointment.slot Slot The slot that this appointment is filling. If provided then the schedule will not be provided as slots are not recursive, and the start/end values MUST be the same as from the slot.
Appointment.start DateTime Date/Time that the appointment is to take place.
Appointment.status appointmentstatus 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.
Appointment.type c80-practice-codes The type of appointment that is being booked (This may also be associated with participants for location, and/or a HealthcareService).
Properties from DomainResource
DomainResource.contained Resource 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.
DomainResource.extension Extension May be used to represent additional information that is not part of the basic definition of the resource. In order 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.
DomainResource.modifierExtension Extension 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. Usually modifier elements provide negation or qualification. In order 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.
DomainResource.text Narrative A human-readable narrative that contains a summary of the resource, and may 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.
Properties from Resource
Resource.id Text The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Resource.implicitRules Text A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
Resource.language http://tools.ietf.org/html/bcp47 The base language in which the resource is written.
Resource.meta Meta The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
Properties from Thing
additionalType URL An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
alternateName Text An alias for the item.
description Text A description of the item.
disambiguatingDescription Text A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.
image URL  or
ImageObject 
An image of the item. This can be a URL or a fully described ImageObject.
mainEntityOfPage CreativeWork  or
URL 
Indicates a page (or other CreativeWork) for which this thing is the main entity being described.

See background notes for details.
Inverse property: mainEntity.
name Text The name of the item.
potentialAction Action Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
sameAs URL URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Freebase page, or official website.
url URL URL of the item.


Instances of Appointment may appear as values for the following properties
PropertyOn TypesDescription
AppointmentResponse.appointment AppointmentResponse Appointment that this response is replying to.
CarePlan.activity.reference CarePlan The details of the proposed activity represented in a specific resource.
ClinicalImpression.action ClinicalImpression Actions taken during assessment.
ClinicalImpression.plan ClinicalImpression Plan of action after assessment.
Encounter.appointment Encounter The appointment that scheduled this encounter.

Available supertypes defined in extensions

Schema Version 2.2