HDR FHIR API

GET Appointment Resource Bundle

get

/oracle-fhir-server/fhir/Appointment

This endpoint supports the retrieval of Appointment resource list.It returns Bundle of Appointment resource.

Request

Query Parameters

_format(optional): string
_id(optional): string

The ID of the resource
_language(optional): string

The language of the resource
actor(optional): string

Any one of the individuals participating in the appointment
appointment-type(optional): string

The style of appointment or patient that has been booked in the slot (not service type)
based-on(optional): string

The service request this appointment is allocated to assess
date(optional): string(date)

Appointment date/time.
identifier(optional): string

An Identifier of the Appointment
location(optional): string

This location is listed in the participants of the appointment
part-status(optional): string

The Participation status of the subject, or other participant on the appointment. Can be used to locate participants that have not responded to meeting requests.
patient(optional): string

One of the individuals of the appointment is this patient
practitioner(optional): string

One of the individuals of the appointment is this practitioner
reason-code(optional): string

Coded reason this appointment is scheduled
reason-reference(optional): string

Reason the appointment is to take place (resource)
service-category(optional): string

A broad categorization of the service that is to be performed during this appointment
service-type(optional): string

The specific service that is to be performed during this appointment
slot(optional): string

The slots that this appointment is filling
specialty(optional): string

The specialty of a practitioner that would be required to perform the service requested in this appointment
status(optional): string

The overall status of the appointment
supporting-info(optional): string

Additional information to support the appointment

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object Appointment

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Appointment"
    }
}

Nested Schema : Appointment

Type: object

Show Source

appointmentType: object ActivityDefinition_valueCodeableConcept
basedOn: array basedOn

Minimum Number of Items: 1

Unique Items Required: true
comment: string

Minimum Length: 1
created: string

Minimum Length: 1
description: string

Minimum Length: 1
end: string

Minimum Length: 1
id: string

Minimum Length: 1
meta: object Account_meta
participant: array participant

Minimum Number of Items: 1

Unique Items Required: true
priority: number
reasonReference: array reasonReference

Minimum Number of Items: 1

Unique Items Required: true
resourceType: string

Minimum Length: 1
serviceCategory: array serviceCategory

Minimum Number of Items: 1

Unique Items Required: true
serviceType: array serviceType

Minimum Number of Items: 1

Unique Items Required: true
specialty: array specialty

Minimum Number of Items: 1

Unique Items Required: true
start: string

Minimum Length: 1
status: string

Minimum Length: 1
text: object Account_text

{
    "type":"object",
    "required":[
        "appointmentType",
        "basedOn",
        "comment",
        "created",
        "description",
        "end",
        "id",
        "meta",
        "participant",
        "priority",
        "reasonReference",
        "resourceType",
        "serviceCategory",
        "serviceType",
        "specialty",
        "start",
        "status",
        "text"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "text":{
            "$ref":"#/definitions/Account_text"
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "serviceCategory":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/AdverseEvent_category"
            },
            "minItems":1
        },
        "serviceType":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Appointment_serviceType"
            },
            "minItems":1
        },
        "specialty":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/AdverseEvent_category"
            },
            "minItems":1
        },
        "appointmentType":{
            "$ref":"#/definitions/ActivityDefinition_valueCodeableConcept"
        },
        "reasonReference":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_subject"
            },
            "minItems":1
        },
        "priority":{
            "type":"number"
        },
        "description":{
            "type":"string",
            "minLength":1
        },
        "start":{
            "type":"string",
            "minLength":1
        },
        "end":{
            "type":"string",
            "minLength":1
        },
        "created":{
            "type":"string",
            "minLength":1
        },
        "comment":{
            "type":"string",
            "minLength":1
        },
        "basedOn":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_coverage"
            },
            "minItems":1
        },
        "participant":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Appointment_participant"
            },
            "minItems":1
        },
        "meta":{
            "$ref":"#/definitions/Account_meta"
        }
    },
    "description":""
}

Nested Schema : ActivityDefinition_valueCodeableConcept

Type: object

Show Source

coding: array coding

Minimum Number of Items: 1

Unique Items Required: true

{
    "required":[
        "coding"
    ],
    "properties":{
        "coding":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_type_coding"
            },
            "minItems":1
        }
    }
}

Nested Schema : basedOn

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_coverage

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_coverage"
    },
    "minItems":1
}

Nested Schema : Account_meta

Type: object

