Redox | FHIR.Appointment

Table of Contents

FHIR.Appointment

read
search

read

Fields

Show Required Fields Only

Show Translation Fields

Meta
- Meta.DataModel
  String
  Reliable
  Required
  FHIR.Appointment
- Meta.EventType
  String
  Reliable
  Required
  read
- Meta.EventDateTime
  DateTime
  Reliable
  DateTime of the event.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Flag as a test message
- Meta.Source
  String
  Reliable
  Where the message originated.
  Included in messages from Redox
- Meta.Source.ID
  String
  Reliable
  ID of the source.
  UUID
- Meta.Source.Name
  String
  Reliable
  Name of the source
- Meta.Destinations[]
  Array of Objects
  Reliable
  List of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
  Required when sending data to Redox
- Meta.Destinations[].ID
  String
  Reliable
  ID of the destination.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Name of the destination
- Meta.Logs[]
  Array of Objects
  Reliable
  Request log identifiers.
- Meta.Logs[].ID
  String
  Reliable
  ID of a request log that corresponds to this request, used for support and reference within the Redox dashboard.
  UUID
- Meta.Logs[].AttemptID
  String
  Reliable
  ID of request log attempt. Useful in cases where retries are possible.
  UUID
- Meta.Message
  String
  Reliable
  Record in Redox that corresponds to the communication sent from the source to Redox.
  Included in messages from Redox
- Meta.Message.ID
  Numeric
  Reliable
  ID of the message created in Redox.
  (Deprecated. Slated for removal on or after Nov. 1, 2022. Use Meta.Logs[].ID instead)
- Meta.Transmission
  String
  Reliable
  Record in Redox that corresponds to the communication sent from Redox to your destination.
  Included in messages from Redox
- Meta.Transmission.ID
  Numeric
  Reliable
  ID of the transmission created in Redox.
  (Deprecated. Slated for removal on or after Nov. 1, 2022. Use Meta.Logs[].ID instead)
- Meta.FacilityCode
  String
  Possible
  Code for the facility related to the message.
  Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
- Meta.SessionID
  String
  Possible
  Session ID to be passed through for 3rd party sessions.
  This is used for SMART App Launch and other OAuth/OpenID Connect flows where an access token is provided in addition to the SSO claims. The SessionID can be used on subsequent Redox API requests to fetch data.
id
- id
  string
  Possible
  Required
  The id of the resource

Sample MessageDownload JSON Schema

{
   "Meta": {
      "Logs": [
         {
            "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
            "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
         }
      ],
      "Test": true,
      "EventDateTime": "2022-07-01T17:19:28.573Z",
      "Destinations": [
         {
            "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
            "Name": "Redox EMR"
         }
      ],
      "DataModel": "FHIR.Appointment",
      "EventType": "read"
   },
   "id": "5348a311-015b-44d0-a633-901dea3b4caa"
}

search

Fields

Show Required Fields Only

Show Translation Fields

Meta
- Meta.DataModel
  String
  Reliable
  Required
  FHIR.Appointment
- Meta.EventType
  String
  Reliable
  Required
  search
- Meta.EventDateTime
  DateTime
  Reliable
  DateTime of the event.
  ISO 8601 Format
- Meta.Test
  Boolean
  Reliable
  Flag as a test message
- Meta.Source
  String
  Reliable
  Where the message originated.
  Included in messages from Redox
- Meta.Source.ID
  String
  Reliable
  ID of the source.
  UUID
- Meta.Source.Name
  String
  Reliable
  Name of the source
- Meta.Destinations[]
  Array of Objects
  Reliable
  List of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
  Required when sending data to Redox
- Meta.Destinations[].ID
  String
  Reliable
  ID of the destination.
  UUID
- Meta.Destinations[].Name
  String
  Reliable
  Name of the destination
- Meta.Logs[]
  Array of Objects
  Reliable
  Request log identifiers.
- Meta.Logs[].ID
  String
  Reliable
  ID of a request log that corresponds to this request, used for support and reference within the Redox dashboard.
  UUID
