Update 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
User ID	participant.actor.reference	-	Patient/GI7E0ATLD0	The person who is making the update	Yes
Appointment Status	Appointment.status	-	-	arrived | fulfilled | cancelled	Yes
cancelation Reason	Appointment.cancelationReason	-	-	Appointment Cancelation Reason (if status is cancelled	Yes

Request Type

PUT

Request URL

https://test-api.carespan.clinic/R4/Appointment/{{appointment_id}}

Request Json (To Cancel)

        
{
    "id": "{{appointment_id}}",
    "resourceType": "Appointment",
    "status": "cancelled",
    "cancelationReason": {
        "text": "Reason to cancel"
    },
    "participant": [
        {
            "actor": {
                "reference": "Patient/{{patient_mrn}}"
            }
        }
    ]
}
        
        

Request Json (Patient arrived)

        
{
    "id": "{{appointment_id}}",
    "resourceType": "Appointment",
    "status": "arrived",
    "participant": [
        {
            "actor": {
                "reference": "Patient/{{patient_mrn}}"
            }
        }
    ]
}
        
        

Request Json (Patient left)

        
{
    "id": "{{appointment_id}}",
    "resourceType": "Appointment",
    "status": "fulfilled",
    "participant": [
        {
            "actor": {
                "reference": "Patient/{{patient_mrn}}"
            }
        }
    ]
}
        
        

Response Json

        
{
    "id": "7a30cd8c807a93c9e0f37e78c5f0172c",
    "resourceType": "Appointment",
    "extension": [
        {
            "valueString": "exam-canceled",
            "url": "https://api.carespan.clinic/fhir/StructureDefinition/valueset-appointment/status"
        },
        {
            "valueString": "https://test.carespan.clinic/login/welcome/S4fhHJFGp427a30f",
            "url": "https://api.carespan.clinic/fhir/StructureDefinition/valueset-appointment/launch-url"
        },
        {
            "valueString": "47044254",
            "url": "https://www.carespan.clinic/fhir/StructureDefinition/valueset-appointment/opentok/api-key"
        },
        {
            "valueString": "2_MX40NzA0NDI1NH5-MTY0MzA0ODIzODk3Nn5CQUtkTjUrTUNWWGNSOVo0WHhsak9DSGZ-fg",
            "url": "https://www.carespan.clinic/fhir/StructureDefinition/valueset-appointment/opentok/session-id"
        },
        {
            "valueString": "T1==cGFydG5lcl9pZD00NzA0NDI1NCZzaWc9M2Y0ZDU4NGQ3NWZlYTUxYzc5NzZiNjhiMDQxOTViODAzZWUzMjI3MjpzZXNzaW9uX2lkPTJfTVg0ME56QTBOREkxTkg1LU1UWTBNekEwT0RJek9EazNObjVDUVV0a1RqVXJUVU5XV0dOU09WbzBXSGhzYWs5RFNHWi1mZyZjcmVhdGVfdGltZT0xNjQzMDQ4MjM5JnJvbGU9bW9kZXJhdG9yJm5vbmNlPTE2NDMwNDgyMzkuMTkwNDI4NDM3MTYxOSZleHBpcmVfdGltZT0xNjQzMDY5ODM5JmNvbm5lY3Rpb25fZGF0YT0lN0IlMjJVc2VySWQlMjIlM0ElMjIyJTIyJTJDJTIyVXNlck5hbWUlMjIlM0ElMjJKYW1lcytEdW5uJTIyJTJDJTIyaWQlMjIlM0ElMjIyJTIyJTJDJTIyZGlzcGxheW5hbWUlMjIlM0ElMjJKYW1lcytEdW5uJTIyJTJDJTIycGVybWlzc2lvbiUyMiUzQSUyMnBhdGllbnQlMjIlMkMlMjJwZXJtaXNzaW9uSWQlMjIlM0ElMjIxJTIyJTdEJmluaXRpYWxfbGF5b3V0X2NsYXNzX2xpc3Q9",
            "url": "https://www.carespan.clinic/fhir/StructureDefinition/valueset-appointment/opentok/token"
        }
    ],
    "status": "cancelled",
    "start": "2022-01-24T18:00:00+00:00",
    "end": "2022-01-24T18:15:00+00:00",
    "comment": "Toothache",
    "participant": [
        {
            "actor": {
                "reference": "Practitioner/G7DT9VZORM",
                "display": "Dr. Margaret Smith MD"
            }
        },
        {
            "actor": {
                "reference": "Patient/G7DT9VZMED",
                "display": "James Dunn"
            }
        }
    ]
}