FHIR R4 APIs for Oracle Health Millennium Platform

Get a schedule by ID

get

/Schedule/{id}

Retrieves a schedule by the associated ID.

Authorization Types

This operation supports the following authorization types:

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.

Response

Supported Media Types

application/fhir+json

200 Response

Headers

X-Request-Id: string

Oracle troubleshooting identifier.
opc-request-id: string

Oracle troubleshooting identifier.

Example Response (application/fhir+json)

{
    "resourceType":"Schedule",
    "id":"24477854-21304876-62852027-0",
    "meta":{
        "versionId":"34229204v992283",
        "lastUpdated":"2020-07-06T18:46:08.000Z"
    },
    "text":{
        "status":"generated",
        "div":"<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Schedule</b></p><p><b>Status</b>: Active</p><p><b>Service Type</b>: Established Patient</p><p><b>Practitioner</b>: Cerner Test, Physician - Primary Care Cerner</p></div>"
    },
    "active":true,
    "serviceType":[
        {
            "coding":[
                {
                    "system":"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/14249",
                    "code":"24477854",
                    "display":"Established Patient",
                    "userSelected":true
                }
            ],
            "text":"Established Patient"
        }
    ],
    "actor":[
        {
            "reference":"Practitioner/593923",
            "display":"Cerner Test, Physician - Primary Care Cerner"
        }
    ]
}

Default Response

An OperationOutcome describing any error that occurred.

Headers

Etag: string

For Update or Patch versioning controls. Related to If-Match. When a resource performs an operation that creates or updates a record, an Etag value is returned as a header. This same value should be included in request headers as an If-Match for any subsequent update to that record.
X-Request-Id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the X-Request-Id, if present.
opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the opc-Request-Id, if present.

Root Schema : schema

Type: object

Show Source

issue(required): array issue
resourceType(required): string

Allowed Values: [ "OperationOutcome" ]

{
    "type":"object",
    "required":[
        "resourceType",
        "issue"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ]
        },
        "issue":{
            "type":"array",
            "items":{
                "type":"object",
                "required":[
                    "severity",
                    "code"
                ],
                "properties":{
                    "severity":{
                        "type":"string"
                    },
                    "code":{
                        "type":"string"
                    },
                    "details":{
                        "type":"object",
                        "properties":{
                            "text":{
                                "type":"string"
                            },
                            "coding":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "system":{
                                            "type":"string"
                                        },
                                        "code":{
                                            "type":"string"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "location":{
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : issue

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "required":[
            "severity",
            "code"
        ],
        "properties":{
            "severity":{
                "type":"string"
            },
            "code":{
                "type":"string"
            },
            "details":{
                "type":"object",
                "properties":{
                    "text":{
                        "type":"string"
                    },
                    "coding":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "system":{
                                    "type":"string"
                                },
                                "code":{
                                    "type":"string"
                                }
                            }
                        }
                    }
                }
            },
            "location":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

code(required): string
details: object details
location: array location
severity(required): string

{
    "type":"object",
    "required":[
        "severity",
        "code"
    ],
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "details":{
            "type":"object",
            "properties":{
                "text":{
                    "type":"string"
                },
                "coding":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "system":{
                                "type":"string"
                            },
                            "code":{
                                "type":"string"
                            }
                        }
                    }
                }
            }
        },
        "location":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : details

Type: object

Show Source

coding: array coding
text: string

{
    "type":"object",
    "properties":{
        "text":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "system":{
                        "type":"string"
                    },
                    "code":{
                        "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"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

code: string
system: string

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