Argo-Scheduling Implementation Guide Release 1.0.0

This page is part of the Argonaut Scheduling Implementation Guide (v1.0.0: Release) based on FHIR R3. This is the current published version. For a full list of available versions, see the Directory of published versions

SD.11 StructureDefinition-argo-appt

This profile sets minimum expectations for the Appointment resource to record, search and fetch basic information about an individual appointment. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.

This profile is defined for:

  • Use in the Bundle resource as a result of the $find, $hold, and $ book operations.
  • Patient searching for their appointments.
  • Provider searching for their appointments.
Mandatory Data Elements and Terminology

The following data-elements are mandatory (i.e data MUST be present).

Each Appointment must have:

  1. a status (e.g., ‘proposed’)
  2. a start and end time
  3. a list of participants and their individual statuses (e.g., the patient will be there)
  4. the times that were requested for this appointment

The system Must Support if available:

  1. An Appointment resource ID
  2. A visit type
  3. Specialty
  4. Appointment type
  5. Status reason

Additional Profile specific implementation guidance:

  • The Appointment State Diagram SHOULD be referenced to when considering the statuses of the scheduling resources during the scheduling workflow.
  • The Specialty codes are bound to the Argonaut Scheduling Specialties valueset which is based upon SNOMED CT. There are other provider specialty code systems that implementers should be aware of including NUCC codes, and CMS Provider types. More information on them can be found here.

Examples

SD.11.1 Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://fhir.org/guides/argonaut-scheduling/StructureDefinition/argo-appt

Published on Tue Jun 13 00:00:00 AEST 2017 as a active by Argonaut Project.

This profile builds on Appointment

Summary

Mandatory: 5 elements
Must-Support: 12 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

NameFlagsCard.TypeDescription & Constraintsdoco
.. Appointment I0..*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 SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension-status-reason SI0..1CodeableConceptExtension
URL: http://fhir.org/guides/argonaut-scheduling/StructureDefinition/extension-status-reason
Binding: Argonaut_Appointment_Event_Reason_Codes (preferred)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Ids for this item
... status ?!SΣ1..1codeproposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error
Binding: AppointmentStatus (required)
... serviceCategory Σ0..1CodeableConceptA broad categorisation of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
... serviceType SΣ0..*CodeableConceptThe specific service that is to be performed during this appointment
Binding: Argonaut_Visit_Types (extensible)
... specialty SΣ0..*CodeableConceptThe specialty of a practitioner that would be required to perform the service requested in this appointment
Binding: Argonaut_Scheduling_Specialties (extensible)
... appointmentType SΣ0..1CodeableConceptThe style of appointment or patient that has been booked in the slot (not service type)
Binding: Argonaut_Appointment_Types (extensible)
... reason Σ0..*CodeableConceptReason this appointment is scheduled
Binding: Encounter Reason Codes (preferred)
... indication 0..*Reference(Condition | Procedure)Reason the appointment is to takes place (resource)
... priority 0..1unsignedIntUsed to make informed decisions if needing to re-prioritize
... description 0..1stringShown on a subject line in a meeting request, or appointment list
... supportingInformation 0..*Reference(Resource)Additional information to support the appointment
... start SΣ1..1instantWhen appointment is to take place
... end SΣ1..1instantWhen appointment is to conclude
... minutesDuration 0..1positiveIntCan be less than start/end (e.g. estimate)
... slot 0..*Reference(Slot)The slots that this appointment is filling
... created 0..1dateTimeThe date that this appointment was initially created
... comment 0..1stringAdditional comments
... incomingReferral 0..*Reference(ReferralRequest)The ReferralRequest provided as information to allocate to the Encounter
... participant SI1..*BackboneElementParticipants involved in appointment
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... type Σ0..*CodeableConceptRole of participant in the appointment
Binding: ParticipantType (extensible)
.... actor SΣ1..1Reference(US Core Location Profile | US Core Patient Profile | US Core Practitioner Profile | HealthcareService)Person, Location/HealthcareService or Device
.... required Σ0..1coderequired | optional | information-only
Binding: ParticipantRequired (required)
.... status S1..1codeaccepted | declined | tentative | needs-action
Binding: ParticipationStatus (required)
... requestedPeriod S1..1PeriodPotential date/time interval(s) requested to allocate the appointment within

doco Documentation for this format

Summary

Mandatory: 5 elements
Must-Support: 12 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Appointment I0..*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 SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension-status-reason SI0..1CodeableConceptExtension
URL: http://fhir.org/guides/argonaut-scheduling/StructureDefinition/extension-status-reason
Binding: Argonaut_Appointment_Event_Reason_Codes (preferred)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Ids for this item
... status ?!SΣ1..1codeproposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error
Binding: AppointmentStatus (required)
... serviceCategory Σ0..1CodeableConceptA broad categorisation of the service that is to be performed during this appointment
Binding: ServiceCategory (example)
... serviceType SΣ0..*CodeableConceptThe specific service that is to be performed during this appointment
Binding: Argonaut_Visit_Types (extensible)
... specialty SΣ0..*CodeableConceptThe specialty of a practitioner that would be required to perform the service requested in this appointment
Binding: Argonaut_Scheduling_Specialties (extensible)
... appointmentType SΣ0..1CodeableConceptThe style of appointment or patient that has been booked in the slot (not service type)
Binding: Argonaut_Appointment_Types (extensible)
... reason Σ0..*CodeableConceptReason this appointment is scheduled
Binding: Encounter Reason Codes (preferred)
... indication 0..*Reference(Condition | Procedure)Reason the appointment is to takes place (resource)
... priority 0..1unsignedIntUsed to make informed decisions if needing to re-prioritize
... description 0..1stringShown on a subject line in a meeting request, or appointment list
... supportingInformation 0..*Reference(Resource)Additional information to support the appointment
... start SΣ1..1instantWhen appointment is to take place
... end SΣ1..1instantWhen appointment is to conclude
... minutesDuration 0..1positiveIntCan be less than start/end (e.g. estimate)
... slot 0..*Reference(Slot)The slots that this appointment is filling
... created 0..1dateTimeThe date that this appointment was initially created
... comment 0..1stringAdditional comments
... incomingReferral 0..*Reference(ReferralRequest)The ReferralRequest provided as information to allocate to the Encounter
... participant SI1..*BackboneElementParticipants involved in appointment
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... type Σ0..*CodeableConceptRole of participant in the appointment
Binding: ParticipantType (extensible)
.... actor SΣ1..1Reference(US Core Location Profile | US Core Patient Profile | US Core Practitioner Profile | HealthcareService)Person, Location/HealthcareService or Device
.... required Σ0..1coderequired | optional | information-only
Binding: ParticipantRequired (required)
.... status S1..1codeaccepted | declined | tentative | needs-action
Binding: ParticipationStatus (required)
... requestedPeriod S1..1PeriodPotential date/time interval(s) requested to allocate the appointment within

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

SD.11.2 Quick Start

Below is an overview of the required set of RESTful FHIR interactions - for example, search and read operations - for this profile. See the Conformance requirements for a complete list of supported RESTful interactions for this IG.

Patient based Scheduling:

Provider based Scheduling: