Appointment

A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).

Columns

Header row
# path type required description
0 resourceType string * Resource type identifier. Must be string "Appointment"
1 integer * Number of subrows
2 id string * Logical id of this artifact
3 status code proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
cancelationReason CodeableConcept The coded reason for the appointment being cancelled
cancelationReason.coding Coding Code defined by a terminology system
4 cancelationReason.coding.system uri Identity of the terminology system
5 cancelationReason.coding.version string Version of the system - if relevant
6 cancelationReason.coding.code code Symbol in syntax defined by the system
7 cancelationReason.coding.display string Representation defined by the system
8 cancelationReason.coding.userSelected boolean If this coding was chosen directly by the user
9 cancelationReason.text string Plain text representation of the concept
appointmentType CodeableConcept The style of appointment or patient that has been booked in the slot (not service type)
appointmentType.coding Coding Code defined by a terminology system
10 appointmentType.coding.system uri Identity of the terminology system
11 appointmentType.coding.version string Version of the system - if relevant
12 appointmentType.coding.code code Symbol in syntax defined by the system
13 appointmentType.coding.display string Representation defined by the system
14 appointmentType.coding.userSelected boolean If this coding was chosen directly by the user
15 appointmentType.text string Plain text representation of the concept
16 priority unsignedInt Used to make informed decisions if needing to re-prioritize
17 description string Shown on a subject line in a meeting request, or appointment list
18 start instant When appointment is to take place
19 end instant When appointment is to conclude
20 minutesDuration positiveInt Can be less than start/end (e.g. estimate)
21 created dateTime The date that this appointment was initially created
22 comment string Additional comments
23 patientInstruction string Detailed information and instructions for the patient
Row identifier
# path type required description
0 string * Subrow identifier. Must be string "identifier"
identifier Identifier External Ids for this item
1 identifier.use code usual | official | temp | secondary | old (If known)
identifier.type CodeableConcept Description of identifier
identifier.type.coding Coding Code defined by a terminology system
2 identifier.type.coding.system uri Identity of the terminology system
3 identifier.type.coding.version string Version of the system - if relevant
4 identifier.type.coding.code code Symbol in syntax defined by the system
5 identifier.type.coding.display string Representation defined by the system
6 identifier.type.coding.userSelected boolean If this coding was chosen directly by the user
7 identifier.type.text string Plain text representation of the concept
8 identifier.system uri The namespace for the identifier value
9 identifier.value string The value that is unique
identifier.period Period Time period when id is/was valid for use
10 identifier.period.start dateTime Starting time with inclusive boundary
11 identifier.period.end dateTime End time with inclusive boundary, if not ongoing
Row serviceCategory
# path type required description
0 string * Subrow identifier. Must be string "serviceCategory"
serviceCategory CodeableConcept A broad categorization of the service that is to be performed during this appointment
serviceCategory.coding Coding Code defined by a terminology system
1 serviceCategory.coding.system uri Identity of the terminology system
2 serviceCategory.coding.version string Version of the system - if relevant
3 serviceCategory.coding.code code Symbol in syntax defined by the system
4 serviceCategory.coding.display string Representation defined by the system
5 serviceCategory.coding.userSelected boolean If this coding was chosen directly by the user
6 serviceCategory.text string Plain text representation of the concept
Row serviceType
# path type required description
0 string * Subrow identifier. Must be string "serviceType"
serviceType CodeableConcept The specific service that is to be performed during this appointment
serviceType.coding Coding Code defined by a terminology system
1 serviceType.coding.system uri Identity of the terminology system
2 serviceType.coding.version string Version of the system - if relevant
3 serviceType.coding.code code Symbol in syntax defined by the system
4 serviceType.coding.display string Representation defined by the system
5 serviceType.coding.userSelected boolean If this coding was chosen directly by the user
6 serviceType.text string Plain text representation of the concept
Row specialty
# path type required description
0 string * Subrow identifier. Must be string "specialty"
specialty CodeableConcept The specialty of a practitioner that would be required to perform the service requested in this appointment
specialty.coding Coding Code defined by a terminology system
1 specialty.coding.system uri Identity of the terminology system
2 specialty.coding.version string Version of the system - if relevant
3 specialty.coding.code code Symbol in syntax defined by the system
4 specialty.coding.display string Representation defined by the system
5 specialty.coding.userSelected boolean If this coding was chosen directly by the user
6 specialty.text string Plain text representation of the concept
Row reasonCode
# path type required description
0 string * Subrow identifier. Must be string "reasonCode"
reasonCode CodeableConcept Coded reason this appointment is scheduled
reasonCode.coding Coding Code defined by a terminology system
1 reasonCode.coding.system uri Identity of the terminology system
2 reasonCode.coding.version string Version of the system - if relevant
3 reasonCode.coding.code code Symbol in syntax defined by the system
4 reasonCode.coding.display string Representation defined by the system
5 reasonCode.coding.userSelected boolean If this coding was chosen directly by the user
6 reasonCode.text string Plain text representation of the concept
Row reasonReference
# path type required description
0 string * Subrow identifier. Must be string "reasonReference"
reasonReference Reference Reason the appointment is to take place (resource)
1 reasonReference.reference string Literal reference, Relative, internal or absolute URL
2 reasonReference.type uri Type the reference refers to (e.g. "Patient")
reasonReference.identifier Identifier Logical reference, when literal reference is not known
3 reasonReference.identifier.use code usual | official | temp | secondary | old (If known)
reasonReference.identifier.type CodeableConcept Description of identifier
reasonReference.identifier.type.coding Coding Code defined by a terminology system
4 reasonReference.identifier.type.coding.system uri Identity of the terminology system
5 reasonReference.identifier.type.coding.version string Version of the system - if relevant
6 reasonReference.identifier.type.coding.code code Symbol in syntax defined by the system
7 reasonReference.identifier.type.coding.display string Representation defined by the system
8 reasonReference.identifier.type.coding.userSelected boolean If this coding was chosen directly by the user
9 reasonReference.identifier.type.text string Plain text representation of the concept
10 reasonReference.identifier.system uri The namespace for the identifier value
11 reasonReference.identifier.value string The value that is unique
reasonReference.identifier.period Period Time period when id is/was valid for use
12 reasonReference.identifier.period.start dateTime Starting time with inclusive boundary
13 reasonReference.identifier.period.end dateTime End time with inclusive boundary, if not ongoing
14 reasonReference.display string Text alternative for the resource
Row supportingInformation
# path type required description
0 string * Subrow identifier. Must be string "supportingInformation"
supportingInformation Reference Additional information to support the appointment
1 supportingInformation.reference string Literal reference, Relative, internal or absolute URL
2 supportingInformation.type uri Type the reference refers to (e.g. "Patient")
supportingInformation.identifier Identifier Logical reference, when literal reference is not known
3 supportingInformation.identifier.use code usual | official | temp | secondary | old (If known)
supportingInformation.identifier.type CodeableConcept Description of identifier
supportingInformation.identifier.type.coding Coding Code defined by a terminology system
4 supportingInformation.identifier.type.coding.system uri Identity of the terminology system
5 supportingInformation.identifier.type.coding.version string Version of the system - if relevant
6 supportingInformation.identifier.type.coding.code code Symbol in syntax defined by the system
7 supportingInformation.identifier.type.coding.display string Representation defined by the system
8 supportingInformation.identifier.type.coding.userSelected boolean If this coding was chosen directly by the user
9 supportingInformation.identifier.type.text string Plain text representation of the concept
10 supportingInformation.identifier.system uri The namespace for the identifier value
11 supportingInformation.identifier.value string The value that is unique
supportingInformation.identifier.period Period Time period when id is/was valid for use
12 supportingInformation.identifier.period.start dateTime Starting time with inclusive boundary
13 supportingInformation.identifier.period.end dateTime End time with inclusive boundary, if not ongoing
14 supportingInformation.display string Text alternative for the resource
Row slot
# path type required description
0 string * Subrow identifier. Must be string "slot"
slot Reference The slots that this appointment is filling
1 slot.reference string Literal reference, Relative, internal or absolute URL
2 slot.type uri Type the reference refers to (e.g. "Patient")
slot.identifier Identifier Logical reference, when literal reference is not known
3 slot.identifier.use code usual | official | temp | secondary | old (If known)
slot.identifier.type CodeableConcept Description of identifier
slot.identifier.type.coding Coding Code defined by a terminology system
4 slot.identifier.type.coding.system uri Identity of the terminology system
5 slot.identifier.type.coding.version string Version of the system - if relevant
6 slot.identifier.type.coding.code code Symbol in syntax defined by the system
7 slot.identifier.type.coding.display string Representation defined by the system
8 slot.identifier.type.coding.userSelected boolean If this coding was chosen directly by the user
9 slot.identifier.type.text string Plain text representation of the concept
10 slot.identifier.system uri The namespace for the identifier value
11 slot.identifier.value string The value that is unique
slot.identifier.period Period Time period when id is/was valid for use
12 slot.identifier.period.start dateTime Starting time with inclusive boundary
13 slot.identifier.period.end dateTime End time with inclusive boundary, if not ongoing
14 slot.display string Text alternative for the resource
Row basedOn
# path type required description
0 string * Subrow identifier. Must be string "basedOn"
basedOn Reference The service request this appointment is allocated to assess
1 basedOn.reference string Literal reference, Relative, internal or absolute URL
2 basedOn.type uri Type the reference refers to (e.g. "Patient")
basedOn.identifier Identifier Logical reference, when literal reference is not known
3 basedOn.identifier.use code usual | official | temp | secondary | old (If known)
basedOn.identifier.type CodeableConcept Description of identifier
basedOn.identifier.type.coding Coding Code defined by a terminology system
4 basedOn.identifier.type.coding.system uri Identity of the terminology system
5 basedOn.identifier.type.coding.version string Version of the system - if relevant
6 basedOn.identifier.type.coding.code code Symbol in syntax defined by the system
7 basedOn.identifier.type.coding.display string Representation defined by the system
8 basedOn.identifier.type.coding.userSelected boolean If this coding was chosen directly by the user
9 basedOn.identifier.type.text string Plain text representation of the concept
10 basedOn.identifier.system uri The namespace for the identifier value
11 basedOn.identifier.value string The value that is unique
basedOn.identifier.period Period Time period when id is/was valid for use
12 basedOn.identifier.period.start dateTime Starting time with inclusive boundary
13 basedOn.identifier.period.end dateTime End time with inclusive boundary, if not ongoing
14 basedOn.display string Text alternative for the resource
Row participant
# path type required description
0 string * Subrow identifier. Must be string "participant"
participant Participants involved in appointment
participant.type CodeableConcept Role of participant in the appointment
participant.type.coding Coding Code defined by a terminology system
1 participant.type.coding.system uri Identity of the terminology system
2 participant.type.coding.version string Version of the system - if relevant
3 participant.type.coding.code code Symbol in syntax defined by the system
4 participant.type.coding.display string Representation defined by the system
5 participant.type.coding.userSelected boolean If this coding was chosen directly by the user
6 participant.type.text string Plain text representation of the concept
participant.actor Reference Person, Location/HealthcareService or Device
7 participant.actor.reference string Literal reference, Relative, internal or absolute URL
8 participant.actor.type uri Type the reference refers to (e.g. "Patient")
participant.actor.identifier Identifier Logical reference, when literal reference is not known
9 participant.actor.identifier.use code usual | official | temp | secondary | old (If known)
participant.actor.identifier.type CodeableConcept Description of identifier
participant.actor.identifier.type.coding Coding Code defined by a terminology system
10 participant.actor.identifier.type.coding.system uri Identity of the terminology system
11 participant.actor.identifier.type.coding.version string Version of the system - if relevant
12 participant.actor.identifier.type.coding.code code Symbol in syntax defined by the system
13 participant.actor.identifier.type.coding.display string Representation defined by the system
14 participant.actor.identifier.type.coding.userSelected boolean If this coding was chosen directly by the user
15 participant.actor.identifier.type.text string Plain text representation of the concept
16 participant.actor.identifier.system uri The namespace for the identifier value
17 participant.actor.identifier.value string The value that is unique
participant.actor.identifier.period Period Time period when id is/was valid for use
18 participant.actor.identifier.period.start dateTime Starting time with inclusive boundary
19 participant.actor.identifier.period.end dateTime End time with inclusive boundary, if not ongoing
20 participant.actor.display string Text alternative for the resource
21 participant.required code required | optional | information-only
22 participant.status code accepted | declined | tentative | needs-action
participant.period Period Participation period of the actor
23 participant.period.start dateTime Starting time with inclusive boundary
24 participant.period.end dateTime End time with inclusive boundary, if not ongoing
Row requestedPeriod
# path type required description
0 string * Subrow identifier. Must be string "requestedPeriod"
requestedPeriod Period Potential date/time interval(s) requested to allocate the appointment within
1 requestedPeriod.start dateTime Starting time with inclusive boundary
2 requestedPeriod.end dateTime End time with inclusive boundary, if not ongoing

