Implementation Guide
25.0.0 - R4 APIs

Publish Box goes here

Resource Profile: Profile - Athena Appointment

Official URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition-athena-appointment-profile.html Version: 25.0.0
Active as of 2022-03-01 Computable Name: AthenaAppointment

Defines constraints and extensions on the appointment resource as supported by Athena Products.

This Appointment profile is part of the set of resource profiles supported by the API Server used with the athenaPractice and athenaFlow products. It further describes read, search, create and update capabilities of these products.

Overview

Appointment is the booking of a healthcare event among patients, practitioners, related persons, and/or devices at a specific date and time. The appointment may result in one or more Encounters.

Scope and Usage

This profile is used to define the content that will be returned by the API Server in response to requests to access Appointment resources. All elements listed in the differential profile view are Supported, which means that the API Server is capable of supplying these fields from the product database when they have been populated via the product or its APIs.

The profile also defines the content that must be supplied to the API Server in response to requests to populate Appointment resources. Fields which are marked as Mandatory in this profile are those that must be supplied to the API Server in content used to populate a resource.

Source

The Appointment resource provides a means to access, create or update appointment information for patient. Content of the resource derives from the Appointments table in athenaPractice and the APPT table in athenaFlow. Specific detail can be found in the Mappings tab in the profile detail page.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Appointment C 0..* Appointment 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)
Constraints: app-2, app-3, app-4
... id Σ 1..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... lastUpdated Σ 1..1 instant When the resource version last changed
.... Slices for profile Σ 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:athena-appointment-profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-profile
.... Slices for security Σ 0..1 Coding Security Labels applied to this resource
Slice: Unordered, Open by value:coding
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
..... security:SENSITIVECHART Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
.... extension:RecallAppointmentId 0..1 (Complex) Extension
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-extension-RecallAppointmentId
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-extension-RecallAppointmentId"
..... value[x] 1..1 Reference() Value of extension
.... extension:RecallId 0..1 (Complex) Extension
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-extension-RecallId
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-extension-RecallId"
..... value[x] 1..1 Reference() Value of extension
.... extension:Booklist 0..1 (Complex) Extension
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-extension-Booklist
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-extension-Booklist"
..... value[x] 1..1 string Value of extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Ids for this item
... status ?!Σ 1..1 code proposed | pending | booked | arrived | fulfilled | cancelled | noshow | checked-in
Binding: AppointmentStatus (required): The free/busy status of an appointment.
... serviceType Σ 0..* CodeableConcept The specific service that is to be performed during this appointment
Binding: ServiceType (example)
... reasonCode Σ 0..* CodeableConcept Coded reason this appointment is scheduled
Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place.
... priority 0..1 unsignedInt Used to make informed decisions if needing to re-prioritize
... description 0..1 string Shown on a subject line in a meeting request, or appointment list
... start Σ 0..1 instant When appointment is to take place
... end Σ 0..1 instant When appointment is to conclude
... minutesDuration 0..1 positiveInt Can be less than start/end (e.g. estimate)
... slot 0..* Reference(Slot) The slots that this appointment is filling
... comment 0..1 string Additional comments
... Slices for participant C 0..1 BackboneElement Participants involved in appointment
Slice: Unordered, Open by value:type
Constraints: app-1
.... participant:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
.... participant:Patient C 1..1 BackboneElement Participants involved in appointment
Constraints: app-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor Σ 0..1 Reference(Patient) Person, Location/HealthcareService or Device
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
.... participant:Practitioner C 0..1 BackboneElement Participants involved in appointment
Constraints: app-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... Slices for type Σ 0..1 CodeableConcept Role of participant in the appointment
Slice: Unordered, Open by value:type
Binding: ParticipantType (extensible): Role of participant in encounter.
...... type:T1_Type Σ 0..1 CodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.
...... type:T2_Type Σ 0..1 CodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.
..... actor Σ 0..1 Reference(Practitioner) Person, Location/HealthcareService or Device
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
.... participant:Location C 0..1 BackboneElement Participants involved in appointment
Constraints: app-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 0..1 CodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.
..... actor Σ 0..1 Reference(Location) Person, Location/HealthcareService or Device
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
.... participant:Resource C 0..1 BackboneElement Participants involved in appointment
Constraints: app-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 0..1 CodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.
..... actor Σ 0..1 Reference() Person, Location/HealthcareService or Device
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Appointment.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
Appointment.meta.security:SENSITIVECHARTextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
Appointment.statusrequiredAppointmentStatus
http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1
From the FHIR Standard
Appointment.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
From the FHIR Standard
Appointment.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
From the FHIR Standard
Appointment.participant.statusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|4.0.1
From the FHIR Standard
Appointment.participant:Patient.statusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|4.0.1
From the FHIR Standard
Appointment.participant:Practitioner.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Appointment.participant:Practitioner.type:T1_TypeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Appointment.participant:Practitioner.type:T2_TypeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Appointment.participant:Practitioner.statusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|4.0.1
From the FHIR Standard
Appointment.participant:Location.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Appointment.participant:Location.statusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|4.0.1
From the FHIR Standard
Appointment.participant:Resource.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Appointment.participant:Resource.statusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
app-1errorAppointment.participant, Appointment.participant:Patient, Appointment.participant:Practitioner, Appointment.participant:Location, Appointment.participant:ResourceEither the type or actor on the participant SHALL be specified
: type.exists() or actor.exists()
app-2errorAppointmentEither start and end are specified, or neither
: start.exists() = end.exists()
app-3errorAppointmentOnly proposed or cancelled appointments can be missing start/end dates
: (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4errorAppointmentCancelation 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-2errorAppointmentIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAppointmentIf 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-4errorAppointmentIf 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-5errorAppointmentIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAppointmentA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Appointment

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Appointment 0..* Appointment 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)
... id 1..1 id Logical id of this artifact
... meta 0..1 Meta Metadata about the resource
.... lastUpdated 1..1 instant When the resource version last changed
.... Slices for profile 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:athena-appointment-profile 1..1 canonical() Profiles this resource claims to conform to
Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-profile
.... Slices for security 0..1 Coding Security Labels applied to this resource
Slice: Unordered, Open by value:coding
..... security:SENSITIVECHART 0..1 Coding Security Labels applied to this resource
... Slices for extension Content/Rules for all slices
.... extension:RecallAppointmentId 0..1 (Complex) Extension
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-extension-RecallAppointmentId
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-extension-RecallAppointmentId"
..... value[x] 1..1 Reference() Value of extension
.... extension:RecallId 0..1 (Complex) Extension
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-extension-RecallId
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-extension-RecallId"
..... value[x] 1..1 Reference() Value of extension
.... extension:Booklist 0..1 (Complex) Extension
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-extension-Booklist
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-extension-Booklist"
..... value[x] 1..1 string Value of extension
... status 1..1 code proposed | pending | booked | arrived | fulfilled | cancelled | noshow | checked-in
... serviceType 0..* CodeableConcept The specific service that is to be performed during this appointment
... reasonCode 0..* CodeableConcept Coded reason this appointment is scheduled
... priority 0..1 unsignedInt Used to make informed decisions if needing to re-prioritize
... description 0..1 string Shown on a subject line in a meeting request, or appointment list
... start 0..1 instant When appointment is to take place
... end 0..1 instant When appointment is to conclude
... minutesDuration 0..1 positiveInt Can be less than start/end (e.g. estimate)
... slot 0..* Reference(Slot) The slots that this appointment is filling
... comment 0..1 string Additional comments
... Slices for participant 0..1 BackboneElement Participants involved in appointment
Slice: Unordered, Open by value:type
.... participant:Patient 1..* BackboneElement Participants involved in appointment
..... actor 0..1 Reference(Patient) Person, Location/HealthcareService or Device
..... status 1..1 code accepted | declined | tentative | needs-action
.... participant:Practitioner 0..1 BackboneElement Participants involved in appointment
..... Slices for type 0..1 CodeableConcept Role of participant in the appointment
Slice: Unordered, Open by value:type
...... type:T1_Type 0..1 CodeableConcept Role of participant in the appointment
...... type:T2_Type 0..1 CodeableConcept Role of participant in the appointment
..... actor 0..1 Reference(Practitioner) Person, Location/HealthcareService or Device
..... status 1..1 code accepted | declined | tentative | needs-action
.... participant:Location 0..1 BackboneElement Participants involved in appointment
..... type 0..1 CodeableConcept Role of participant in the appointment
..... actor 0..1 Reference(Location) Person, Location/HealthcareService or Device
..... status 1..1 code accepted | declined | tentative | needs-action
.... participant:Resource 0..1 BackboneElement Participants involved in appointment
..... type 0..1 CodeableConcept Role of participant in the appointment
..... actor 0..1 Reference() Person, Location/HealthcareService or Device
..... status 1..1 code accepted | declined | tentative | needs-action

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Appointment C 0..* Appointment 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)
Constraints: app-2, app-3, app-4
... id Σ 1..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 1..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... Slices for profile Σ 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:athena-appointment-profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-profile
.... Slices for security Σ 0..1 Coding Security Labels applied to this resource
Slice: Unordered, Open by value:coding
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
..... security:SENSITIVECHART Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:RecallAppointmentId 0..1 (Complex) Extension
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-extension-RecallAppointmentId
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-extension-RecallAppointmentId"
..... value[x] 1..1 Reference() Value of extension
.... extension:RecallId 0..1 (Complex) Extension
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-extension-RecallId
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-extension-RecallId"
..... value[x] 1..1 Reference() Value of extension
.... extension:Booklist 0..1 (Complex) Extension
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-extension-Booklist
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-extension-Booklist"
..... value[x] 1..1 string Value of extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Ids for this item
... status ?!Σ 1..1 code proposed | pending | booked | arrived | fulfilled | cancelled | noshow | checked-in
Binding: AppointmentStatus (required): The free/busy status of an appointment.
... cancelationReason Σ 0..1 CodeableConcept The coded reason for the appointment being cancelled
Binding: AppointmentCancellationReason (example)
... serviceCategory Σ 0..* CodeableConcept A broad categorization of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
... serviceType Σ 0..* CodeableConcept The specific service that is to be performed during this appointment
Binding: ServiceType (example)
... specialty Σ 0..* CodeableConcept The specialty of a practitioner that would be required to perform the service requested in this appointment
Binding: PracticeSettingCodeValueSet (preferred)
... appointmentType Σ 0..1 CodeableConcept The style of appointment or patient that has been booked in the slot (not service type)
Binding: hl7VS-appointmentReasonCodes (preferred)
... reasonCode Σ 0..* CodeableConcept Coded reason this appointment is scheduled
Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place.
... reasonReference 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the appointment is to take place (resource)
... priority 0..1 unsignedInt Used to make informed decisions if needing to re-prioritize
... description 0..1 string Shown on a subject line in a meeting request, or appointment list
... supportingInformation 0..* Reference(Resource) Additional information to support the appointment
... start Σ 0..1 instant When appointment is to take place
... end Σ 0..1 instant When appointment is to conclude
... minutesDuration 0..1 positiveInt Can be less than start/end (e.g. estimate)
... slot 0..* Reference(Slot) The slots that this appointment is filling
... created 0..1 dateTime The date that this appointment was initially created
... comment 0..1 string Additional comments
... patientInstruction 0..1 string Detailed information and instructions for the patient
... basedOn 0..* Reference(ServiceRequest) The service request this appointment is allocated to assess
... Slices for participant C 0..1 BackboneElement Participants involved in appointment
Slice: Unordered, Open by value:type
Constraints: app-1
.... participant:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 0..* CodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.
..... actor Σ 0..1 Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) Person, Location/HealthcareService or Device
..... required Σ 0..1 code required | optional | information-only
Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
..... period 0..1 Period Participation period of the actor
.... participant:Patient C 1..1 BackboneElement Participants involved in appointment
Constraints: app-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 0..* CodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.
..... actor Σ 0..1 Reference(Patient) Person, Location/HealthcareService or Device
..... required Σ 0..1 code required | optional | information-only
Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
..... period 0..1 Period Participation period of the actor
.... participant:Practitioner C 0..1 BackboneElement Participants involved in appointment
Constraints: app-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... Slices for type Σ 0..1 CodeableConcept Role of participant in the appointment
Slice: Unordered, Open by value:type
Binding: ParticipantType (extensible): Role of participant in encounter.
...... type:T1_Type Σ 0..1 CodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.
...... type:T2_Type Σ 0..1 CodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.
..... actor Σ 0..1 Reference(Practitioner) Person, Location/HealthcareService or Device
..... required Σ 0..1 code required | optional | information-only
Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
..... period 0..1 Period Participation period of the actor
.... participant:Location C 0..1 BackboneElement Participants involved in appointment
Constraints: app-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 0..1 CodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.
..... actor Σ 0..1 Reference(Location) Person, Location/HealthcareService or Device
..... required Σ 0..1 code required | optional | information-only
Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
..... period 0..1 Period Participation period of the actor
.... participant:Resource C 0..1 BackboneElement Participants involved in appointment
Constraints: app-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 0..1 CodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.
..... actor Σ 0..1 Reference() Person, Location/HealthcareService or Device
..... required Σ 0..1 code required | optional | information-only
Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
..... period 0..1 Period Participation period of the actor
... requestedPeriod 0..* Period Potential date/time interval(s) requested to allocate the appointment within

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Appointment.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
Appointment.meta.security:SENSITIVECHARTextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
Appointment.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
From the FHIR Standard
Appointment.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Appointment.statusrequiredAppointmentStatus
http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1
From the FHIR Standard
Appointment.cancelationReasonexampleAppointmentCancellationReason
http://hl7.org/fhir/ValueSet/appointment-cancellation-reason
From the FHIR Standard
Appointment.serviceCategoryexampleServiceCategory
http://hl7.org/fhir/ValueSet/service-category
From the FHIR Standard
Appointment.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
From the FHIR Standard
Appointment.specialtypreferredPracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
From the FHIR Standard
Appointment.appointmentTypepreferredHl7VSAppointmentReasonCodes
http://terminology.hl7.org/ValueSet/v2-0276
Appointment.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
From the FHIR Standard
Appointment.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Appointment.participant.requiredrequiredParticipantRequired
http://hl7.org/fhir/ValueSet/participantrequired|4.0.1
From the FHIR Standard
Appointment.participant.statusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|4.0.1
From the FHIR Standard
Appointment.participant:Patient.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Appointment.participant:Patient.requiredrequiredParticipantRequired
http://hl7.org/fhir/ValueSet/participantrequired|4.0.1
From the FHIR Standard
Appointment.participant:Patient.statusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|4.0.1
From the FHIR Standard
Appointment.participant:Practitioner.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Appointment.participant:Practitioner.type:T1_TypeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Appointment.participant:Practitioner.type:T2_TypeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Appointment.participant:Practitioner.requiredrequiredParticipantRequired
http://hl7.org/fhir/ValueSet/participantrequired|4.0.1
From the FHIR Standard
Appointment.participant:Practitioner.statusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|4.0.1
From the FHIR Standard
Appointment.participant:Location.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Appointment.participant:Location.requiredrequiredParticipantRequired
http://hl7.org/fhir/ValueSet/participantrequired|4.0.1
From the FHIR Standard
Appointment.participant:Location.statusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|4.0.1
From the FHIR Standard
Appointment.participant:Resource.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Appointment.participant:Resource.requiredrequiredParticipantRequired
http://hl7.org/fhir/ValueSet/participantrequired|4.0.1
From the FHIR Standard
Appointment.participant:Resource.statusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
app-1errorAppointment.participant, Appointment.participant:Patient, Appointment.participant:Practitioner, Appointment.participant:Location, Appointment.participant:ResourceEither the type or actor on the participant SHALL be specified
: type.exists() or actor.exists()
app-2errorAppointmentEither start and end are specified, or neither
: start.exists() = end.exists()
app-3errorAppointmentOnly proposed or cancelled appointments can be missing start/end dates
: (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4errorAppointmentCancelation 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-2errorAppointmentIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAppointmentIf 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-4errorAppointmentIf 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-5errorAppointmentIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAppointmentA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Appointment

Summary

Mandatory: 4 elements(12 nested mandatory elements)
Fixed: 4 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Appointment.meta.profile
  • The element 1 is sliced based on the value of Appointment.meta.security
  • The element 1 is sliced based on the value of Appointment.participant
  • The element 1 is sliced based on the value of Appointment.participant.type

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Appointment C 0..* Appointment 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)
Constraints: app-2, app-3, app-4
... id Σ 1..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... lastUpdated Σ 1..1 instant When the resource version last changed
.... Slices for profile Σ 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:athena-appointment-profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-profile
.... Slices for security Σ 0..1 Coding Security Labels applied to this resource
Slice: Unordered, Open by value:coding
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
..... security:SENSITIVECHART Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
.... extension:RecallAppointmentId 0..1 (Complex) Extension
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-extension-RecallAppointmentId
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-extension-RecallAppointmentId"
..... value[x] 1..1 Reference() Value of extension
.... extension:RecallId 0..1 (Complex) Extension
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-extension-RecallId
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-extension-RecallId"
..... value[x] 1..1 Reference() Value of extension
.... extension:Booklist 0..1 (Complex) Extension
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-extension-Booklist
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-extension-Booklist"
..... value[x] 1..1 string Value of extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Ids for this item
... status ?!Σ 1..1 code proposed | pending | booked | arrived | fulfilled | cancelled | noshow | checked-in
Binding: AppointmentStatus (required): The free/busy status of an appointment.
... serviceType Σ 0..* CodeableConcept The specific service that is to be performed during this appointment
Binding: ServiceType (example)
... reasonCode Σ 0..* CodeableConcept Coded reason this appointment is scheduled
Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place.
... priority 0..1 unsignedInt Used to make informed decisions if needing to re-prioritize
... description 0..1 string Shown on a subject line in a meeting request, or appointment list
... start Σ 0..1 instant When appointment is to take place
... end Σ 0..1 instant When appointment is to conclude
... minutesDuration 0..1 positiveInt Can be less than start/end (e.g. estimate)
... slot 0..* Reference(Slot) The slots that this appointment is filling
... comment 0..1 string Additional comments
... Slices for participant C 0..1 BackboneElement Participants involved in appointment
Slice: Unordered, Open by value:type
Constraints: app-1
.... participant:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
.... participant:Patient C 1..1 BackboneElement Participants involved in appointment
Constraints: app-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor Σ 0..1 Reference(Patient) Person, Location/HealthcareService or Device
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
.... participant:Practitioner C 0..1 BackboneElement Participants involved in appointment
Constraints: app-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... Slices for type Σ 0..1 CodeableConcept Role of participant in the appointment
Slice: Unordered, Open by value:type
Binding: ParticipantType (extensible): Role of participant in encounter.
...... type:T1_Type Σ 0..1 CodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.
...... type:T2_Type Σ 0..1 CodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.
..... actor Σ 0..1 Reference(Practitioner) Person, Location/HealthcareService or Device
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
.... participant:Location C 0..1 BackboneElement Participants involved in appointment
Constraints: app-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 0..1 CodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.
..... actor Σ 0..1 Reference(Location) Person, Location/HealthcareService or Device
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
.... participant:Resource C 0..1 BackboneElement Participants involved in appointment
Constraints: app-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 0..1 CodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.
..... actor Σ 0..1 Reference() Person, Location/HealthcareService or Device
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Appointment.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
Appointment.meta.security:SENSITIVECHARTextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
Appointment.statusrequiredAppointmentStatus
http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1
From the FHIR Standard
Appointment.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
From the FHIR Standard
Appointment.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
From the FHIR Standard
Appointment.participant.statusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|4.0.1
From the FHIR Standard
Appointment.participant:Patient.statusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|4.0.1
From the FHIR Standard
Appointment.participant:Practitioner.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Appointment.participant:Practitioner.type:T1_TypeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Appointment.participant:Practitioner.type:T2_TypeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Appointment.participant:Practitioner.statusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|4.0.1
From the FHIR Standard
Appointment.participant:Location.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Appointment.participant:Location.statusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|4.0.1
From the FHIR Standard
Appointment.participant:Resource.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Appointment.participant:Resource.statusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
app-1errorAppointment.participant, Appointment.participant:Patient, Appointment.participant:Practitioner, Appointment.participant:Location, Appointment.participant:ResourceEither the type or actor on the participant SHALL be specified
: type.exists() or actor.exists()
app-2errorAppointmentEither start and end are specified, or neither
: start.exists() = end.exists()
app-3errorAppointmentOnly proposed or cancelled appointments can be missing start/end dates
: (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4errorAppointmentCancelation 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-2errorAppointmentIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAppointmentIf 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-4errorAppointmentIf 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-5errorAppointmentIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAppointmentA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from Appointment

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Appointment 0..* Appointment 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)
... id 1..1 id Logical id of this artifact
... meta 0..1 Meta Metadata about the resource
.... lastUpdated 1..1 instant When the resource version last changed
.... Slices for profile 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:athena-appointment-profile 1..1 canonical() Profiles this resource claims to conform to
Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-profile
.... Slices for security 0..1 Coding Security Labels applied to this resource
Slice: Unordered, Open by value:coding
..... security:SENSITIVECHART 0..1 Coding Security Labels applied to this resource
... Slices for extension Content/Rules for all slices
.... extension:RecallAppointmentId 0..1 (Complex) Extension
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-extension-RecallAppointmentId
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-extension-RecallAppointmentId"
..... value[x] 1..1 Reference() Value of extension
.... extension:RecallId 0..1 (Complex) Extension
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-extension-RecallId
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-extension-RecallId"
..... value[x] 1..1 Reference() Value of extension
.... extension:Booklist 0..1 (Complex) Extension
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-extension-Booklist
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-extension-Booklist"
..... value[x] 1..1 string Value of extension
... status 1..1 code proposed | pending | booked | arrived | fulfilled | cancelled | noshow | checked-in
... serviceType 0..* CodeableConcept The specific service that is to be performed during this appointment
... reasonCode 0..* CodeableConcept Coded reason this appointment is scheduled
... priority 0..1 unsignedInt Used to make informed decisions if needing to re-prioritize
... description 0..1 string Shown on a subject line in a meeting request, or appointment list
... start 0..1 instant When appointment is to take place
... end 0..1 instant When appointment is to conclude
... minutesDuration 0..1 positiveInt Can be less than start/end (e.g. estimate)
... slot 0..* Reference(Slot) The slots that this appointment is filling
... comment 0..1 string Additional comments
... Slices for participant 0..1 BackboneElement Participants involved in appointment
Slice: Unordered, Open by value:type
.... participant:Patient 1..* BackboneElement Participants involved in appointment
..... actor 0..1 Reference(Patient) Person, Location/HealthcareService or Device
..... status 1..1 code accepted | declined | tentative | needs-action
.... participant:Practitioner 0..1 BackboneElement Participants involved in appointment
..... Slices for type 0..1 CodeableConcept Role of participant in the appointment
Slice: Unordered, Open by value:type
...... type:T1_Type 0..1 CodeableConcept Role of participant in the appointment
...... type:T2_Type 0..1 CodeableConcept Role of participant in the appointment
..... actor 0..1 Reference(Practitioner) Person, Location/HealthcareService or Device
..... status 1..1 code accepted | declined | tentative | needs-action
.... participant:Location 0..1 BackboneElement Participants involved in appointment
..... type 0..1 CodeableConcept Role of participant in the appointment
..... actor 0..1 Reference(Location) Person, Location/HealthcareService or Device
..... status 1..1 code accepted | declined | tentative | needs-action
.... participant:Resource 0..1 BackboneElement Participants involved in appointment
..... type 0..1 CodeableConcept Role of participant in the appointment
..... actor 0..1 Reference() Person, Location/HealthcareService or Device
..... status 1..1 code accepted | declined | tentative | needs-action

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Appointment C 0..* Appointment 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)
Constraints: app-2, app-3, app-4
... id Σ 1..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 1..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... Slices for profile Σ 1..* canonical() Profiles this resource claims to conform to
Slice: Unordered, Open by value:uri
..... profile:athena-appointment-profile Σ 1..1 canonical() Profiles this resource claims to conform to

