FHIR DSTU 2 APIs for Oracle Health Millennium Platform

Create an appointment

post

/Appointment/

Creates an appointment.

Note:

The modifier elements implicitRules and modifierExtension are not supported and are rejected if present.
Scheduling examples are time sensitive and require a slot with a status of free.

Authorization Types

This resource supports the following authorization types:

Provider
System

Request

Supported Media Types

application/json+fhir

Header Parameters

Authorization(required): string

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

Root Schema : AppointmentCreateBody

Type: object

Show Source

comment: string

Additional text to aid in facilitating the appointment.

Example: Further explain MRI results
participant(required): array participant

Minimum Number of Items: 1

Maximum Number of Items: 1

Participants involved in the appointment.

Note: The participant.type must not be set.
resourceType(required): string

Allowed Values: [ "Appointment" ]

The type of the FHIR resource.
slot(required): array slot

Minimum Number of Items: 1

Maximum Number of Items: 1

The availability to which the appointment is booked.
status(required): string

Allowed Values: [ "proposed" ]

A code representing the overall status of the appointment.

{
    "type":"object",
    "required":[
        "resourceType",
        "slot",
        "status",
        "participant"
    ],
    "properties":{
        "resourceType":{
            "description":"<p>The type of the FHIR resource.</p>\n",
            "type":"string",
            "enum":[
                "Appointment"
            ]
        },
        "slot":{
            "description":"<p>The availability to which the appointment is booked.</p>\n",
            "type":"array",
            "minItems":"1",
            "maxItems":"1",
            "items":{
                "type":"object",
                "properties":{
                    "reference":{
                        "type":"string",
                        "example":"Slot/21265426-633867-6828001-60"
                    }
                }
            }
        },
        "status":{
            "description":"<p>A code representing the overall status of the appointment.</p>\n",
            "type":"string",
            "enum":[
                "proposed"
            ]
        },
        "participant":{
            "description":"<p>Participants involved in the appointment.</p>\n<p><b>Note:</b> The <code>participant.type</code> must not be set.</p>\n",
            "type":"array",
            "minItems":"1",
            "maxItems":"1",
            "items":{
                "type":"object",
                "required":[
                    "actor",
                    "status"
                ],
                "properties":{
                    "actor":{
                        "description":"<p>The patient that is participating in the appointment.</p>",
                        "type":"object",
                        "properties":{
                            "reference":{
                                "type":"string",
                                "example":"Patient/4704007"
                            },
                            "display":{
                                "type":"string",
                                "example":"Smart, Barney R"
                            }
                        }
                    },
                    "status":{
                        "type":"string",
                        "enum":[
                            "needs-action"
                        ]
                    }
                }
            }
        },
        "comment":{
            "description":"<p>Additional text to aid in facilitating the appointment.</p>",
            "type":"string",
            "example":"Further explain MRI results"
        }
    },
    "example":{
        "resourceType":"Appointment",
        "slot":[
            {
                "reference":"Slot/24477854-21304876-62852027-0"
            }
        ],
        "status":"proposed",
        "participant":[
            {
                "actor":{
                    "reference":"Patient/12724066"
                },
                "status":"needs-action"
            }
        ]
    }
}

Example:

{
    "resourceType":"Appointment",
    "slot":[
        {
            "reference":"Slot/24477854-21304876-62852027-0"
        }
    ],
    "status":"proposed",
    "participant":[
        {
            "actor":{
                "reference":"Patient/12724066"
            },
            "status":"needs-action"
        }
    ]
}

Nested Schema : participant

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 1

Participants involved in the appointment.

Note: The participant.type must not be set.

Show Source

Array of: object items

{
    "description":"<p>Participants involved in the appointment.</p>\n<p><b>Note:</b> The <code>participant.type</code> must not be set.</p>\n",
    "type":"array",
    "minItems":"1",
    "maxItems":"1",
    "items":{
        "type":"object",
        "required":[
            "actor",
            "status"
        ],
        "properties":{
            "actor":{
                "description":"<p>The patient that is participating in the appointment.</p>",
                "type":"object",
                "properties":{
                    "reference":{
                        "type":"string",
                        "example":"Patient/4704007"
                    },
                    "display":{
                        "type":"string",
                        "example":"Smart, Barney R"
                    }
                }
            },
            "status":{
                "type":"string",
                "enum":[
                    "needs-action"
                ]
            }
        }
    }
}

Nested Schema : slot

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 1

The availability to which the appointment is booked.

Show Source

Array of: object items

{
    "description":"<p>The availability to which the appointment is booked.</p>\n",
    "type":"array",
    "minItems":"1",
    "maxItems":"1",
    "items":{
        "type":"object",
        "properties":{
            "reference":{
                "type":"string",
                "example":"Slot/21265426-633867-6828001-60"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

actor(required): object actor

The patient that is participating in the appointment.
status(required): string

Allowed Values: [ "needs-action" ]

{
    "type":"object",
    "required":[
        "actor",
        "status"
    ],
    "properties":{
        "actor":{
            "description":"<p>The patient that is participating in the appointment.</p>",
            "type":"object",
            "properties":{
                "reference":{
                    "type":"string",
                    "example":"Patient/4704007"
                },
                "display":{
                    "type":"string",
                    "example":"Smart, Barney R"
                }
            }
        },
        "status":{
            "type":"string",
            "enum":[
                "needs-action"
            ]
        }
    }
}

Nested Schema : actor

Type: object

The patient that is participating in the appointment.

Show Source

display: string

Example: Smart, Barney R
reference: string

Example: Patient/4704007

{
    "description":"<p>The patient that is participating in the appointment.</p>",
    "type":"object",
    "properties":{
        "reference":{
            "type":"string",
            "example":"Patient/4704007"
        },
        "display":{
            "type":"string",
            "example":"Smart, Barney R"
        }
    }
}

Nested Schema : items

Type: object

Show Source

reference: string

Example: Slot/21265426-633867-6828001-60

{
    "type":"object",
    "properties":{
        "reference":{
            "type":"string",
            "example":"Slot/21265426-633867-6828001-60"
        }
    }
}

Response

Supported Media Types

application/json+fhir

201 Response

Created

Headers

ETag: string

The identifier for a specific version of a resource. This identifier is formatted as W/"" and used to specify the If-Match header value on subsequent updates.
Location: string

The URL location of the created entity.

Example: https://fhir-ehr-code.cerner.com/dstu2/ec2458f2-1e24-41c8-b71b-0e701af7583d/Appointment/6427746
X-Request-Id: string

Oracle troubleshooting identifier.
opc-request-id: string

Oracle troubleshooting identifier.

Default Response

An OperationOutcome describing any error that occurred.

Headers

X-Request-Id: string

Oracle troubleshooting identifier.
opc-request-id: string

Oracle troubleshooting identifier.

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