Appointments Export (FHIR)

event

The event represents the type of transaction that occurred in the system for this information to be saved.

basedOn_0_serviceRequestId

The CIE Hub Service Request ID. This is the ID that is passed from the Hub when the referral is initially created. This will connect the appointment with the corresponding referral.

created

Date/time the appointment was created in the system.

description

A description of the appointment

start

The start date and time of the scheduled appointment.

end

The end date and time of the scheduled appointment.

id

The unique id for the appointment

identifier_0_system

The identifier section represents the system of record’s id for this appointment.

identifier_0_type_text

This is the text of the identifier that is used. So it could be appointmentId.

identifier_0_use

This is the usually always official.

identifier_0_value

The value of the identifier

participant_0_actor_patientId

This is the patientId of the person that the appointment was made for.

participant_1_actor_display

This is the name of the location that the appointment was made at.

participant_1_type_0_coding_0_code

This is the code that identifies the type of participant one. In this case it will be LOCATION

serviceCategory_0_coding_0_code

Classification or metadata code associated with the appointment using a coding system.

serviceCategory_0_coding_0_display

Classification or metadata associated with the appointment using a coding system. This represents the human readable text.

serviceCategory_0_coding_0_system

Classification or metadata associated with the appointment using a coding system. This represents the system of the code. (for example, LOINC or Gravity)

serviceType_0_coding_0_code

Identification of the appointment that was given to the patient using a coding system. This represents the code. For example, a Gravity intervention code such as I-113, Provision of Food Voucher.

serviceType_0_coding_0_display

Identification of the appointment that was given to the patient using a coding system. This represents the human readable display of that code.

serviceType_0_coding_0_system

Identification of the appointment that was given to the patient using a coding system. This represents the system of the code. (for example, LOINC or Gravity)

status

This is the status of the appointment. The available values can be found here Appointment - FHIR v6.0.0-ballot2

servicerequest_identifiers_intake_id

It can be passed with client's "Referral ID" to link up their Referral ID to the CIE Hub.  The advantage to this is that the client may want this on their reporting side to easily match up the referrals and person’s to resources that are generated in the CIE Hub.

patient_identifiers_clientid

This is the patient's client id that was supplied in the patient identifiers field when the service request for the appointment was made.

patient_name_given

The given name of the patient.

patient_name_family

The family name of the patient.

patient_name_middle

The middle name of the patient

patient_gender

The gender of the patient

patient_mobile_phone

The mobile phone of the patient

patient_home_phone

The home phone number of the patient

patient_email

The email of the patient

patient_sms

The mobile phone number for texting with the patient

patient_address_x_line_0*

The address of the patient and the first line of the address. This is an array which has been flattened. So if there are more then one then it will have a address_1 and so on.

patient_address_x_line_1*

The address of the patient and the second line of the address. This is an array which has been flattened. So if there are more then one then it will have a address_1 and so on.

patient_address_x_city*

The city of the patient. This is an array which has been flattened. So if there are more then one then it will have a address_1 and so on.

patient_address_x_state*

The state of the patient. This is an array which has been flattened. So if there are more then one then it will have a address_1 and so on.

patient_address_x_postalcode*

The postal code of the patient. This is an array which has been flatten. So if there are more then one then it will have a address_1 and so on.

patient_birthDate

The birth date of the patient