Jump to

• Request
• Response

Get a schedule by ID

get

/Schedule/{id}

Retrieves an individual schedule by the associated ID.

Authorization Types

This operation supports the following authorization types:

• Patient
• Provider
• System

Request

Path Parameters

• id(required): string

  The logical resource ID.

Header Parameters

• Authorization(required): string

  Contains the credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer token.

Back to Top

Response

Supported Media Types

• application/json+fhir

200 Response

OK

Headers

• X-Request-Id: string

  Oracle troubleshooting identifier.

• opc-request-id: string

  Oracle troubleshooting identifier.

Body

Example Response (application/json+fhir)

{
    "resourceType":"Schedule",
    "id":"24477854-21304876-62852027-0",
    "text":{
        "status":"extensions",
        "div":"<div><p><b>Schedule</b></p><p><b>Type</b>: Established Patient</p><p><b>Practitioner</b>: Cerner Test, Physician - Primary Care Cerner</p><p><b>Location</b>: MX Clinic 1</p></div>"
    },
    "extension":[
        {
            "url":"https://fhir-ehr.cerner.com/dstu2/StructureDefinition/scheduling-location",
            "valueReference":{
                "reference":"Location/21304876",
                "display":"MX Clinic 1"
            }
        }
    ],
    "type":[
        {
            "text":"Established Patient"
        }
    ],
    "actor":{
        "reference":"Practitioner/593923",
        "display":"Cerner Test, Physician - Primary Care Cerner"
    }
}

Default Response

An OperationOutcome describing any error that occurred.

Headers

• X-Request-Id: string

  Oracle troubleshooting identifier.

• opc-request-id: string

  Oracle troubleshooting identifier.

Body ()

Root Schema : schema

Type: object

Show Source

• issue(required): array issue
  Minimum Number of Items: 1
• resourceType(required): string
  Allowed Values: [ "OperationOutcome" ]

{
    "type":"object",
    "required":[
        "resourceType",
        "issue"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ]
        },
        "issue":{
            "type":"array",
            "minItems":"1",
            "items":{
                "type":"object",
                "required":[
                    "severity",
                    "code"
                ],
                "properties":{
                    "severity":{
                        "type":"string",
                        "description":"<p>See the IssueSeverity definition for more information.</p>\n",
                        "enum":[
                            "fatal",
                            "error",
                            "warning",
                            "information"
                        ]
                    },
                    "code":{
                        "type":"string",
                        "description":"<p>See the IssueType definition for codes and more information.</p>\n"
                    },
                    "details":{
                        "type":"object",
                        "properties":{
                            "coding":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "system":{
                                            "type":"string"
                                        },
                                        "code":{
                                            "type":"string"
                                        },
                                        "display":{
                                            "type":"string"
                                        }
                                    }
                                }
                            },
                            "text":{
                                "type":"string"
                            }
                        }
                    },
                    "location":{
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : issue

Type: array

Minimum Number of Items: 1

Show Source

• Array of: object items

{
    "type":"array",
    "minItems":"1",
    "items":{
        "type":"object",
        "required":[
            "severity",
            "code"
        ],
        "properties":{
            "severity":{
                "type":"string",
                "description":"<p>See the IssueSeverity definition for more information.</p>\n",
                "enum":[
                    "fatal",
                    "error",
                    "warning",
                    "information"
                ]
            },
            "code":{
                "type":"string",
                "description":"<p>See the IssueType definition for codes and more information.</p>\n"
            },
            "details":{
                "type":"object",
                "properties":{
                    "coding":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "system":{
                                    "type":"string"
                                },
                                "code":{
                                    "type":"string"
                                },
                                "display":{
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "text":{
                        "type":"string"
                    }
                }
            },
            "location":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• code(required): string

  See the IssueType definition for codes and more information.

• details: object details
• location: array location
• severity(required): string
  Allowed Values: [ "fatal", "error", "warning", "information" ]

  See the IssueSeverity definition for more information.

{
    "type":"object",
    "required":[
        "severity",
        "code"
    ],
    "properties":{
        "severity":{
            "type":"string",
            "description":"<p>See the IssueSeverity definition for more information.</p>\n",
            "enum":[
                "fatal",
                "error",
                "warning",
                "information"
            ]
        },
        "code":{
            "type":"string",
            "description":"<p>See the IssueType definition for codes and more information.</p>\n"
        },
        "details":{
            "type":"object",
            "properties":{
                "coding":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "system":{
                                "type":"string"
                            },
                            "code":{
                                "type":"string"
                            },
                            "display":{
                                "type":"string"
                            }
                        }
                    }
                },
                "text":{
                    "type":"string"
                }
            }
        },
        "location":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : details

Type: object

Show Source

• coding: array coding
• text: string

{
    "type":"object",
    "properties":{
        "coding":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "system":{
                        "type":"string"
                    },
                    "code":{
                        "type":"string"
                    },
                    "display":{
                        "type":"string"
                    }
                }
            }
        },
        "text":{
            "type":"string"
        }
    }
}

Nested Schema : location

Type: array

Show Source

• Array of: string

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

Nested Schema : coding

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "system":{
                "type":"string"
            },
            "code":{
                "type":"string"
            },
            "display":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• code: string
• display: string
• system: string

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

Back to Top