Appointment _search

post/Appointment/_search
Page View

This resource contains entries with a patient, provider, or location schedule. Each appointment entry contains the status, participants, date/time, and other details. 

You can review, retrieve, create, update, or cancel appointment information.

_search

Query for a patient, provider, or location appointment schedule.

This is a flexible option with query parameters to refine your search. The response returns a bundle of resources, known as a searchset bundle type. Learn about bundles and bundle types in our FHIR® glossary.

Request parameters and payload

cURL request example

bash
1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/Appointment/_search' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'Content-Type: application/x-www-form-urlencoded' \
5
--data-urlencode 'identifier=string' \
6
--data-urlencode 'date=string' \
7
--data-urlencode 'practitioner=string' \
8
--data-urlencode 'practitioner.identifier=string' \
9
--data-urlencode 'patient=string' \
10
--data-urlencode 'patient.identifier=string' \
11
--data-urlencode 'location=string' \
12
--data-urlencode 'location.identifier=string' \
13
--data-urlencode 'location.name=string' \
14
--data-urlencode 'location.physical-type=string' \
15
--data-urlencode 'location.name-physical-type=string' \
16
--data-urlencode 'status=string'

Request Body Schema

  • identifier
    Array of string

    One or more external identifiers for the appointment

  • date
    Array of string

    The date/time when the appointment starts

  • practitioner
    Array of string

    Any practitioner(s) that are participants in the appointment

  • practitioner.identifier
    Array of string

    One or more external identifiers for the practitioner

  • patient
    Array of string

    Any patient(s) that are participants in the appointment

  • patient.identifier
    Array of string

    One or more external identifiers for the patient

  • location
    Array of string

    Any location(s) that are participants in the appointment

  • location.identifier
    Array of string

    One or more external identifiers for the location

  • location.name
    Array of string

    The location's name.

  • location.physical-type
    Array of string

    The location's physical form

  • location.name-physical-type
    Array of string

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

  • status
    Array of string

    The appointment's status

Response fields and example

Example payload generated from schema
1
{
2
"resourceType": "Bundle",
3
"type": "searchset",
4
"total": 1,
5
"entry": [
6
{
7
"resource": {
8
"resourceType": "Appointment",
9
"id": "RedoxAppointmentExample",
10
"participant": [
11
{
12
"status": "accepted",
13
"actor": {
14
"reference": "Patient/RedoxPatientExampleTimothy"
15
}
16
},
17
{
18
"status": "accepted",
19
"actor": {
20
"reference": "Location/RedoxLocationExample"
21
}
22
}
23
],
24
"identifier": [
25
{
26
"system": "urn:oid:1.2.840.114350.1.13.123.1.7.3.698084.8",
27
"value": "321654654"
28
}
29
],
30
"appointmentType": {
31
"coding": [
32
{
33
"code": "EMERGENCY",
34
"system": "http://terminology.hl7.org/CodeSystem/v2-0276",
35
"display": "Emergency appointment"
36
}
37
]
38
},
39
"status": "proposed",
40
"_status": {
41
"extension": [
42
{
43
"url": "http://hl7.org/fhir/StructureDefinition/originalText",
44
"valueString": "Intent"
45
}
46
]
47
},
48
"start": "2012-08-20T05:00:00.000Z",
49
"end": "2012-08-20T05:15:00.000Z",
50
"minutesDuration": 15,
51
"reasonCode": [
52
{
53
"coding": [
54
{
55
"code": "99241",
56
"system": "http://www.ama-assn.org/go/cpt",
57
"display": "Office consultation - 15 minutes"
58
}
59
]
60
}
61
]
62
},
63
"search": {
64
"mode": "match"
65
}
66
}
67
]
68
}

    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
    Array of Appointment or Other

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

    • 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
          Array of OriginalText or 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.

            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, Array of Patient, Practitioner, Location or Other

        List of participants involved in the appointment.

        • status
          required, string

          Participation status of the actor.

          Value: accepted
        • type
          Array of object

          Role of participant in the appointment.

          • extension
            Array of OriginalText or 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.

              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.

      • extension
        Array of oldDateTime, oldVisitNumber or 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.

          The original, or old, date time of the appointment. This can be used to recognize if the appointment has been rescheduled.

        • url
          required, string

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

          Value: https://fhir.redoxengine.com/StructureDefinition/AppointmentOldDateTime
        • valueDateTime
          string

          Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

      • identifier
        Array of 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
          Array of Boolean, String, CodeableConcept, Coding, HumanName or 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.

          • 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.

      • cancelationReason
        object

        The coded reason for the appointment being cancelled. This is often used in reporting/billing/futher processing to determine if further actions are required, or specific fees apply.

        • coding
          Array of 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.

      • appointmentType
        object

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

        • coding
          Array of 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
        Array of object

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

        • coding
          Array of 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
        Array of 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
        • Procedure
        • 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