Appointment - FHIR Resource (dstu2)
This Appointment Resource uses the FHIR API standard for access and structure.
Validate an Appointment FHIR Resource (dstu2)
Appointment Attributes
AttributeField is listTypeDescription
Description: proposed | pending | booked | arrived | fulfilled | cancelled | noshow
FHIR Version: dstu2
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": Learn more about the (Appointment) status FHIR attribute
Description: If provided, then no schedule and start/end values MUST match slot
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"slot": Learn more about the (Appointment) slot FHIR attribute
Description: When appointment is to conclude
FHIR Version: dstu2
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 (Appointment) end FHIR attribute
Description: Shown on a subject line in a meeting request, or appointment list
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"description": Learn more about the (Appointment) description FHIR attribute
Description: Additional comments
FHIR Version: dstu2
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 (Appointment) comment FHIR attribute
Description: Used to make informed decisions if needing to re-prioritize
FHIR Version: dstu2
Attribute Type : unsignedInt
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"priority": Learn more about the (Appointment) priority FHIR attribute
Description: When appointment is to take place
FHIR Version: dstu2
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 (Appointment) start FHIR attribute
Description: Reason this appointment is scheduled
FHIR Version: dstu2
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"reason": Learn more about the (Appointment) reason FHIR attribute
Description: Can be less than start/end (e.g. estimate)
FHIR Version: dstu2
Attribute Type : positiveInt
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"minutesDuration": Learn more about the (Appointment) minutesDuration FHIR attribute
Description: Participants involved in appointment
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"participant": Learn more about the (Appointment) participant FHIR attribute
Description: External Ids for this item
FHIR Version: dstu2
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 (Appointment) identifier FHIR attribute
Description: The type of appointment that is being booked
FHIR Version: dstu2
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"type": Learn more about the (Appointment) type FHIR attribute
Appointment Structure
{
"resourceType" : "Appointment",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // External Ids for this item
"status" : "<code>", // R! proposed | pending | booked | arrived | fulfilled | cancelled | noshow
"type" : { CodeableConcept }, // The type of appointment that is being booked
"reason" : { CodeableConcept }, // Reason this appointment is scheduled
"priority" : "<unsignedInt>", // Used to make informed decisions if needing to re-prioritize
"description" : "<string>", // Shown on a subject line in a meeting request, or appointment list
"start" : "<instant>", // When appointment is to take place
"end" : "<instant>", // When appointment is to conclude
"minutesDuration" : "<positiveInt>", // Can be less than start/end (e.g. estimate)
"slot" : [{ Reference(Slot) }], // If provided, then no schedule and start/end values MUST match slot
"comment" : "<string>", // Additional comments
"participant" : [{ // R! Participants involved in appointment
"type" : [{ CodeableConcept }], // Role of participant in the appointment
"actor" : { Reference(Patient|Practitioner|RelatedPerson|Device|
HealthcareService|Location) }, // Person, Location/HealthcareService or Device
"required" : "<code>", // required | optional | information-only
"status" : "<code>" // R! accepted | declined | tentative | needs-action
}]
}
Appointment Search Parameters
The following search parameters can be used to query Appointment resources. Just submit them like so:
https://api.1up.health/fhir/dstu2/Appointment?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
actor | reference | participant.actor |
date | date | start |
identifier | text | identifier |
location | reference | participant.actor |
part-status | text | participant.status |
patient | reference | participant.actor |
practitioner | reference | participant.actor |
status | text | status |
