Appointment Profile
This Appointment profile is part of the set of resource profiles supported by the API Server used with the athenaPractice 12.3 and athenaFlow 9.12 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 section in the profile detail page.
Supported Operations
The operations supported by this resource are listed below.
Read Operation
Read operations are executed as specified in the HL7 FHIR RESTful API implementation definition. To read a Appointment, an application shall perform an HTTP GET, specifying the identifier of the resources being retrieved.
GET [base]/fhir/Appointment/[id]{?_format=[json|xml]&_summary=[true|data]}
Read Operation Parameters
| Parameter | Description |
|---|---|
| [base] | Specifies the base URL of the FHIR Server, e.g., https://cpsapisandbox.virenceaz.com:9443/demoAPIServer |
| [id] | Specifies the identifier of the Appointment resource to retrieve |
| [_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 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 slightly improved API response times. |
Read Operation HTTP Response Codes
| Response Code | Description |
|---|---|
| 200 OK | The requested resource was found and is contained within the body of the HTTP response. |
| 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. |
| 404 Not Found | The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates that the resource could not be found. |
| 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. |
Search Operation
Search operations 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]}
Search Operation Parameters
| Parameter | Description |
|---|---|
| [base] | Specifies the base URL of the FHIR Server, e.g., https://cpsapisandbox.virenceaz.com:9443/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 |
Search Operation HTTP Response Codes
| Response Code | Description |
|---|---|
| 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. |
Create Operation
Create operations are executed as specified in the HL7 FHIR RESTful API implementation definition. To create a new Appointment resource, an application must perform an HTTP POST, specifying the content of the resource in the body of the request.
POST [base]/fhir/Appointment?{_format=[json|xml]}
Create Operation Parameters
| Parameter | Description |
|---|---|
| [_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. |
Create Operation HTTP Response Codes
| Response Code | Description |
|---|---|
| 201 Created | The resource was created at the location specified in the HTTP Location header. Note: Unsupported fields will be accepted in a request but will not be persisted to the database. Some fields may be mapped to database specific codes which closely but not perfectly match the input. See the HL7 FHIR specification for more detail on server permitted changes. |
| 400 Bad Request | The resource could not be parsed, or failed basic validation rules. The body of the HTTP response will contain an OperationOutcome resource that provide more detail about the reason for the failure. |
| 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. |
| 422 Unprocessable Entity | The proposed resource violated server business rules. For example, a required field may be missing or a field may contain a value that is not supported by the API Server. The body of the HTTP response will contain an OperationOutcome resource that provide more detail about the reason for the failure. |
| 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. |
Update Operation
Update operations are executed as specified in the HL7 FHIR RESTful API implementation definition. To create a new Appointment resource, an application must perform an HTTP PUT, specifying the content of the resource in the body of the request.
PUT [base]/fhir/Appointment/[id]?{_format=[json|xml]}
Update Operation Parameters
| Parameter | Description |
|---|---|
| [_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. |
Update Operation HTTP Response Codes
| Response Code | Description |
|---|---|
| 200 OK | The resource was updated at the location specified in the HTTP Location header. Note: Unsupported fields will be accepted in a request but will not be persisted to the database. Some fields may be mapped to database specific codes which closely but not perfectly match the input. See the HL7 FHIR specification for more detail on server permitted changes. |
| 400 Bad Request | The resource could not be parsed, or failed basic validation rules. The body of the HTTP response will contain an OperationOutcome resource that provide more detail about the reason for the failure. |
| 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. |
| 422 Unprocessable Entity | The proposed resource violated server business rules. For example, a required field may be missing or a field may contain a value that is not supported by the API Server. The body of the HTTP response will contain an OperationOutcome resource that provide more detail about the reason for the failure. |
| 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. |
Profile Content
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/appointment-profile
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)
| Name | Flags | Card. | Type | Description & Constraints | |
|---|---|---|---|---|---|
  Appointment | I | 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-3: Only proposed or cancelled appointments can be missing start/end dates app-2: Either start and end are specified, or neither | |
 meta | ∑ | 0..1 | Meta | Metadata about the resource | |
 implicitRules | ?! ∑ | 0..1 | uri | A set of rules under which this content was created | |
| language | 0..1 | code | Language of the resource content Binding: IETF BCP-47  (required ) | ||
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | ||
 appointment-booklist | 0..1 | string | Extension | ||
 url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/appointment-booklist" | ||
 valueString | 1..1 | string | Value of extension | ||
| extension | 0..1 | ?? [UriType[http://hl7.org/fhir/StructureDefinition/appointment-RecallAppointmentId]] | Extensionhttp://hl7.org/fhir/StructureDefinition/appointment-RecallAppointmentId | ||
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/appointment-RecallAppointmentId" | ||
 valueReference | 1..1 | Reference (Reference) | Value of extension | ||
| extension | 0..1 | ?? [UriType[http://hl7.org/fhir/StructureDefinition/appointment-RecallId]] | Extensionhttp://hl7.org/fhir/StructureDefinition/appointment-RecallId | ||
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/appointment-RecallId" | ||
| valueReference | 1..1 | Reference (Reference) | 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 Binding: AppointmentStatus (required ) | |
| type | ∑ | 0..1 | CodeableConcept | The type of appointment that is being booked Binding: Practice Setting Code Value Set (preferred ) | |
| reason | ∑ | 0..1 | CodeableConcept | Reason this appointment is scheduled Binding: Encounter Reason Codes (required ) | |
| 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 ) | If provided, then no schedule and start/end values MUST match slot | ||
| comment | 0..1 | string | Additional comments | ||
 participant | I | BackboneElement | Participants involved in appointment Slice: Ordered, Closed, by actor.@type app-1: Either the type or actor on the participant MUST be specified | ||
| participant | I | 1..* | BackboneElement | Participants involved in appointment app-1: Either the type or actor on the participant MUST be specified | |
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | |
| type | ∑ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (required ) | |
| actor | ∑ | 0..1 | Reference (Patient | Practitioner | RelatedPerson | Device | HealthcareService | Location ) | Person, Location/HealthcareService or Device | |
| required | ∑ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required ) | |
| status | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required ) | ||
| participant | I | 1..* | BackboneElement | Participants involved in appointment app-1: Either the type or actor on the participant MUST be specified | |
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | |
| type | ∑ | 0..* | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (required ) | |
| actor | ∑ | 0..1 | Reference (Patient ) | Patient | |
| required | ∑ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required ) | |
| status | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required ) | ||
| participant | I | 1..* | BackboneElement | Participants involved in appointment app-1: Either the type or actor on the participant MUST be specified | |
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | |
| type | ∑ | CodeableConcept | Role of participant in the appointment Slice: Unordered, Open, by TypeCode Binding: ParticipantType (required ) | ||
| type | ∑ | 0..1 | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (required ) | |
| type | ∑ | 0..1 | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (required ) | |
| actor | ∑ | 0..1 | Reference (Practitioner ) | Provider | |
| required | ∑ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required ) | |
| status | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required ) | ||
| participant | I | 1..* | BackboneElement | Participants involved in appointment app-1: Either the type or actor on the participant MUST be specified | |
| extension | 0..* | Extension | Additional Content defined by implementations | ||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | |
| type | ∑ | 0..1 | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (required ) | |
| actor | ∑ | 0..1 | Reference (Location ) | Location | |
| required | ∑ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required ) | |
| status | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required ) | ||
| participant | I | 1..* | BackboneElement | Resource involved in appointment app-1: Either the type or actor on the participant MUST be specified | |
 extension | 0..* | Extension | Additional Content defined by implementations | ||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | |
