Athena Core Implementation Guide - Local Development build (v4.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• JSON

Resource Profile: athenahealth Appointment

Profile documenting the athenahealth implementation of the Appointment resource

Usage:

• This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Appointment

Name	Flags	Card.	Type	Description & Constraints
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)
meta
lastUpdated		0..1	instant	When the resource version last changed
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:ahPractice		1..1	Reference(Organization)	athenahealth Practice URL: https://fhir.athena.io/StructureDefinition/ah-practice
extension:note		0..*	Annotation	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.note
extension:ahGroupAppointment		0..1	Reference(Appointment)	athenahealth Group Appointment URL: https://fhir.athena.io/StructureDefinition/ah-group-appointment
cancelationReason		0..1	CodeableConcept	The coded reason for the appointment being cancelled Binding: athenahealth Appointment Cancellation Reason (preferred)
serviceCategory		0..0
serviceType		0..*	CodeableConcept	The specific service that is to be performed during this appointment Binding: athenahealth Appointment Service Type (preferred)
specialty		0..0
appointmentType		0..0
reasonCode		0..0
reasonReference		0..0
priority		0..0
description		0..0
supportingInformation		0..0
slot		0..0
comment		0..0
patientInstruction		0..0
basedOn		0..0
participant
type		0..0
actor		0..1	Reference(Patient | Practitioner | Location)	Person, Location/HealthcareService or Device
required		0..0
period		0..0
requestedPeriod		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Appointment.cancelationReason	preferred	AthenahealthAppointmentCancellationReason (a valid code from athenahealth Appointment Cancellation Reason) https://fhir.athena.io/ValueSet/ah-appointment-cancellation-reason from this IG
Appointment.serviceType	preferred	AthenahealthAppointmentServiceType (a valid code from athenahealth Appointment Service Type) https://fhir.athena.io/ValueSet/ah-appointment-service-type from this IG

Name	Flags	Card.	Type	Description & Constraints
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) app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:ahPractice		1..1	Reference(Organization)	athenahealth Practice URL: https://fhir.athena.io/StructureDefinition/ah-practice ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:note		0..*	Annotation	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.note ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:ahGroupAppointment		0..1	Reference(Appointment)	athenahealth Group Appointment URL: https://fhir.athena.io/StructureDefinition/ah-group-appointment ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status	?!Σ	1..1	code	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment. ele-1: All FHIR elements must have a @value or children
cancelationReason	Σ	0..1	CodeableConcept	The coded reason for the appointment being cancelled Binding: athenahealth Appointment Cancellation Reason (preferred) ele-1: All FHIR elements must have a @value or children
serviceType	Σ	0..*	CodeableConcept	The specific service that is to be performed during this appointment Binding: athenahealth Appointment Service Type (preferred) ele-1: All FHIR elements must have a @value or children
participant	C	1..*	BackboneElement	Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
actor	Σ	0..1	Reference(Patient | Practitioner | Location)	Person, Location/HealthcareService or Device ele-1: All FHIR elements must have a @value or children
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Appointment.status	required	AppointmentStatus http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1 from the FHIR Standard
Appointment.cancelationReason	preferred	AthenahealthAppointmentCancellationReason (a valid code from athenahealth Appointment Cancellation Reason) https://fhir.athena.io/ValueSet/ah-appointment-cancellation-reason from this IG
Appointment.serviceType	preferred	AthenahealthAppointmentServiceType (a valid code from athenahealth Appointment Service Type) https://fhir.athena.io/ValueSet/ah-appointment-service-type from this IG
Appointment.participant.status	required	ParticipationStatus http://hl7.org/fhir/ValueSet/participationstatus|4.0.1 from the FHIR Standard

