AppointmentResponse - FHIR Resource (stu3) This AppointmentResponse Resource uses the
FHIR API standard for access and structure.
Validate an AppointmentResponse FHIR Resource (stu3)
AppointmentResponse Attributes Attribute Field is list Type Description
comment
false
string
Additional comments
Description: Additional comments
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
appointment
false
Reference
Appointment this response relates to
Description: Appointment this response relates to
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example: "appointment": {
"display": "Brian MRI results discussion",
"reference": "Appointment/example"
}
actor
false
Reference
"actor" : { Reference(Patient|Practitioner|RelatedPerson|Device|
Description: "actor" : { Reference(Patient|Practitioner|RelatedPerson|Device|
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example: "actor": {
"display": "Peter James Chalmers",
"reference": "Patient/example"
}
start
false
instant
Time from appointment, or requested new start time
Description: Time from appointment, or requested new start time
Attribute Type : instant
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
participantType
true
CodeableConcept
Role of participant in the appointment
Description: Role of participant in the appointment
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example: "participantType":
end
false
instant
Time from appointment, or requested new end time
Description: Time from appointment, or requested new end time
Attribute Type : instant
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
identifier
true
Identifier
External Ids for this item
Description: External Ids for this item
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
participantStatus
false
code
accepted | declined | tentative | in-process | completed | needs-action | entered-in-error
Description: accepted | declined | tentative | in-process | completed | needs-action | entered-in-error
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example: "participantStatus": "accepted"
AppointmentResponse Example {
"appointment": {
"display": "Brian MRI results discussion",
"reference": "Appointment/example"
},
"resourceType": "AppointmentResponse",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Accept Brian MRI results discussion</div>"
},
"actor": {
"display": "Peter James Chalmers",
"reference": "Patient/example"
},
"participantStatus": "accepted",
"id": "example"
}
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|RelatedPerson|Device|
HealthcareService|Location) }, // Person, Location/HealthcareService or Device
"participantStatus" : "<code>", // R! accepted | declined | tentative | in-process | completed | needs-action | entered-in-error
"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/stu3/AppointmentResponse?query-param=queryvalue
Search Parameter Field Type Resource Fields Searched actor
reference
actor
appointment
reference
appointment
identifier
text
identifier
location
reference
actor
part-status
text
participantStatus
patient
reference
actor
practitioner
reference
actor