HDR FHIR API

GET EpisodeOfCare Resource Bundle

get

/oracle-fhir-server/fhir/EpisodeOfCare

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

Request

Query Parameters

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

The ID of the resource
_language(optional): string

The language of the resource
care-manager(optional): string

Care manager/care coordinator for the patient
condition(optional): string

Conditions/problems/diagnoses this episode of care is for
date(optional): string(date)

The provided date search value falls within the episode of care's period
identifier(optional): string

Business Identifier(s) relevant for this EpisodeOfCare
incoming-referral(optional): string

Incoming Referral Request
organization(optional): string

The organization that has assumed the specific responsibilities of this EpisodeOfCare
patient(optional): string

The patient who is the focus of this episode of care
status(optional): string

The current status of the Episode of Care as provided (does not check the status history collection)
type(optional): string

Type/class - e.g. specialist referral, disease management

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object EpisodeOfCare

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

Nested Schema : EpisodeOfCare

Type: object

Show Source

account: array account

Minimum Number of Items: 1

Unique Items Required: true
careManager: object Account_subject
diagnosis: array diagnosis

Minimum Number of Items: 1

Unique Items Required: true
id: string

Minimum Length: 1
identifier: array identifier

Minimum Number of Items: 1

Unique Items Required: true
managingOrganization: object Account_coverage
meta: object Account_meta
patient: object Account_coverage
period: object Contract_period
referralRequest: array referralRequest

Minimum Number of Items: 1

Unique Items Required: true
resourceType: string

Minimum Length: 1
status: string

Minimum Length: 1
statusHistory: array statusHistory

Minimum Number of Items: 1

Unique Items Required: true
team: array team

Minimum Number of Items: 1

Unique Items Required: true
text: object Account_text
type: array type

Minimum Number of Items: 1

Unique Items Required: true

{
    "type":"object",
    "required":[
        "account",
        "careManager",
        "diagnosis",
        "id",
        "identifier",
        "managingOrganization",
        "meta",
        "patient",
        "period",
        "referralRequest",
        "resourceType",
        "status",
        "statusHistory",
        "team",
        "text",
        "type"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "text":{
            "$ref":"#/definitions/Account_text"
        },
        "identifier":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_identifier"
            },
            "minItems":1
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "statusHistory":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/EpisodeOfCare_statusHistory"
            },
            "minItems":1
        },
        "type":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/AdverseEvent_category"
            },
            "minItems":1
        },
        "diagnosis":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/EpisodeOfCare_diagnosis"
            },
            "minItems":1
        },
        "patient":{
            "$ref":"#/definitions/Account_coverage"
        },
        "managingOrganization":{
            "$ref":"#/definitions/Account_coverage"
        },
        "period":{
            "$ref":"#/definitions/Contract_period"
        },
        "referralRequest":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/AuditEvent_source_observer"
            },
            "minItems":1
        },
        "careManager":{
            "$ref":"#/definitions/Account_subject"
        },
        "team":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_subject"
            },
            "minItems":1
        },
        "account":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_subject"
            },
            "minItems":1
        },
        "meta":{
            "$ref":"#/definitions/Account_meta"
        }
    },
    "description":""
}

Nested Schema : account

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_subject

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_subject"
    },
    "minItems":1
}

Nested Schema : Account_subject

Type: object

Show Source

display: string

Minimum Length: 1
reference: string

Minimum Length: 1

{
    "required":[
        "display",
        "reference"
    ],
    "properties":{
        "reference":{
            "type":"string",
            "minLength":1
        },
        "display":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : diagnosis

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object EpisodeOfCare_diagnosis

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/EpisodeOfCare_diagnosis"
    },
    "minItems":1
}

Nested Schema : identifier

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_identifier

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_identifier"
    },
    "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_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 : Contract_period

Type: object

Show Source

start: string

Minimum Length: 1

{
    "required":[
        "start"
    ],
    "properties":{
        "start":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : referralRequest

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object AuditEvent_source_observer

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/AuditEvent_source_observer"
    },
    "minItems":1
}

Nested Schema : statusHistory

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object EpisodeOfCare_statusHistory

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/EpisodeOfCare_statusHistory"
    },
    "minItems":1
}

Nested Schema : team

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_subject

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_subject"
    },
    "minItems":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 : type

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object AdverseEvent_category

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/AdverseEvent_category"
    },
    "minItems":1
}

Nested Schema : EpisodeOfCare_diagnosis

Type: object

Show Source

condition(optional): object Account_coverage
rank: number
role(optional): object ActivityDefinition_valueCodeableConcept

{
    "required":[
        "rank"
    ],
    "properties":{
        "condition":{
            "$ref":"#/definitions/Account_coverage"
        },
        "role":{
            "$ref":"#/definitions/ActivityDefinition_valueCodeableConcept"
        },
        "rank":{
            "type":"number"
        }
    }
}

Nested Schema : ActivityDefinition_valueCodeableConcept

Type: object

Show Source

coding: array coding

Minimum Number of Items: 1

Unique Items Required: true

{
    "required":[
        "coding"
    ],
    "properties":{
        "coding":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_type_coding"
            },
            "minItems":1
        }
    }
}

Nested Schema : coding

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
}

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_identifier

Type: object

Show Source

system: string

Minimum Length: 1
value: string

Minimum Length: 1

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

Nested Schema : AuditEvent_source_observer

Type: object

Show Source

display: string

Minimum Length: 1

{
    "required":[
        "display"
    ],
    "properties":{
        "display":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : EpisodeOfCare_statusHistory

Type: object

Show Source

period(optional): object Account_servicePeriod
status: string

Minimum Length: 1

{
    "required":[
        "status"
    ],
    "properties":{
        "status":{
            "type":"string",
            "minLength":1
        },
        "period":{
            "$ref":"#/definitions/Account_servicePeriod"
        }
    }
}

Nested Schema : Account_servicePeriod

Type: object

Show Source

end: string

Minimum Length: 1
start: string

Minimum Length: 1

{
    "required":[
        "end",
        "start"
    ],
    "properties":{
        "start":{
            "type":"string",
            "minLength":1
        },
        "end":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : AdverseEvent_category

Type: object

Show Source

coding(optional): array coding

Minimum Number of Items: 1

Unique Items Required: true

{
    "properties":{
        "coding":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_type_coding"
            },
            "minItems":1
        }
    }
}

Nested Schema : coding

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
}