Fixed Value: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-profile
.... Slices for security Σ 0..1 Coding Security Labels applied to this resource
Slice: Unordered, Open by value:coding
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
..... security:SENSITIVECHART Σ 0..1 Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:RecallAppointmentId 0..1 (Complex) Extension
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-extension-RecallAppointmentId
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-extension-RecallAppointmentId"
..... value[x] 1..1 Reference() Value of extension
.... extension:RecallId 0..1 (Complex) Extension
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-extension-RecallId
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-extension-RecallId"
..... value[x] 1..1 Reference() Value of extension
.... extension:Booklist 0..1 (Complex) Extension
URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-extension-Booklist
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-extension-Booklist"
..... value[x] 1..1 string Value of extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Ids for this item
... status ?!Σ 1..1 code proposed | pending | booked | arrived | fulfilled | cancelled | noshow | checked-in
Binding: AppointmentStatus (required): The free/busy status of an appointment.
... cancelationReason Σ 0..1 CodeableConcept The coded reason for the appointment being cancelled
Binding: AppointmentCancellationReason (example)
... serviceCategory Σ 0..* CodeableConcept A broad categorization of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
... serviceType Σ 0..* CodeableConcept The specific service that is to be performed during this appointment
Binding: ServiceType (example)
... specialty Σ 0..* CodeableConcept The specialty of a practitioner that would be required to perform the service requested in this appointment
Binding: PracticeSettingCodeValueSet (preferred)
... appointmentType Σ 0..1 CodeableConcept The style of appointment or patient that has been booked in the slot (not service type)
Binding: hl7VS-appointmentReasonCodes (preferred)
... reasonCode Σ 0..* CodeableConcept Coded reason this appointment is scheduled
Binding: EncounterReasonCodes (preferred): The Reason for the appointment to take place.
... reasonReference 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the appointment is to take place (resource)
... priority 0..1 unsignedInt Used to make informed decisions if needing to re-prioritize
... description 0..1 string Shown on a subject line in a meeting request, or appointment list
... supportingInformation 0..* Reference(Resource) Additional information to support the appointment
... start Σ 0..1 instant When appointment is to take place
... end Σ 0..1 instant When appointment is to conclude
... minutesDuration 0..1 positiveInt Can be less than start/end (e.g. estimate)
... slot 0..* Reference(Slot) The slots that this appointment is filling
... created 0..1 dateTime The date that this appointment was initially created
... comment 0..1 string Additional comments
... patientInstruction 0..1 string Detailed information and instructions for the patient
... basedOn 0..* Reference(ServiceRequest) The service request this appointment is allocated to assess
... Slices for participant C 0..1 BackboneElement Participants involved in appointment
Slice: Unordered, Open by value:type
Constraints: app-1
.... participant:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 0..* CodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.
..... actor Σ 0..1 Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) Person, Location/HealthcareService or Device
..... required Σ 0..1 code required | optional | information-only
Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
..... period 0..1 Period Participation period of the actor
.... participant:Patient C 1..1 BackboneElement Participants involved in appointment
Constraints: app-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 0..* CodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.
..... actor Σ 0..1 Reference(Patient) Person, Location/HealthcareService or Device
..... required Σ 0..1 code required | optional | information-only
Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
..... period 0..1 Period Participation period of the actor
.... participant:Practitioner C 0..1 BackboneElement Participants involved in appointment
Constraints: app-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... Slices for type Σ 0..1 CodeableConcept Role of participant in the appointment
Slice: Unordered, Open by value:type
Binding: ParticipantType (extensible): Role of participant in encounter.
...... type:T1_Type Σ 0..1 CodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.
...... type:T2_Type Σ 0..1 CodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.
..... actor Σ 0..1 Reference(Practitioner) Person, Location/HealthcareService or Device
..... required Σ 0..1 code required | optional | information-only
Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
..... period 0..1 Period Participation period of the actor
.... participant:Location C 0..1 BackboneElement Participants involved in appointment
Constraints: app-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 0..1 CodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.
..... actor Σ 0..1 Reference(Location) Person, Location/HealthcareService or Device
..... required Σ 0..1 code required | optional | information-only
Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
..... period 0..1 Period Participation period of the actor
.... participant:Resource C 0..1 BackboneElement Participants involved in appointment
Constraints: app-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type Σ 0..1 CodeableConcept Role of participant in the appointment
Binding: ParticipantType (extensible): Role of participant in encounter.
..... actor Σ 0..1 Reference() Person, Location/HealthcareService or Device
..... required Σ 0..1 code required | optional | information-only
Binding: ParticipantRequired (required): Is the Participant required to attend the appointment.
..... status Σ 1..1 code accepted | declined | tentative | needs-action
Binding: ParticipationStatus (required): The Participation status of an appointment.
..... period 0..1 Period Participation period of the actor
... requestedPeriod 0..* Period Potential date/time interval(s) requested to allocate the appointment within

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Appointment.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
Appointment.meta.security:SENSITIVECHARTextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
Appointment.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
From the FHIR Standard
Appointment.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Appointment.statusrequiredAppointmentStatus
http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1
From the FHIR Standard
Appointment.cancelationReasonexampleAppointmentCancellationReason
http://hl7.org/fhir/ValueSet/appointment-cancellation-reason
From the FHIR Standard
Appointment.serviceCategoryexampleServiceCategory
http://hl7.org/fhir/ValueSet/service-category
From the FHIR Standard
Appointment.serviceTypeexampleServiceType
http://hl7.org/fhir/ValueSet/service-type
From the FHIR Standard
Appointment.specialtypreferredPracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
From the FHIR Standard
Appointment.appointmentTypepreferredHl7VSAppointmentReasonCodes
http://terminology.hl7.org/ValueSet/v2-0276
Appointment.reasonCodepreferredEncounterReasonCodes
http://hl7.org/fhir/ValueSet/encounter-reason
From the FHIR Standard
Appointment.participant.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Appointment.participant.requiredrequiredParticipantRequired
http://hl7.org/fhir/ValueSet/participantrequired|4.0.1
From the FHIR Standard
Appointment.participant.statusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|4.0.1
From the FHIR Standard
Appointment.participant:Patient.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Appointment.participant:Patient.requiredrequiredParticipantRequired
http://hl7.org/fhir/ValueSet/participantrequired|4.0.1
From the FHIR Standard
Appointment.participant:Patient.statusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|4.0.1
From the FHIR Standard
Appointment.participant:Practitioner.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Appointment.participant:Practitioner.type:T1_TypeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Appointment.participant:Practitioner.type:T2_TypeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Appointment.participant:Practitioner.requiredrequiredParticipantRequired
http://hl7.org/fhir/ValueSet/participantrequired|4.0.1
From the FHIR Standard
Appointment.participant:Practitioner.statusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|4.0.1
From the FHIR Standard
Appointment.participant:Location.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Appointment.participant:Location.requiredrequiredParticipantRequired
http://hl7.org/fhir/ValueSet/participantrequired|4.0.1
From the FHIR Standard
Appointment.participant:Location.statusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|4.0.1
From the FHIR Standard
Appointment.participant:Resource.typeextensibleParticipantType
http://hl7.org/fhir/ValueSet/encounter-participant-type
From the FHIR Standard
Appointment.participant:Resource.requiredrequiredParticipantRequired
http://hl7.org/fhir/ValueSet/participantrequired|4.0.1
From the FHIR Standard
Appointment.participant:Resource.statusrequiredParticipationStatus
http://hl7.org/fhir/ValueSet/participationstatus|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
app-1errorAppointment.participant, Appointment.participant:Patient, Appointment.participant:Practitioner, Appointment.participant:Location, Appointment.participant:ResourceEither the type or actor on the participant SHALL be specified
: type.exists() or actor.exists()
app-2errorAppointmentEither start and end are specified, or neither
: start.exists() = end.exists()
app-3errorAppointmentOnly proposed or cancelled appointments can be missing start/end dates
: (start.exists() and end.exists()) or (status in ('proposed' | 'cancelled' | 'waitlist'))
app-4errorAppointmentCancelation 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-2errorAppointmentIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAppointmentIf 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-4errorAppointmentIf 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-5errorAppointmentIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAppointmentA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Appointment

