Appointment - FHIR Resource (dstu2)


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

Resource Attributes

AttributeField is listTypeDescription
commentfalsestring Additional comments
descriptionfalsestring Shown on a subject line in a meeting request, or appointment list
endfalseinstant When appointment is to conclude
identifiertrueIdentifier External Ids for this item
minutesDurationfalsepositiveInt Can be less than start/end (e.g. estimate)
participanttrueData Type Participants involved in appointment
priorityfalseunsignedInt Used to make informed decisions if needing to re-prioritize
reasonfalseCodeableConcept Reason this appointment is scheduled
slottrueReference If provided, then no schedule and start/end values MUST match slot
startfalseinstant When appointment is to take place
statusfalsecode proposed | pending | booked | arrived | fulfilled | cancelled | noshow
typefalseCodeableConcept The type of appointment that is being booked

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 the like so:

https://api.1up.health/fhir/dstu2/Appointment?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
actorreferenceparticipant.actor
datedatestart
identifiertextidentifier
locationreferenceparticipant.actor
part-statustextparticipant.status
patientreferenceparticipant.actor
practitionerreferenceparticipant.actor
statustextstatus