Jump to

• Request
• Response

Get an appointment by ID

get

/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.

Retrieves an individual appointment by the associated ID.

Request

Path Parameters

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

Header Parameters

• 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.

There's no request body for this operation.

Back to Top

Response

200 Response

The successful retrieve response.

Body ()

Root Schema : Appointment

Type: object

The FHIR R4 Appointment resource emitted by the Oracle Health AI Application Suite implementation.

Show Source

• cancelationReason: object CodeableConcept
• comment: string
• contained: array contained
• description: string
• end: string (date-time)
• extension: array extension
• id(required): string
• meta: object meta
• minutesDuration: integer
• participant(required): array participant
• patientInstruction: string
• reasonCode: array reasonCode
• resourceType(required): string
  Allowed Values: [ "Appointment" ]
• serviceType: array serviceType
• start: string (date-time)
• status(required): string
• text: object Narrative

{
    "type":"object",
    "description":"The FHIR R4 Appointment resource emitted by the Oracle Health AI Application Suite implementation.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Appointment"
            ]
        },
        "id":{
            "type":"string"
        },
        "meta":{
            "type":"object",
            "properties":{
                "versionId":{
                    "type":"string"
                },
                "lastUpdated":{
                    "type":"string",
                    "format":"date-time"
                },
                "security":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Coding"
                    }
                }
            }
        },
        "text":{
            "$ref":"#/components/schemas/Narrative"
        },
        "contained":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContainedHealthcareServiceForAppointment"
            }
        },
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExtensionForAppointment"
            }
        },
        "status":{
            "type":"string"
        },
        "serviceType":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        },
        "reasonCode":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        },
        "cancelationReason":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "description":{
            "type":"string"
        },
        "start":{
            "type":"string",
            "format":"date-time"
        },
        "end":{
            "type":"string",
            "format":"date-time"
        },
        "minutesDuration":{
            "type":"integer"
        },
        "comment":{
            "type":"string"
        },
        "participant":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ParticipantForAppointment"
            }
        },
        "patientInstruction":{
            "type":"string"
        }
    },
    "required":[
        "resourceType",
        "id",
        "status",
        "participant"
    ]
}

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 : contained

Type: array

Show Source

• Array of: object ContainedHealthcareServiceForAppointment

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContainedHealthcareServiceForAppointment"
    }
}

Nested Schema : extension

Type: array

Show Source

• Array of: object ExtensionForAppointment

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ExtensionForAppointment"
    }
}

Nested Schema : meta

Type: object

Show Source

• lastUpdated: string (date-time)
• security: array security
• versionId: string

{
    "type":"object",
    "properties":{
        "versionId":{
            "type":"string"
        },
        "lastUpdated":{
            "type":"string",
            "format":"date-time"
        },
        "security":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            }
        }
    }
}

Nested Schema : participant

Type: array

Show Source

• Array of: object ParticipantForAppointment

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ParticipantForAppointment"
    }
}

Nested Schema : reasonCode

Type: array

Show Source

• Array of: object CodeableConcept

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CodeableConcept"
    }
}

Nested Schema : serviceType

Type: array

Show Source

• Array of: object CodeableConcept

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CodeableConcept"
    }
}

Nested Schema : Narrative

Type: object

Show Source

• div: string
  The XHTML narrative content.
• status: string
  The narrative generation status.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"The narrative generation status."
        },
        "div":{
            "type":"string",
            "description":"The XHTML narrative content."
        }
    }
}

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"
        }
    }
}

Nested Schema : ContainedHealthcareServiceForAppointment

Type: object

Show Source

• id: string
• resourceType: string
  Allowed Values: [ "HealthcareService" ]
• telecom: array telecom
• type: array type

{
    "type":"object",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "HealthcareService"
            ]
        },
        "id":{
            "type":"string"
        },
        "type":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        },
        "telecom":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContactPoint"
            }
        }
    }
}

Nested Schema : telecom

Type: array

Show Source

• Array of: object ContactPoint

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContactPoint"
    }
}

Nested Schema : type

Type: array

Show Source

• Array of: object CodeableConcept

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CodeableConcept"
    }
}

Nested Schema : ContactPoint

Type: object

Show Source

• period: object Period
• rank: integer
• system: string
  The telecommunications form.
• use: string
• value: string
  The contact value.

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string",
            "description":"The telecommunications form."
        },
        "value":{
            "type":"string",
            "description":"The contact value."
        },
        "use":{
            "type":"string"
        },
        "rank":{
            "type":"integer"
        },
        "period":{
            "$ref":"#/components/schemas/Period"
        }
    }
}

Nested Schema : Period

Type: object

Show Source

• end: string
• start: string

{
    "type":"object",
    "properties":{
        "start":{
            "type":"string"
        },
        "end":{
            "type":"string"
        }
    }
}

Nested Schema : ExtensionForAppointment

Type: object

Show Source

• url: string (uri)
• valueCodeableConcept: object CodeableConcept
• valueReference: object ReferenceForAppointment

{
    "type":"object",
    "properties":{
        "url":{
            "type":"string",
            "format":"uri"
        },
        "valueReference":{
            "$ref":"#/components/schemas/ReferenceForAppointment"
        },
        "valueCodeableConcept":{
            "$ref":"#/components/schemas/CodeableConcept"
        }
    }
}

Nested Schema : ReferenceForAppointment

Type: object

Show Source

• display: string
• reference: string

{
    "type":"object",
    "properties":{
        "reference":{
            "type":"string"
        },
        "display":{
            "type":"string"
        }
    }
}

Nested Schema : security

Type: array

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    }
}

Nested Schema : ParticipantForAppointment

Type: object

Show Source

• actor: object ReferenceForAppointment
• period: object Period
• required: string
• status: string
• type: array type

{
    "type":"object",
    "properties":{
        "type":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        },
        "actor":{
            "$ref":"#/components/schemas/ReferenceForAppointment"
        },
        "required":{
            "type":"string"
        },
        "period":{
            "$ref":"#/components/schemas/Period"
        },
        "status":{
            "type":"string"
        }
    }
}

Nested Schema : type

Type: array

Show Source

• Array of: object CodeableConcept

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CodeableConcept"
    }
}

Default Response

An OperationOutcome describing any error that occurred.

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