Summary

Mandatory: 4 elements(12 nested mandatory elements)
Fixed: 4 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Appointment.meta.profile
  • The element 1 is sliced based on the value of Appointment.meta.security
  • The element 1 is sliced based on the value of Appointment.participant
  • The element 1 is sliced based on the value of Appointment.participant.type

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Supported Interactions

The Interactions supported by this resource are listed below.

Search Parameters

Search parameters are executed as specified in the HL7 FHIR RESTful API implementation definition. To search for Appointment resources, an application shall perform an HTTP GET, specifying the query parameters associated with the resource.

GET [base]/fhir/Appointment?{search-parameters}{&_count=[max-results]&_format=[json|xml]&_summary=[true|text|data]}

Where:

Name Description
[base] Specifies the base URL of the FHIR Server, e.g., https://apsandbox.fhirapi.athenahealth.com/demoAPIServer
[_count] Specifies the maximum number of search results to return in a single query. Note: The count of results does not limit the number of additional resources returned via the _include parameter. No more than max-results Appointment resources which match the search criteria will be returned. The API Server has default and maximum limits for the value that can be specified for this parameter. These limits may vary depending upon the client application vendors participation level in the Athenahealth Partner program. Note: The API Server support the HL7 FHIR Paging capability.
[_format] Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request.
[_summary] Filters the output to include only narrative elements (_summary=text), summary elements (_summary=true) or to omit the generated narrative (_summary=data). Note: If the generated html narrative for the resource is not going to be used by the call, using _summary=data provides improved API response times, especially when returning larger result sets.
_id (token) The ID of the resource
_lastUpdated (date)
_lastUpdated-fromnow (quantity) Like _lastUpdated except expressed as a positive or negative offset from the current time in units of time, e.g. _lastUpdated-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified.
_security (token)
actor (reference) Any one of the individuals participating in the appointment
date (date) Appointment date/time.
date-fromnow (quantity) Like date except expressed as a positive or negative offset from the current time in units of time, e.g. date-fromnow=ge7||d for more than seven days in the future or =le-2||mo for less than two months in the past. The unit must be specified.
identifier (token) An Identifier of the Appointment
location (reference) This location is listed in the participants of the appointment
patient (reference) One of the individuals of the appointment is this patient
practitioner (reference) One of the individuals of the appointment is this practitioner
status (token) The overall status of the appointment
pract-status (token) The Participant Status of participants
reason-code (token) The reason appointment is scheduled
service-type (token) The specific service that is to be performed during this appointment
slot (reference) The slots that this appointment is filling
includeSchedule(boolean) Including Schedule reference in the response Bundle when Slot resource is included and mark includeSchedule=true"

Note: Appointment resource support custom search parameter to include Schedule for Appointment filling Slots. Example of Appointment with includeSchedule=true

Appointment Example
HTTP Response Codes

The following HTTP response codes are returned by this API call:

200 OK The query was performed and any results found are contained within the body of the HTTP response. Note: The search API will return 200 OK when the query itself is successful, regardless of whether or not any matching results were found.
401 Unauthorized Authorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required.
500 Server Error The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.