Examples

Example #1
Input CSV
Appointment,8,"2docs","booked",,,,,,,"http://terminology.hl7.org/CodeSystem/v2-0276",,"WALKIN","A previously unscheduled walk-in visit",,,5,"Discussion about Peter Chalmers MRI results","2013-12-09T09:00:00Z","2013-12-09T11:00:00Z",,,"Clarify the results of the MRI to ensure context of test was correct",
serviceCategory,"http://example.org/service-category",,"gp","General Practice",,
serviceType,,,"52","General Discussion",,
specialty,"http://snomed.info/sct",,"394814009","General practice",,
supportingInformation,"DiagnosticReport/ultrasound",,,,,,,,,,,,,
participant,,,,,,,"Patient/example",,,,,,,,,,,,,"Peter James Chalmers","information-only","accepted",,
participant,,,,,,,"Practitioner/example",,,,,,,,,,,,,"Dr Adam Careful","required","accepted",,
participant,,,,,,,"Practitioner/f202",,,,,,,,,,,,,"Luigi Maas","required","accepted",,
participant,,,,,,,,,,,,,,,,,,,,"Phone Call","information-only","accepted",,
Resulting resource
{
  "resourceType": "Appointment",
  "id": "2docs",
  "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": "WALKIN",
        "display": "A previously unscheduled walk-in visit"
      }
    ]
  },
  "priority": 5,
  "description": "Discussion about Peter Chalmers MRI results",
  "supportingInformation": [
    {
      "reference": "DiagnosticReport/ultrasound"
    }
  ],
  "start": "2013-12-09T09:00:00Z",
  "end": "2013-12-09T11:00:00Z",
  "comment": "Clarify the results of the MRI to ensure context of test was correct",
  "participant": [
    {
      "actor": {
        "reference": "Patient/example",
        "display": "Peter James Chalmers"
      },
      "required": "information-only",
      "status": "accepted"
    },
    {
      "actor": {
        "reference": "Practitioner/example",
        "display": "Dr Adam Careful"
      },
      "required": "required",
      "status": "accepted"
    },
    {
      "actor": {
        "reference": "Practitioner/f202",
        "display": "Luigi Maas"
      },
      "required": "required",
      "status": "accepted"
    },
    {
      "actor": {
        "display": "Phone Call"
      },
      "required": "information-only",
      "status": "accepted"
    }
  ]
}
Example #2
Input CSV
Appointment,8,"example","booked",,,,,,,"http://terminology.hl7.org/CodeSystem/v2-0276",,"FOLLOWUP","A follow up visit from a previous appointment",,,5,"Discussion on the results of your recent MRI","2013-12-10T09:00:00Z","2013-12-10T11:00:00Z",,"2013-10-10","Further expand on the results of the MRI and determine the next actions that may be appropriate.",
serviceCategory,"http://example.org/service-category",,"gp","General Practice",,
serviceType,,,"52","General Discussion",,
specialty,"http://snomed.info/sct",,"394814009","General practice",,
reasonReference,"Condition/example",,,,,,,,,,,,,"Severe burn of left ear"
basedOn,"ServiceRequest/myringotomy",,,,,,,,,,,,,
participant,,,,,,,"Patient/example",,,,,,,,,,,,,"Peter James Chalmers","required","accepted",,
participant,"http://terminology.hl7.org/CodeSystem/v3-ParticipationType",,"ATND",,,,"Practitioner/example",,,,,,,,,,,,,"Dr Adam Careful","required","accepted",,
participant,,,,,,,"Location/1",,,,,,,,,,,,,"South Wing, second floor","required","accepted",,
Resulting resource
{
  "resourceType": "Appointment",
  "id": "example",
  "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"
    }
  ]
}
Example #3
Input CSV
Appointment,9,"examplereq","proposed",,,,,,,"http://terminology.hl7.org/CodeSystem/v2-0276",,"WALKIN","A previously unscheduled walk-in visit",,,5,"Discussion on the results of your recent MRI",,,15,"2015-12-02","Further expand on the results of the MRI and determine the next actions that may be appropriate.",
identifier,,,,,,,,"http://example.org/sampleappointment-identifier","123",,
serviceCategory,"http://example.org/service-category",,"gp","General Practice",,
specialty,"http://snomed.info/sct",,"394814009","General practice",,
reasonCode,"http://snomed.info/sct",,"413095006",,,"Clinical Review"
slot,"Slot/example",,,,,,,,,,,,,
participant,,,,,,,"Patient/example",,,,,,,,,,,,,"Peter James Chalmers","required","needs-action",,
participant,"http://terminology.hl7.org/CodeSystem/v3-ParticipationType",,"ATND",,,,,,,,,,,,,,,,,,"required","needs-action",,
participant,,,,,,,"Location/1",,,,,,,,,,,,,"South Wing, second floor","required","accepted",,
requestedPeriod,"2016-06-02","2016-06-09"
Resulting resource
{
  "resourceType": "Appointment",
  "id": "examplereq",
  "identifier": [
    {
      "system": "http://example.org/sampleappointment-identifier",
      "value": "123"
    }
  ],
  "status": "proposed",
  "serviceCategory": [
    {
      "coding": [
        {
          "system": "http://example.org/service-category",
          "code": "gp",
          "display": "General Practice"
        }
      ]
    }
  ],
  "specialty": [
    {
      "coding": [
        {
          "system": "http://snomed.info/sct",
          "code": "394814009",
          "display": "General practice"
        }
      ]
    }
  ],
  "appointmentType": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v2-0276",
        "code": "WALKIN",
        "display": "A previously unscheduled walk-in visit"
      }
    ]
  },
  "reasonCode": [
    {
      "coding": [
        {
          "system": "http://snomed.info/sct",
          "code": "413095006"
        }
      ],
      "text": "Clinical Review"
    }
  ],
  "priority": 5,
  "description": "Discussion on the results of your recent MRI",
  "minutesDuration": 15,
  "slot": [
    {
      "reference": "Slot/example"
    }
  ],
  "created": "2015-12-02",
  "comment": "Further expand on the results of the MRI and determine the next actions that may be appropriate.",
  "participant": [
    {
      "actor": {
        "reference": "Patient/example",
        "display": "Peter James Chalmers"
      },
      "required": "required",
      "status": "needs-action"
    },
    {
      "type": [
        {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
              "code": "ATND"
            }
          ]
        }
      ],
      "required": "required",
      "status": "needs-action"
    },
    {
      "actor": {
        "reference": "Location/1",
        "display": "South Wing, second floor"
      },
      "required": "required",
      "status": "accepted"
    }
  ],
  "requestedPeriod": [
    {
      "start": "2016-06-02",
      "end": "2016-06-09"
    }
  ]
}