| type | ∑ | 0..1 | CodeableConcept | Role of participant in the appointment Binding: ParticipantType (required ) | |
| actor | ∑ | 0..1 | Reference (Reference) | Resource | |
| required | ∑ | 0..1 | code | required | optional | information-only Binding: ParticipantRequired (required ) | |
| status | 1..1 | code | accepted | declined | tentative | needs-action Binding: ParticipationStatus (required ) | ||
athenaPractice Mapping
The mappings in this section represent the how data stored within athenaPractice is served through the product's APIs.
athenaPractice and athenaFlow share a common schema for patient clinical data and only one is shown when these are
the same. Use of this information is subject to the API Server
Terms and Conditions .
| Appointment Profile | ||
| Appointment | Appointment-Profile | FHIR_APPOINTMENTSVIEW |
| ├ id | ID | MakeIdWithPrefix(%ID%,%ID_PREFIX%) |
| ├ extension | Booklist | |
| ├ extension | RecallAppointmentId | |
| │ └ valueReference | MakeReference("APPOINTMENT",%RECALLAPPOINTMENTID%,"Appointment") | |
| ├ extension | RecallId | |
| │ └ valueReference | MakeReference("APPOINTMENT",%RECALLID%,"Appointment") | |
| ├ identifier | EXTAPPTID | MakeIdentifier("U",getSiteSystem("Appointment"),%EXTERNALAPPTID%) |
| ├ status | APPTSTATUS | MapCode(%DESCRIPTION%,"APPOINTMENTSTATUS_CPS") |
| ├ type | APPTTYPE | MakeConceptIgnoringZeroValues(%TYPEID%,"http://hl7.org/fhir/StructureDefinition/ge-appointment-APPTDEF",%APPTTYPE%) |
| ├ reason | REASON | MakeTextConcept(%REASON%) |
| ├ priority | URGENCY | |
| ├ description | APPTTYPE | %APPTTYPE% |
| ├ start | APPTDATE + APPTTIME | %STARTTIME% |
| ├ end | APPTDATE + APPTTIME + DURATION | %ENDTIME% |
| ├ minutesDuration | DURATION | %DURATION% |
| ├ slot | MakeReference(null,%APPTSLOTID%,"Slot") | |
| ├ comment | COMMENTS | %REASON% |
| ├ participant | Appointment Participants | |
| ├ participant | Scheduled Patient | |
| │ └ actor | MakeReference(null,%PID%,"Patient") | |
| ├ participant | Scheduled Provider | |
| │ ├ type | T1_Type | MapConcept("PPRF","APPOINTMENTTYPE") |
| │ ├ type | T2_Type | MapConcept(%PRACTTYPECODE%,"C80APPOINTMENTTYPECPS") |
| │ └ actor | MakeReference(null,%DOCTORID%,"Practitioner") | |
| ├ participant | Location | |
| │ └ actor | MakeReference("LOCREG",%FACILITYID%,"Location") | |
| └ participant | Resource | |
| ├ type | MapConcept("RESOURCE","PARTICIPANTTYPECPS") | |
| └ actor | MakeResourceReference(null,%RESOURCEID%,null) | |
athenaFlow Mapping
The mappings in this section represent the how data stored within athenaFlow is served through the product's APIs.
Use of this information is subject to the API Server
Terms and Conditions .
| Appointment Profile | ||
| Appointment | Appointment-Profile | FHIR_APPOINTMENTSVIEW |
| ├ id | ID | %ID% |
| ├ extension | Booklist | |
| ├ extension | RecallAppointmentId | |
| ├ extension | RecallId | |
| ├ identifier | EXTAPPTID | MakeIdentifier("U",getSiteSystem("Appointment"),%EXTAPPTID%) |
| ├ status | APPTSTATUS | MapCode(%APPTSTATUS%,"APPOINTMENTSTATUS") |
| ├ type | APPTTYPE | MakeConcept(%TYPEID%,"http://hl7.org/fhir/StructureDefinition/ge-appointment-APPTDEF",%D_APPTTYPE%) |
| ├ reason | REASON | MakeTextConcept(%REASON%) |
| ├ priority | URGENCY | %URGENCY% |
| ├ description | APPTTYPE | %D_APPTTYPE% |
| ├ start | APPTDATE + APPTTIME | MakeTimestamp(%APPTDATE%,%APPTTIME%) |
| ├ end | APPTDATE + APPTTIME + DURATION | MakeTimestamp(%APPTDATE%,%APPTTIME%,%DURATION%) |
| ├ minutesDuration | DURATION | %DURATION% |
| ├ comment | COMMENTS | %COMMENTSANDINSTRUCTIONS% |
| ├ participant | Appointment Participants | |
| ├ participant | Scheduled Patient | |
| │ └ actor | MakeReference("PERSON",%PID%,"Patient") | |
| ├ participant | Scheduled Provider | |
| │ ├ type | T1_Type | MapConcept("PPRF","APPOINTMENTTYPE") |
| │ ├ type | T2_Type | MapConcept(%PRACTTYPECODE%,"C80APPOINTMENTTYPEEMR") |
| │ └ actor | MakeReference("USR",%DOCTORID%,"Practitioner") | |
| ├ participant | Location | |
| │ └ actor | MakeReference("LOCREG",%LOCATIONID%,"Location") | |
| └ participant | Resource | |