Appointment.participant
FHIR attribute (stu3)
In the Appointment resource for FHIR stu3 , the participant attribute identifies the Participants involved in appointment
participant (Appointment) description
Attribute Name: participant
Description: Participants involved in appointment
Attribute Type :
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Appointment.participant 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"
}
}
]
Appointment attributes
AttributeField is listTypeDescription
Description: proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:"status": "booked"
Description: The slots that this appointment is filling
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Description: A broad categorisation of the service that is to be performed during this appointment
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"
}
]
}
Description: When appointment is to conclude
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"
Description: Shown on a subject line in a meeting request, or appointment list
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"
Description: The date that this appointment was initially created
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"
Description: Potential date/time interval(s) requested to allocate the appointment within
Attribute Type : Period
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:"requestedPeriod":
Description: The specific service that is to be performed during this appointment
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"
}
]
}
]
Description: Additional comments
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."
Description: The specialty of a practitioner that would be required to perform the service requested in this appointment
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"
}
]
}
]
Description: Used to make informed decisions if needing to re-prioritize
Attribute Type : unsignedInt
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Description: When appointment is to take place
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"
Description: Reason this appointment is scheduled
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Description: Reason the appointment is to takes place (resource)
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"
}
]
Description: The style of appointment or patient that has been booked in the slot (not service type)
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"
}
]
}
Description: Participants involved in appointment
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"
}
}
]
Description: External Ids for this item
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Description: Can be less than start/end (e.g. estimate)
Attribute Type : positiveInt
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:"minutesDuration":
Description: Additional information to support the appointment
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:"supportingInformation":
Description: The ReferralRequest provided as information to allocate to the Encounter
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"
}
]