Jump to

• Request
• Response

Update an appointment status

patch

/Appointment/{id}

Note: The FHIR API endpoints described below are available for customers to deploy and use. Developers are welcome and encouraged to develop against the specifications in anticipation of customer deployment.

Updates an appointment status and optionally adds a cancellation reason using a FHIRPath Patch request.

Request

Path Parameters

• id(required): string
  The logical resource ID.

Header Parameters

• If-Match(required): string
  The weak ETag in W/"version" format.
• accept(required): string

  The media type to be requested.

  Example: application/fhir+json

• authorization(required): string
  The OAuth 2.0 Bearer token used to authenticate the request.

Supported Media Types

• application/json-patch+json
• application/fhir+json

Request Body - application/json-patch+json ()

Root Schema : schema

Type: object

The FHIR parameters payload for the supported appointment status PATCH request.

Show Source

• parameter(required): array parameter
  Minimum Number of Items: 1

  Maximum Number of Items: 2
• resourceType(required): string
  Allowed Values: [ "Parameters" ]

{
    "type":"object",
    "description":"The FHIR parameters payload for the supported appointment status <code>PATCH</code> request.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Parameters"
            ]
        },
        "parameter":{
            "type":"array",
            "minItems":1,
            "maxItems":2,
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "type":"string",
                        "enum":[
                            "operation"
                        ]
                    },
                    "part":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "name":{
                                    "type":"string"
                                },
                                "valueCode":{
                                    "type":"string"
                                },
                                "valueString":{
                                    "type":"string"
                                },
                                "valueCodeableConcept":{
                                    "$ref":"#/components/schemas/CodeableConcept"
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "required":[
        "resourceType",
        "parameter"
    ]
}

Nested Schema : parameter

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 2

Show Source

• Array of: object items

{
    "type":"array",
    "minItems":1,
    "maxItems":2,
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "type":"string",
                "enum":[
                    "operation"
                ]
            },
            "part":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "name":{
                            "type":"string"
                        },
                        "valueCode":{
                            "type":"string"
                        },
                        "valueString":{
                            "type":"string"
                        },
                        "valueCodeableConcept":{
                            "$ref":"#/components/schemas/CodeableConcept"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• name: string
  Allowed Values: [ "operation" ]
• part: array part

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "enum":[
                "operation"
            ]
        },
        "part":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "type":"string"
                    },
                    "valueCode":{
                        "type":"string"
                    },
                    "valueString":{
                        "type":"string"
                    },
                    "valueCodeableConcept":{
                        "$ref":"#/components/schemas/CodeableConcept"
                    }
                }
            }
        }
    }
}

Nested Schema : part

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "type":"string"
            },
            "valueCode":{
                "type":"string"
            },
            "valueString":{
                "type":"string"
            },
            "valueCodeableConcept":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• name: string
• valueCode: string
• valueCodeableConcept: object CodeableConcept
• valueString: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "valueCode":{
            "type":"string"
        },
        "valueString":{
            "type":"string"
        },
        "valueCodeableConcept":{
            "$ref":"#/components/schemas/CodeableConcept"
        }
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Request Body - application/fhir+json ()

Root Schema : schema

Type: object

The FHIR parameters payload for the supported appointment status PATCH request.

Show Source

• parameter(required): array parameter
  Minimum Number of Items: 1

  Maximum Number of Items: 2
• resourceType(required): string
  Allowed Values: [ "Parameters" ]

{
    "type":"object",
    "description":"The FHIR parameters payload for the supported appointment status <code>PATCH</code> request.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Parameters"
            ]
        },
        "parameter":{
            "type":"array",
            "minItems":1,
            "maxItems":2,
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "type":"string",
                        "enum":[
                            "operation"
                        ]
                    },
                    "part":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "name":{
                                    "type":"string"
                                },
                                "valueCode":{
                                    "type":"string"
                                },
                                "valueString":{
                                    "type":"string"
                                },
                                "valueCodeableConcept":{
                                    "$ref":"#/components/schemas/CodeableConcept"
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "required":[
        "resourceType",
        "parameter"
    ]
}

Nested Schema : parameter

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 2

Show Source

• Array of: object items

