Appointment - FHIR Resource (stu3)


Resource Attributes

AttributeField is listTypeDescription
appointmentTypefalseCodeableConcept The style of appointment or patient that has been booked in the slot (not service type)
commentfalsestring Additional comments
createdfalsedateTime The date that this appointment was initially created
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
incomingReferraltrueReference The ReferralRequest provided as information to allocate to the Encounter
indicationtrueReference Reason the appointment is to takes place (resource)
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
reasontrueCodeableConcept Reason this appointment is scheduled
requestedPeriodtruePeriod Potential date/time interval(s) requested to allocate the appointment within
serviceCategoryfalseCodeableConcept A broad categorisation of the service that is to be performed during this appointment
serviceTypetrueCodeableConcept The specific service that is to be performed during this appointment
slottrueReference The slots that this appointment is filling
specialtytrueCodeableConcept The specialty of a practitioner that would be required to perform the service requested in this appointment
startfalseinstant When appointment is to take place
statusfalsecode proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error
supportingInformationtrueReference Additional information to support the appointment

Appointment Example

{
  "status": "booked",
  "comment": "Further expand on the results of the MRI and determine the next actions that may be appropriate.",
  "serviceCategory": {
    "coding": [
      {
        "code": "gp",
        "system": "http://example.org/service-category",
        "display": "General Practice"
      }
    ]
  },
  "end": "2013-12-10T11:00:00Z",
  "description": "Discussion on the results of your recent MRI",
  "created": "2013-10-10",
  "resourceType": "Appointment",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Brian MRI results discussion</div>"
  },
  "serviceType": [
    {
      "coding": [
        {
          "code": "52",
          "display": "General Discussion"
        }
      ]
    }
  ],
  "specialty": [
    {
      "coding": [
        {
          "code": "gp",
          "system": "http://example.org/specialty",
          "display": "General Practice"
        }
      ]
    }
  ],
  "priority": 5,
  "start": "2013-12-10T09:00:00Z",
  "indication": [
    {
      "display": "Severe burn of left ear",
      "reference": "Condition/example"
    }
  ],
  "appointmentType": {
    "coding": [
      {
        "code": "follow",
        "system": "http://example.org/appointment-type",
        "display": "Followup"
      }
    ]
  },
  "participant": [
    {
      "status": "accepted",
      "required": "required",
      "actor": {
        "display": "Peter James Chalmers",
        "reference": "Patient/example"
      }
    },
    {
      "status": "accepted",
      "required": "required",
      "type": [
        {
          "coding": [
            {
              "code": "ATND",
              "system": "http://hl7.org/fhir/v3/ParticipationType"
            }
          ]
        }
      ],
      "actor": {
        "display": "Dr Adam Careful",
        "reference": "Practitioner/example"
      }
    },
    {
      "status": "accepted",
      "required": "required",
      "actor": {
        "display": "South Wing, second floor",
        "reference": "Location/1"
      }
    }
  ],
  "id": "example",
  "incomingReferral": [
    {
      "reference": "ReferralRequest/example"
    }
  ]
}

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 | entered-in-error
  "serviceCategory" : { CodeableConcept }, // A broad categorisation of the service that is to be performed during this appointment
  "serviceType" : [{ CodeableConcept }], // The specific service that is to be performed during this appointment
  "specialty" : [{ CodeableConcept }], // The specialty of a practitioner that would be required to perform the service requested in this appointment
  "appointmentType" : { CodeableConcept }, // The style of appointment or patient that has been booked in the slot (not service type)
  "reason" : [{ CodeableConcept }], // Reason this appointment is scheduled
  "indication" : [{ Reference(Condition|Procedure) }], // Reason the appointment is to takes place (resource)
  "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
  "supportingInformation" : [{ Reference(Any) }], // Additional information to support the appointment
  "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) }], // The slots that this appointment is filling
  "created" : "<dateTime>", // The date that this appointment was initially created
  "comment" : "<string>", // Additional comments
  "incomingReferral" : [{ Reference(ReferralRequest) }], // The ReferralRequest provided as information to allocate to the Encounter
  "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
  }],
  "requestedPeriod" : [{ Period }] // Potential date/time interval(s) requested to allocate the appointment within
}


 

Appointment Search Parameters

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

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