Appointment - FHIR Resource (stu3)

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

Validate an Appointment FHIR Resource (stu3)

Appointment Attributes

AttributeField is listTypeDescription

FHIR Version: stu3

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"status": "booked"

Learn more about the (Appointment) status FHIR attribute

Description: The slots that this appointment is filling

FHIR Version: stu3

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: A broad categorisation of the service that is to be performed during this appointment

FHIR Version: stu3

Attribute Type : CodeableConcept

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"serviceCategory": {
  "coding": [
    {
      "code": "gp",
      "system": "http://example.org/service-category",
      "display": "General Practice"
    }
  ]
}

Learn more about the (Appointment) serviceCategory FHIR attribute

Description: When appointment is to conclude

FHIR Version: stu3

Attribute Type : instant

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"end": "2013-12-10T11:00:00Z"

Learn more about the (Appointment) end FHIR attribute

Description: Shown on a subject line in a meeting request, or appointment list

FHIR Version: stu3

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"description": "Discussion on the results of your recent MRI"

Learn more about the (Appointment) description FHIR attribute

Description: The date that this appointment was initially created

FHIR Version: stu3

Attribute Type : dateTime

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"created": "2013-10-10"

Learn more about the (Appointment) created FHIR attribute

Description: Potential date/time interval(s) requested to allocate the appointment within

FHIR Version: stu3

Attribute Type : Period

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"requestedPeriod":

Learn more about the (Appointment) requestedPeriod FHIR attribute

Description: The specific service that is to be performed during this appointment

FHIR Version: stu3

Attribute Type : CodeableConcept

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"serviceType": [
  {
    "coding": [
      {
        "code": "52",
        "display": "General Discussion"
      }
    ]
  }
]

Learn more about the (Appointment) serviceType FHIR attribute

Description: Additional comments

FHIR Version: stu3

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"comment": "Further expand on the results of the MRI and determine the next actions that may be appropriate."

Learn more about the (Appointment) comment FHIR attribute

Description: The specialty of a practitioner that would be required to perform the service requested in this appointment

FHIR Version: stu3

Attribute Type : CodeableConcept

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"specialty": [
  {
    "coding": [
      {
        "code": "gp",
        "system": "http://example.org/specialty",
        "display": "General Practice"
      }
    ]
  }
]

Learn more about the (Appointment) specialty FHIR attribute

Description: Used to make informed decisions if needing to re-prioritize

FHIR Version: stu3

Attribute Type : unsignedInt

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"priority": 5

Learn more about the (Appointment) priority FHIR attribute

Description: When appointment is to take place

FHIR Version: stu3

Attribute Type : instant

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"start": "2013-12-10T09:00:00Z"

Learn more about the (Appointment) start FHIR attribute

Description: Reason this appointment is scheduled

FHIR Version: stu3

Attribute Type : CodeableConcept

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"reason":

Learn more about the (Appointment) reason FHIR attribute

Description: Reason the appointment is to takes place (resource)

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"indication": [
  {
    "display": "Severe burn of left ear",
    "reference": "Condition/example"
  }
]

Learn more about the (Appointment) indication FHIR attribute

Description: The style of appointment or patient that has been booked in the slot (not service type)

FHIR Version: stu3

Attribute Type : CodeableConcept

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"appointmentType": {
  "coding": [
    {
      "code": "follow",
      "system": "http://example.org/appointment-type",
      "display": "Followup"
    }
  ]
}

Learn more about the (Appointment) appointmentType FHIR attribute

Description: Participants involved in appointment

FHIR Version: stu3

Attribute Type : Data Type

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"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"
    }
  }
]

Learn more about the (Appointment) participant FHIR attribute

Description: External Ids for this item

FHIR Version: stu3

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: Can be less than start/end (e.g. estimate)

FHIR Version: stu3

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: Additional information to support the appointment

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"supportingInformation":

Learn more about the (Appointment) supportingInformation FHIR attribute

Description: The ReferralRequest provided as information to allocate to the Encounter

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"incomingReferral": [
  {
    "reference": "ReferralRequest/example"
  }
]

Learn more about the (Appointment) incomingReferral FHIR attribute

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

https://api.1up.health/fhir/stu3/Appointment?query-param=queryvalue

Search Parameter	Field Type	Resource Fields Searched
`actor`	`reference`	`participant.actor`
`appointment-type`	`text`	`appointmentType`
`date`	`date`	`start`
`identifier`	`text`	`identifier`
`incomingreferral`	`reference`	`incomingReferral`
`location`	`reference`	`participant.actor`
`part-status`	`text`	`participant.status`
`patient`	`reference`	`participant.actor`
`practitioner`	`reference`	`participant.actor`
`service-type`	`text`	`serviceType`
`status`	`text`	`status`