Appointment - FHIR Resource (r4)


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

Validate an Appointment FHIR Resource (r4)



Resource Attributes

AttributeField is listTypeDescription
appointmentTypefalseCodeableConcept# The style of appointment or patient that has been booked in the slot (not service type)
basedOntrueReference# The service request this appointment is allocated to assess
cancelationReasonfalseCodeableConcept# The coded reason for the appointment being cancelled
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
minutesDurationfalsepositiveInt# Can be less than start/end (e.g. estimate)
participanttrueData Type# Participants involved in appointment
patientInstructionfalsestring# Detailed information and instructions for the patient
priorityfalseunsignedInt# Used to make informed decisions if needing to re-prioritize
reasonCodetrueCodeableConcept# Coded reason this appointment is scheduled
reasonReferencetrueReference# "reasonReference" : [{ Reference(Condition|Procedure|Observation|
requestedPeriodtruePeriod# Potential date/time interval(s) requested to allocate the appointment within
serviceCategorytrueCodeableConcept# A broad categorization 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 | checked-in | waitlist
supportingInformationtrueReference# Additional information to support the appointment

Appointment Example

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

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 | checked-in | waitlist
  "cancelationReason" : { CodeableConcept }, // The coded reason for the appointment being cancelled
  "serviceCategory" : [{ CodeableConcept }], // A broad categorization 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)
  "reasonCode" : [{ CodeableConcept }], // Coded reason this appointment is scheduled
  "reasonReference" : [{ Reference(Condition|Procedure|Observation|
   ImmunizationRecommendation) }], // Reason the appointment is to take 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
  "patientInstruction" : "<string>", // Detailed information and instructions for the patient
  "basedOn" : [{ Reference(ServiceRequest) }], // The service request this appointment is allocated to assess
  "participant" : [{ // R!  Participants involved in appointment
    "type" : [{ CodeableConcept }], // Role of participant in the appointment
    "actor" : { Reference(Patient|Practitioner|PractitionerRole|RelatedPerson|
    Device|HealthcareService|Location) }, // Person, Location/HealthcareService or Device
    "required" : "<code>", // required | optional | information-only
    "status" : "<code>", // R!  accepted | declined | tentative | needs-action
    "period" : { Period } // Participation period of the actor
  }],
  "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 them like so:

https://api.1up.health/fhir/r4/Appointment?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
actorreferenceparticipant.actor
appointment-typetextappointmentType
based-onreferencebasedOn
datedatestart
identifiertextidentifier
locationreferenceparticipant.actor.where
part-statustextparticipant.status
patientreferenceparticipant.actor.where
practitionerreferenceparticipant.actor.where
reason-codetextreasonCode
reason-referencereferencereasonReference
service-categorytextserviceCategory
service-typetextserviceType
slotreferenceslot
specialtytextspecialty
statustextstatus
supporting-inforeferencesupportingInformation