Name	Flags	Card.	Type	Description & Constraints
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) app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show
id	Σ	0..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	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	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 Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:ahPractice		1..1	Reference(Organization)	athenahealth Practice URL: https://fhir.athena.io/StructureDefinition/ah-practice
extension:note		0..*	Annotation	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.note
extension:ahGroupAppointment		0..1	Reference(Appointment)	athenahealth Group Appointment URL: https://fhir.athena.io/StructureDefinition/ah-group-appointment
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 | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment.
cancelationReason	Σ	0..1	CodeableConcept	The coded reason for the appointment being cancelled Binding: athenahealth Appointment Cancellation Reason (preferred)
serviceType	Σ	0..*	CodeableConcept	The specific service that is to be performed during this appointment Binding: athenahealth Appointment Service Type (preferred)
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)
created		0..1	dateTime	The date that this appointment was initially created
participant	C	1..*	BackboneElement	Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified
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
actor	Σ	0..1	Reference(Patient | Practitioner | Location)	Person, Location/HealthcareService or Device
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Appointment.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Appointment.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Appointment.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Appointment.status	required	AppointmentStatus http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1 from the FHIR Standard
Appointment.cancelationReason	preferred	AthenahealthAppointmentCancellationReason (a valid code from athenahealth Appointment Cancellation Reason) https://fhir.athena.io/ValueSet/ah-appointment-cancellation-reason from this IG
Appointment.serviceType	preferred	AthenahealthAppointmentServiceType (a valid code from athenahealth Appointment Service Type) https://fhir.athena.io/ValueSet/ah-appointment-service-type from this IG
Appointment.participant.status	required	ParticipationStatus http://hl7.org/fhir/ValueSet/participationstatus|4.0.1 from the FHIR Standard

This structure is derived from Appointment

Summary

Mandatory: 2 elements
Prohibited: 16 elements

Extensions

This structure refers to these extensions:

• https://fhir.athena.io/StructureDefinition/ah-practice
• http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.note
• https://fhir.athena.io/StructureDefinition/ah-group-appointment

Differential View

This structure is derived from Appointment

