FHIR R4 APIs for Oracle Health Millennium Platform

Get an account by ID

get

/Account/{id}

Retrieves an account 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":"Account",
    "id":"G2572738",
    "text":{
        "status":"generated",
        "div":"<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Account</b></p><p><b>Account Type</b>: guarantor-balance</p><p><b>Service Period Start Date</b>: Aug  5, 2019  5:00 A.M. UTC</p><p><b>Service Period End Date</b>: Aug  6, 2019  4:59 A.M. UTC</p></div>"
    },
    "extension":[
        {
            "url":"https://fhir-ehr.cerner.com/r4/StructureDefinition/account-balance",
            "valueMoney":{
                "value":"1250.00",
                "currency":"USD"
            }
        },
        {
            "valueReference":{
                "reference":"Encounter/98028029"
            },
            "url":"https://fhir-ehr.cerner.com/r4/StructureDefinition/associated-encounter"
        },
        {
            "url":"https://fhir-ehr.cerner.com/r4/StructureDefinition/account-state",
            "valueCodeableConcept":{
                "coding":[
                    {
                        "system":"https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/24451",
                        "code":"629234",
                        "display":"Ready to bill",
                        "userSelected":true
                    }
                ],
                "text":"Ready to bill"
            }
        }
    ],
    "status":"active",
    "type":{
        "text":"guarantor-balance"
    },
    "servicePeriod":{
        "start":"2019-08-05T05:00:00Z",
        "end":"2019-08-06T04:59:59Z"
    },
    "partOf":{
        "reference":"Account/F1131724"
    }
}

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