Create Appointment

• HL7 FHIR R4 Docuemnt Link

  Appointment

• HL7 HAPI FHIR Test data

  Appointment Test Data

CareSpan Required fieldsDetail fields List

Name	Field Name	Type	Value	Description	Required
Practitioner ID	participant.actor.reference	-	Practitioner/GLV5Z14OI3	Practitioner ID.	Yes
Patient MRN	participant.actor.reference/td>	-	Patient/GRTGQYSY0E	Patient MRN	Yes
Appointment start Date	Appointment.start	-	2021-07-01T01:30:00+00:00	Appointment Start Date (eg. 2021-07-01T01:30:00+00:00)	Yes
Appointment end date	Appointment.end	-	2021-07-01T02:00:00+00:00	Appointment End Date(eg. 2021-07-01T02:00:00+00:00)	Yes
Slot Practioner	participant.actor.reference	-	Practitioner/GLV5Z14OI3	Practitioner ID	Yes
Slot start Date	Slot.start	-	2021-07-01T01:30:00+00:00	Slot Start Date (same as appointment start date)	Yes
Slot end date	Slot.end	-	2021-07-01T02:00:00+00:00	Slot End Date(same as appointment end date)	Yes
Slot status	Slot.status	-	free	Only book if the current slot is free	Yes
Reason for Visit	Appointment.comment	-	eg. Head Ache	Why you are booking this appointment	Yes

Request Type

POST

Request URL

https://test-api.carespan.clinic/R4/Appointment

Request Json

        
{
    "resourceType": "Appointment",
    "start": "2022-01-26T22:30:00+00:00",
    "end": "2022-01-26T23:00:00+00:00",
    "comment": "Toothache",
    "slot": [
        {
            "schedule": {
                "resourceType": "Schedule",
                "actor": [
                    {
                        "reference": "Practitioner/{{practitioner_id}}"
                    }
                ]
            },
            "status": "free",
            "start": "2022-01-26T22:30:00+00:00",
            "end": "2022-01-26T23:00:00+00:00"
        }
    ],
    "participant": [
        {
            "actor": {
                "reference": "Practitioner/{{practitioner_id}}"
            }
        },
        {
            "actor": {
                "reference": "Patient/{{patient_mrn}}"
            }
        }
    ]
}
        
        

Response Json (success)

        
{
    "id": "f57d4ad34a4a043b54bb1621254d0117",
    "resourceType": "Appointment",
    "extension": [
        {
            "valueString": "exam-upcoming",
            "url": "https://api.carespan.clinic/fhir/StructureDefinition/valueset-appointment/status"
        },
        {
            "valueString": "https://test.carespan.clinic/login/welcome/67KQCkpOyHyky8Py",
            "url": "https://api.carespan.clinic/fhir/StructureDefinition/valueset-appointment/launch-url"
        }
    ],
    "status": "booked",
    "start": "2022-01-26T22:30:00+00:00",
    "end": "2022-01-26T23:00:00+00:00",
    "comment": "Toothache",
    "participant": [
        {
            "actor": {
                "reference": "Practitioner/G7DT9VZORM",
                "display": "Dr. Margaret Smith MD"
            }
        },
        {
            "actor": {
                "reference": "Patient/G7DT9VZMED",
                "display": "James Dunn"
            }
        }
    ]
}
        
        

Response Json (slot taken)

        
{
    "resourceType": "OperationOutcome",
    "issue": [
        {
            "severity": "warning",
            "code": "SLOT_UNAVAILABLE",
            "diagnostics": "Slot not available for 2022-01-26T22:30:00+00:00"
        }
    ]
}