Name	Flags	Card.	Type	Description & Constraints
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)
meta
lastUpdated		0..1	instant	When the resource version last changed
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:ahPractice		1..1	Reference(Organization)	athenahealth Practice URL: https://fhir.athena.io/StructureDefinition/ah-practice
extension:note		0..*	Annotation	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.note
extension:ahGroupAppointment		0..1	Reference(Appointment)	athenahealth Group Appointment URL: https://fhir.athena.io/StructureDefinition/ah-group-appointment
cancelationReason		0..1	CodeableConcept	The coded reason for the appointment being cancelled Binding: athenahealth Appointment Cancellation Reason (preferred)
serviceCategory		0..0
serviceType		0..*	CodeableConcept	The specific service that is to be performed during this appointment Binding: athenahealth Appointment Service Type (preferred)
specialty		0..0
appointmentType		0..0
reasonCode		0..0
reasonReference		0..0
priority		0..0
description		0..0
supportingInformation		0..0
slot		0..0
comment		0..0
patientInstruction		0..0
basedOn		0..0
participant
type		0..0
actor		0..1	Reference(Patient | Practitioner | Location)	Person, Location/HealthcareService or Device
required		0..0
period		0..0
requestedPeriod		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Appointment.cancelationReason	preferred	AthenahealthAppointmentCancellationReason (a valid code from athenahealth Appointment Cancellation Reason) https://fhir.athena.io/ValueSet/ah-appointment-cancellation-reason from this IG
Appointment.serviceType	preferred	AthenahealthAppointmentServiceType (a valid code from athenahealth Appointment Service Type) https://fhir.athena.io/ValueSet/ah-appointment-service-type from this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
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) app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:ahPractice		1..1	Reference(Organization)	athenahealth Practice URL: https://fhir.athena.io/StructureDefinition/ah-practice ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:note		0..*	Annotation	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.note ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:ahGroupAppointment		0..1	Reference(Appointment)	athenahealth Group Appointment URL: https://fhir.athena.io/StructureDefinition/ah-group-appointment ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status	?!Σ	1..1	code	proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment. ele-1: All FHIR elements must have a @value or children
cancelationReason	Σ	0..1	CodeableConcept	The coded reason for the appointment being cancelled Binding: athenahealth Appointment Cancellation Reason (preferred) ele-1: All FHIR elements must have a @value or children
serviceType	Σ	0..*	CodeableConcept	The specific service that is to be performed during this appointment Binding: athenahealth Appointment Service Type (preferred) ele-1: All FHIR elements must have a @value or children
participant	C	1..*	BackboneElement	Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
actor	Σ	0..1	Reference(Patient | Practitioner | Location)	Person, Location/HealthcareService or Device ele-1: All FHIR elements must have a @value or children
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment. ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Appointment.status	required	AppointmentStatus http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1 from the FHIR Standard
Appointment.cancelationReason	preferred	AthenahealthAppointmentCancellationReason (a valid code from athenahealth Appointment Cancellation Reason) https://fhir.athena.io/ValueSet/ah-appointment-cancellation-reason from this IG
Appointment.serviceType	preferred	AthenahealthAppointmentServiceType (a valid code from athenahealth Appointment Service Type) https://fhir.athena.io/ValueSet/ah-appointment-service-type from this IG
Appointment.participant.status	required	ParticipationStatus http://hl7.org/fhir/ValueSet/participationstatus|4.0.1 from the FHIR Standard

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
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) app-2: Either start and end are specified, or neither app-3: Only proposed or cancelled appointments can be missing start/end dates app-4: Cancelation reason is only used for appointments that have been cancelled, or no-show
id	Σ	0..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	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	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 Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:ahPractice		1..1	Reference(Organization)	athenahealth Practice URL: https://fhir.athena.io/StructureDefinition/ah-practice
extension:note		0..*	Annotation	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.note
extension:ahGroupAppointment		0..1	Reference(Appointment)	athenahealth Group Appointment URL: https://fhir.athena.io/StructureDefinition/ah-group-appointment
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 | entered-in-error | checked-in | waitlist Binding: AppointmentStatus (required): The free/busy status of an appointment.
cancelationReason	Σ	0..1	CodeableConcept	The coded reason for the appointment being cancelled Binding: athenahealth Appointment Cancellation Reason (preferred)
serviceType	Σ	0..*	CodeableConcept	The specific service that is to be performed during this appointment Binding: athenahealth Appointment Service Type (preferred)
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)
created		0..1	dateTime	The date that this appointment was initially created
participant	C	1..*	BackboneElement	Participants involved in appointment app-1: Either the type or actor on the participant SHALL be specified
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
actor	Σ	0..1	Reference(Patient | Practitioner | Location)	Person, Location/HealthcareService or Device
status	Σ	1..1	code	accepted | declined | tentative | needs-action Binding: ParticipationStatus (required): The Participation status of an appointment.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Appointment.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Appointment.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Appointment.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Appointment.status	required	AppointmentStatus http://hl7.org/fhir/ValueSet/appointmentstatus|4.0.1 from the FHIR Standard
Appointment.cancelationReason	preferred	AthenahealthAppointmentCancellationReason (a valid code from athenahealth Appointment Cancellation Reason) https://fhir.athena.io/ValueSet/ah-appointment-cancellation-reason from this IG
Appointment.serviceType	preferred	AthenahealthAppointmentServiceType (a valid code from athenahealth Appointment Service Type) https://fhir.athena.io/ValueSet/ah-appointment-service-type from this IG
Appointment.participant.status	required	ParticipationStatus http://hl7.org/fhir/ValueSet/participationstatus|4.0.1 from the FHIR Standard

This structure is derived from Appointment

Summary

Mandatory: 2 elements
Prohibited: 16 elements

Extensions

This structure refers to these extensions:

• https://fhir.athena.io/StructureDefinition/ah-practice
• http://hl7.org/fhir/5.0/StructureDefinition/extension-Appointment.note
• https://fhir.athena.io/StructureDefinition/ah-group-appointment

​Other representations of profile: CSV, Excel, Schematron