Show Source

tag: array tag

Minimum Number of Items: 1

Unique Items Required: true

{
    "required":[
        "tag"
    ],
    "properties":{
        "tag":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_type_coding"
            },
            "minItems":1
        }
    }
}

Nested Schema : participant

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Appointment_participant

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Appointment_participant"
    },
    "minItems":1
}

Nested Schema : reasonReference

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_subject

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_subject"
    },
    "minItems":1
}

Nested Schema : serviceCategory

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object AdverseEvent_category

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/AdverseEvent_category"
    },
    "minItems":1
}

Nested Schema : serviceType

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Appointment_serviceType

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Appointment_serviceType"
    },
    "minItems":1
}

Nested Schema : specialty

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object AdverseEvent_category

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/AdverseEvent_category"
    },
    "minItems":1
}

Nested Schema : Account_text

Type: object

Show Source

div: string

Minimum Length: 1
status: string

Minimum Length: 1

{
    "required":[
        "div",
        "status"
    ],
    "properties":{
        "status":{
            "type":"string",
            "minLength":1
        },
        "div":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : coding

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_type_coding

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_type_coding"
    },
    "minItems":1
}

Nested Schema : Account_type_coding

Type: object

Show Source

code: string

Minimum Length: 1
display: string

Minimum Length: 1
system: string

Minimum Length: 1

{
    "required":[
        "code",
        "display",
        "system"
    ],
    "properties":{
        "system":{
            "type":"string",
            "minLength":1
        },
        "code":{
            "type":"string",
            "minLength":1
        },
        "display":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : Account_coverage

Type: object

Show Source

reference: string

Minimum Length: 1

{
    "required":[
        "reference"
    ],
    "properties":{
        "reference":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : tag

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_type_coding

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_type_coding"
    },
    "minItems":1
}

Nested Schema : Appointment_participant

Type: object

Show Source

actor(optional): object Account_subject
required: string

Minimum Length: 1
status: string

Minimum Length: 1
type(optional): array type

Minimum Number of Items: 1

Unique Items Required: true

{
    "required":[
        "required",
        "status"
    ],
    "properties":{
        "type":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_jurisdiction"
            },
            "minItems":1
        },
        "actor":{
            "$ref":"#/definitions/Account_subject"
        },
        "required":{
            "type":"string",
            "minLength":1
        },
        "status":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : Account_subject

Type: object

Show Source

display: string

Minimum Length: 1
reference: string

Minimum Length: 1

{
    "required":[
        "display",
        "reference"
    ],
    "properties":{
        "reference":{
            "type":"string",
            "minLength":1
        },
        "display":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : type

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_jurisdiction

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ActivityDefinition_jurisdiction"
    },
    "minItems":1
}

Nested Schema : ActivityDefinition_jurisdiction

Type: object

Show Source

coding(optional): array coding

Minimum Number of Items: 1

Unique Items Required: true

{
    "properties":{
        "coding":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_code"
            },
            "minItems":1
        }
    }
}

Nested Schema : coding

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_code

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ActivityDefinition_code"
    },
    "minItems":1
}

Nested Schema : ActivityDefinition_code

Type: object

Show Source

code: string

Minimum Length: 1
system: string

Minimum Length: 1

{
    "required":[
        "code",
        "system"
    ],
    "properties":{
        "system":{
            "type":"string",
            "minLength":1
        },
        "code":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : AdverseEvent_category

Type: object

Show Source

coding(optional): array coding

Minimum Number of Items: 1

Unique Items Required: true

{
    "properties":{
        "coding":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_type_coding"
            },
            "minItems":1
        }
    }
}

Nested Schema : coding

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_type_coding

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_type_coding"
    },
    "minItems":1
}

Nested Schema : Appointment_serviceType

Type: object

Show Source

coding(optional): array coding

Minimum Number of Items: 1

Unique Items Required: true

{
    "properties":{
        "coding":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Appointment_coding"
            },
            "minItems":1
        }
    }
}

Nested Schema : coding

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Appointment_coding

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Appointment_coding"
    },
    "minItems":1
}

Nested Schema : Appointment_coding

Type: object

Show Source

code: string

Minimum Length: 1
display: string

Minimum Length: 1

{
    "required":[
        "code",
        "display"
    ],
    "properties":{
        "code":{
            "type":"string",
            "minLength":1
        },
        "display":{
            "type":"string",
            "minLength":1
        }
    }
}