- Meta.Logs[].AttemptID
  String
  Reliable
  ID of request log attempt. Useful in cases where retries are possible.
  UUID
- Meta.Message
  String
  Reliable
  Record in Redox that corresponds to the communication sent from the source to Redox.
  Included in messages from Redox
- Meta.Message.ID
  Numeric
  Reliable
  ID of the message created in Redox.
  (Deprecated. Slated for removal on or after Nov. 1, 2022. Use Meta.Logs[].ID instead)
- Meta.Transmission
  String
  Reliable
  Record in Redox that corresponds to the communication sent from Redox to your destination.
  Included in messages from Redox
- Meta.Transmission.ID
  Numeric
  Reliable
  ID of the transmission created in Redox.
  (Deprecated. Slated for removal on or after Nov. 1, 2022. Use Meta.Logs[].ID instead)
- Meta.FacilityCode
  String
  Possible
  Code for the facility related to the message.
  Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.
- Meta.SessionID
  String
  Possible
  Session ID to be passed through for 3rd party sessions.
  This is used for SMART App Launch and other OAuth/OpenID Connect flows where an access token is provided in addition to the SSO claims. The SessionID can be used on subsequent Redox API requests to fetch data.
_id
- _id[]
  token
  Possible
  The internal ID (UUIDv4) of the Appointment.
_include
- _include[]
  special
  Possible
  Include resources referenced by the Appointment resource in the results. Value should be Appointment:parameter where the parameter is a reference-type parameter of the Appointment resource.
_revinclude
- _revinclude[]
  special
  Possible
  Include resources that reference the Appointment resource in the results. Value should be ReferencingResource:parameter where the parameter is a reference-type parameter of a resource that references the Appointment resource.
_sort
- _sort[]
  string
  Possible
  The name of a Appointment parameter used to sort multiple search results in ascending order. Prefix with - to sort in descending order.
_count
- _count[]
  number
  Possible
  Specifies the maximum number of Appointment resources to return.
identifier
- identifier[]
  token
  Possible
  One or more external identifiers for the appointment
date
- date[]
  date
  Possible
  The date/time when the appointment starts
practitioner
- practitioner[]
  reference
  Possible
  Any practitioner(s) that are participants in the appointment
- practitioner.identifier[]
  array
  Possible
  One or more external identifiers for the practitioner
patient
- patient[]
  reference
  Possible
  Any patient(s) that are participants in the appointment
- patient.identifier[]
  array
  Possible
  One or more external identifiers for the patient
location
- location[]
  reference
  Possible
  Any location(s) that are participants in the appointment
- location.identifier[]
  array
  Possible
  One or more external identifiers for the location
- location.name[]
  array
  Possible
  The location's name.
- location.physical-type[]
  array
  Possible
  The location's physical form
- location.name-physical-type[]
  array
  Possible
  Specify both name and physical-type at once. This is a Redox-specific parameter.
status
- status[]
  token
  Possible
  The appointment's status

Sample MessageDownload JSON Schema

{
   "Meta": {
      "Logs": [
         {
            "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
            "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
         }
      ],
      "Test": true,
      "EventDateTime": "2022-07-01T17:19:28.573Z",
      "Destinations": [
         {
            "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
            "Name": "Redox EMR"
         }
      ],
      "DataModel": "FHIR.Appointment",
      "EventType": "search"
   },
   "_id": [],
   "_include": [],
   "_revinclude": [],
   "_sort": [],
   "_count": [],
   "identifier": [],
   "date": [],
   "practitioner": [],
   "patient": [],
   "location": [],
   "status": [],
   "location.identifier": [],
   "location.name": [],
   "location.physical-type": [],
   "location.name-physical-type": [],
   "patient.identifier": [],
   "practitioner.identifier": []
}

FHIR.Appointment

readlink

Fields

Meta

id

searchlink

Fields

Meta

_id

_include

_revinclude

_sort

_count

identifier

date

practitioner

patient

location

status

read

search