{
    "type":"array",
    "minItems":1,
    "maxItems":2,
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "type":"string",
                "enum":[
                    "operation"
                ]
            },
            "part":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "name":{
                            "type":"string"
                        },
                        "valueCode":{
                            "type":"string"
                        },
                        "valueString":{
                            "type":"string"
                        },
                        "valueCodeableConcept":{
                            "$ref":"#/components/schemas/CodeableConcept"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• name: string
  Allowed Values: [ "operation" ]
• part: array part

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "enum":[
                "operation"
            ]
        },
        "part":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "type":"string"
                    },
                    "valueCode":{
                        "type":"string"
                    },
                    "valueString":{
                        "type":"string"
                    },
                    "valueCodeableConcept":{
                        "$ref":"#/components/schemas/CodeableConcept"
                    }
                }
            }
        }
    }
}

Nested Schema : part

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "type":"string"
            },
            "valueCode":{
                "type":"string"
            },
            "valueString":{
                "type":"string"
            },
            "valueCodeableConcept":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• name: string
• valueCode: string
• valueCodeableConcept: object CodeableConcept
• valueString: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "valueCode":{
            "type":"string"
        },
        "valueString":{
            "type":"string"
        },
        "valueCodeableConcept":{
            "$ref":"#/components/schemas/CodeableConcept"
        }
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/fhir+json
• application/json

200 Response

The appointment update is accepted; the current implementation returns an empty JSON object.

Body ()

Root Schema : EmptyResponseForAppointment

Type: object

400 Response

The FHIR OperationOutcome.

Body ()

Root Schema : OperationOutcome

Type: object

The FHIR OperationOutcome.

Show Source

• issue: array issue
  The OperationOutcome issues.
• resourceType: string
  Allowed Values: [ "OperationOutcome" ]

  The FHIR resource type.

{
    "type":"object",
    "description":"The FHIR OperationOutcome.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ],
            "description":"The FHIR resource type."
        },
        "issue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OperationOutcomeIssue"
            },
            "description":"The OperationOutcome issues."
        }
    }
}

Nested Schema : issue

Type: array

The OperationOutcome issues.

Show Source

• Array of: object OperationOutcomeIssue

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OperationOutcomeIssue"
    },
    "description":"The OperationOutcome issues."
}

Nested Schema : OperationOutcomeIssue

Type: object

Show Source

• code: string
• details: object CodeableConcept
• diagnostics: string
• expression: array expression
• severity: string

{
    "type":"object",
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "details":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "diagnostics":{
            "type":"string"
        },
        "expression":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : expression

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

412 Response

The FHIR OperationOutcome for an invalid or missing If-Match.

Body ()

Root Schema : OperationOutcome

Type: object

The FHIR OperationOutcome.

Show Source

• issue: array issue
  The OperationOutcome issues.
• resourceType: string
  Allowed Values: [ "OperationOutcome" ]

  The FHIR resource type.

{
    "type":"object",
    "description":"The FHIR OperationOutcome.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ],
            "description":"The FHIR resource type."
        },
        "issue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OperationOutcomeIssue"
            },
            "description":"The OperationOutcome issues."
        }
    }
}

Nested Schema : issue

Type: array

The OperationOutcome issues.

Show Source

• Array of: object OperationOutcomeIssue

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OperationOutcomeIssue"
    },
    "description":"The OperationOutcome issues."
}

Nested Schema : OperationOutcomeIssue

Type: object

Show Source

• code: string
• details: object CodeableConcept
• diagnostics: string
• expression: array expression
• severity: string

{
    "type":"object",
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "details":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "diagnostics":{
            "type":"string"
        },
        "expression":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : expression

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

500 Response

The FHIR OperationOutcome.

Body ()

Root Schema : OperationOutcome

Type: object

The FHIR OperationOutcome.

Show Source

• issue: array issue
  The OperationOutcome issues.
• resourceType: string
  Allowed Values: [ "OperationOutcome" ]

  The FHIR resource type.

{
    "type":"object",
    "description":"The FHIR OperationOutcome.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ],
            "description":"The FHIR resource type."
        },
        "issue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OperationOutcomeIssue"
            },
            "description":"The OperationOutcome issues."
        }
    }
}

Nested Schema : issue

Type: array

The OperationOutcome issues.

Show Source

• Array of: object OperationOutcomeIssue

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OperationOutcomeIssue"
    },
    "description":"The OperationOutcome issues."
}

Nested Schema : OperationOutcomeIssue

Type: object

Show Source

• code: string
• details: object CodeableConcept
• diagnostics: string
• expression: array expression
• severity: string

{
    "type":"object",
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "details":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "diagnostics":{
            "type":"string"
        },
        "expression":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : expression

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Back to Top