HDR FHIR API

GET Encounter Resource Bundle

get

/oracle-fhir-server/fhir/Encounter

This endpoint supports the retrieval of Encounter resource list.It returns Bundle of Encounter resource.

Request

Query Parameters

_format(optional): string
_id(optional): string

The ID of the resource
_language(optional): string

The language of the resource
account(optional): string

The set of accounts that may be used for billing for this Encounter
appointment(optional): string

The appointment that scheduled this encounter
based-on(optional): string

The ServiceRequest that initiated this encounter
class(optional): string

Classification of patient encounter
date(optional): string(date)

A date within the period the Encounter lasted
diagnosis(optional): string

The diagnosis or procedure relevant to the encounter
episode-of-care(optional): string

Episode(s) of care that this encounter should be recorded against
identifier(optional): string

Identifier(s) by which this encounter is known
length(optional): integer

Length of encounter in days
location(optional): string

Location the encounter takes place
location-period(optional): string(date)

Time period during which the patient was present at the location
part-of(optional): string

Another Encounter this encounter is part of
participant(optional): string

Persons involved in the encounter other than the patient
participant-type(optional): string

Role of participant in encounter
patient(optional): string

The patient or group present at the encounter
practitioner(optional): string

Persons involved in the encounter other than the patient
reason-code(optional): string

Coded reason the encounter takes place
reason-reference(optional): string

Reason the encounter takes place (reference)
service-provider(optional): string

The organization (facility) responsible for this encounter
special-arrangement(optional): string

Wheelchair, translator, stretcher, etc.
status(optional): string

planned | arrived | triaged | in-progress | onleave | finished | cancelled +
subject(optional): string

The patient or group present at the encounter
type(optional): string

Specific type of encounter

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object Encounter

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

Nested Schema : Encounter

Type: object

Show Source

class: object Account_type_coding
id: string

Minimum Length: 1
meta: object Account_meta
resourceType: string

Minimum Length: 1
status: string

Minimum Length: 1
subject: object Account_coverage
text: object Account_text

{
    "type":"object",
    "required":[
        "class",
        "id",
        "meta",
        "resourceType",
        "status",
        "subject",
        "text"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "text":{
            "$ref":"#/definitions/Account_text"
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "class":{
            "$ref":"#/definitions/Account_type_coding"
        },
        "subject":{
            "$ref":"#/definitions/Account_coverage"
        },
        "meta":{
            "$ref":"#/definitions/Account_meta"
        }
    },
    "description":""
}

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

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_coverage

Type: object

Show Source

reference: string

Minimum Length: 1

{
    "required":[
        "reference"
    ],
    "properties":{
        "reference":{
            "type":"string",
            "minLength":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
}