AppointmentResponse - FHIR Resource (r4)

This AppointmentResponse Resource uses the FHIR API standard for access and structure.

Validate an AppointmentResponse FHIR Resource (r4)

AppointmentResponse Attributes

AttributeField is listTypeDescription

Description: External Ids for this item

FHIR Version: r4

Attribute Type : Identifier

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"identifier":

Learn more about the (AppointmentResponse) identifier FHIR attribute

Description: Appointment this response relates to

FHIR Version: r4

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"appointment": {
  "reference": "Appointment/example",
  "display": "Brian MRI results discussion"
}

Learn more about the (AppointmentResponse) appointment FHIR attribute

Description: Time from appointment, or requested new start time

FHIR Version: r4

Attribute Type : instant

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"start":

Learn more about the (AppointmentResponse) start FHIR attribute

Description: Time from appointment, or requested new end time

FHIR Version: r4

Attribute Type : instant

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"end":

Learn more about the (AppointmentResponse) end FHIR attribute

Description: Role of participant in the appointment

FHIR Version: r4

Attribute Type : CodeableConcept

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"participantType":

Learn more about the (AppointmentResponse) participantType FHIR attribute

Description: "actor" : { Reference(Patient|Practitioner|PractitionerRole|RelatedPerson|

FHIR Version: r4

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"actor": {
  "reference": "Patient/example",
  "display": "Peter James Chalmers"
}

Learn more about the (AppointmentResponse) actor FHIR attribute

Description: accepted | declined | tentative | needs-action

FHIR Version: r4

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"participantStatus": "accepted"

Learn more about the (AppointmentResponse) participantStatus FHIR attribute

Description: Additional comments

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"comment":

Learn more about the (AppointmentResponse) comment FHIR attribute

AppointmentResponse Example

{
  "resourceType": "AppointmentResponse",
  "id": "example",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Accept Brian MRI results discussion</div>"
  },
  "appointment": {
    "reference": "Appointment/example",
    "display": "Brian MRI results discussion"
  },
  "actor": {
    "reference": "Patient/example",
    "display": "Peter James Chalmers"
  },
  "participantStatus": "accepted"
}

AppointmentResponse Structure

{
  "resourceType" : "AppointmentResponse",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // External Ids for this item
  "appointment" : { Reference(Appointment) }, // R!  Appointment this response relates to
  "start" : "<instant>", // Time from appointment, or requested new start time
  "end" : "<instant>", // Time from appointment, or requested new end time
  "participantType" : [{ CodeableConcept }], // Role of participant in the appointment
  "actor" : { Reference(Patient|Practitioner|PractitionerRole|RelatedPerson|
   Device|HealthcareService|Location) }, // Person, Location, HealthcareService, or Device
  "participantStatus" : "<code>", // R!  accepted | declined | tentative | needs-action
  "comment" : "<string>" // Additional comments
}

AppointmentResponse Search Parameters

The following search parameters can be used to query AppointmentResponse resources. Just submit them like so:

https://api.1up.health/fhir/r4/AppointmentResponse?query-param=queryvalue

Search Parameter	Field Type	Resource Fields Searched
`actor`	`reference`	`actor`
`appointment`	`reference`	`appointment`
`identifier`	`text`	`identifier`
`location`	`reference`	`actor.where`
`part-status`	`text`	`participantStatus`
`patient`	`reference`	`actor.where`
`practitioner`	`reference`	`actor.where`