HDR FHIR API

GET AppointmentResponse Resource Bundle

get

/oracle-fhir-server/fhir/AppointmentResponse

This endpoint supports the retrieval of AppointmentResponse resource list.It returns Bundle of AppointmentResponse 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

The Person, Location/HealthcareService or Device that this appointment response replies for
appointment(optional): string

The appointment that the response is attached to
identifier(optional): string

An Identifier in this appointment response
location(optional): string

This Response is for this Location
part-status(optional): string

The participants acceptance status for this appointment
patient(optional): string

This Response is for this Patient
practitioner(optional): string

This Response is for this Practitioner

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object AppointmentResponse

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

Nested Schema : AppointmentResponse

Type: object

Show Source

actor: object Account_subject
appointment: object Account_subject
id: string

Minimum Length: 1
meta: object Account_meta
participantStatus: string

Minimum Length: 1
resourceType: string

Minimum Length: 1
text: object Account_text

{
    "type":"object",
    "required":[
        "actor",
        "appointment",
        "id",
        "meta",
        "participantStatus",
        "resourceType",
        "text"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "text":{
            "$ref":"#/definitions/Account_text"
        },
        "appointment":{
            "$ref":"#/definitions/Account_subject"
        },
        "actor":{
            "$ref":"#/definitions/Account_subject"
        },
        "participantStatus":{
            "type":"string",
            "minLength":1
        },
        "meta":{
            "$ref":"#/definitions/Account_meta"
        }
    },
    "description":""
}

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