Appointment search-type

Request Fields and Example
identifier
[string]

One or more external identifiers for the appointment

date
[string]

The date/time when the appointment starts

practitioner
[string]

Any practitioner(s) that are participants in the appointment

practitioner.identifier
[string]

One or more external identifiers for the practitioner

patient
[string]

Any patient(s) that are participants in the appointment

patient.identifier
[string]

One or more external identifiers for the patient

location
[string]

Any location(s) that are participants in the appointment

location.identifier
[string]

One or more external identifiers for the location

location.name
[string]

The location's name.

location.physical-type
[string]

The location's physical form

location.name-physical-type
[string]

Specify both name and physical-type at once. This is a Redox-specific parameter.

status
[string]

The appointment's status

post/Appointment/_search
Response Fields and Example

Response to an Appointment search operation

resourceType
required, string

Identifies the type of the resource

Value: Bundle
type
required, string

Identifies this bundle as a response to a search

Value: searchset
total
required, number

The total number of matches

entry
[Appointment, Other]

A resource matching the search criteria or related to a matching resource

Any of:
resource
required, object

Information about an upcoming healthcare event

resourceType
required, string

Identifies the type of the resource

Value: Appointment
status
required, string

The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.

Possible Values: proposed, pending, booked, arrived, fulfilled, cancelled, noshow, entered-in-error, checked-in, waitlist
_status
required, object

This element contains extensions for status. Depending on the extensions present it could be used in place of status or contain additional information about status. See the extension element for more details on the possible extensions being sent.

extension
[OriginalText, Other]

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Any of:

A human language representation of the concept (resource/element) as seen/selected/uttered by the user who entered the data and/or which represents the full intended meaning of the user.

See http://hl7.org/fhir/StructureDefinition/originalText for more information

url
required, string

Source of the definition for the extension code - a logical name or a URL.

Value: http://hl7.org/fhir/StructureDefinition/originalText
valueString
required, string

The original text

participant
required, [Patient, Practitioner, Location, Other]

List of participants involved in the appointment.

Any of:
status
required, string

Participation status of the actor.

Value: accepted
type
[object]

Role of participant in the appointment.

extension
[OriginalText, Other]

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Any of:

A human language representation of the concept (resource/element) as seen/selected/uttered by the user who entered the data and/or which represents the full intended meaning of the user.

See http://hl7.org/fhir/StructureDefinition/originalText for more information

url
required, string

Source of the definition for the extension code - a logical name or a URL.

Value: http://hl7.org/fhir/StructureDefinition/originalText
valueString
required, string

The original text

actor
object

A Person, Location/HealthcareService or Device that is participating in the appointment.

Must be a resource of type Patient.

reference
string

A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

id
string

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

identifier
[object]

This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).

extension
[Boolean, String, CodeableConcept, Coding, HumanName, Reference]

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

One of:
url
required, string

Source of the definition for the extension code - a logical name or a URL.

valueBoolean
boolean

A single value for the extension.

use
string

The purpose of this identifier.

Possible Values: usual, official, temp, secondary, old (If known)
system
string

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

value
string

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

appointmentType
object

The style of appointment or patient that has been booked in the slot (not service type).

coding
[object]

A reference to a code defined by a terminology system.

system
string

The identification of the code system that defines the meaning of the symbol in the code.

code
string

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

text
string

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

reasonCode
[object]

The coded reason that this appointment is being scheduled. This is more clinical than administrative.

coding
[object]

A reference to a code defined by a terminology system.

system
string

The identification of the code system that defines the meaning of the symbol in the code.

code
string

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

text
string

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

reasonReference
[object]

Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.

Must reference one of the following types of resources:

  • Condition
  • Procedure
  • Observation
reference
string

A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

start
string

Date/Time that the appointment is to take place.

end
string

Date/Time that the appointment is to conclude.

minutesDuration
number

Number of minutes that the appointment is to take. This can be less than the duration between the start and end times. For example, where the actual time of appointment is only an estimate or if a 30 minute appointment is being requested, but any time would work. Also, if there is, for example, a planned 15 minute break in the middle of a long appointment, the duration may be 15 minutes less than the difference between the start and end.

search
required, object

Information about the search process that lead to the creation of this entry.

mode
required, string

Identifies the Appointment as matching the search parameters

Value: match