HDR FHIR API

GET Coverage Resource Bundle

get

/oracle-fhir-server/fhir/Coverage

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

Request

Query Parameters

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

The ID of the resource
_language(optional): string

The language of the resource
beneficiary(optional): string

Covered party
class-type(optional): string

Coverage class (eg. plan, group)
class-value(optional): string

Value of the class (eg. Plan number, group number)
dependent(optional): string

Dependent number
identifier(optional): string

The primary identifier of the insured and the coverage
patient(optional): string

Retrieve coverages for a patient
payor(optional): string

The identity of the insurer or party paying for services
policy-holder(optional): string

Reference to the policyholder
status(optional): string

The status of the Coverage
subscriber(optional): string

Reference to the subscriber
type(optional): string

The kind of coverage (health plan, auto, Workers Compensation)

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object Coverage

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

Nested Schema : Coverage

Type: object

Show Source

beneficiary: object Account_coverage
class: array class

Minimum Number of Items: 1

Unique Items Required: true
dependent: string

Minimum Length: 1
id: string

Minimum Length: 1
identifier: array identifier

Minimum Number of Items: 1

Unique Items Required: true
meta: object Account_meta
payor: array payor

Minimum Number of Items: 1

Unique Items Required: true
period: object Account_servicePeriod
policyHolder: object Account_coverage
relationship: object Claim_priority
resourceType: string

Minimum Length: 1
status: string

Minimum Length: 1
subscriber: object Account_coverage
text: object Account_text
type: object ActivityDefinition_valueCodeableConcept

{
    "type":"object",
    "required":[
        "beneficiary",
        "class",
        "dependent",
        "id",
        "identifier",
        "meta",
        "payor",
        "period",
        "policyHolder",
        "relationship",
        "resourceType",
        "status",
        "subscriber",
        "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
        },
        "type":{
            "$ref":"#/definitions/ActivityDefinition_valueCodeableConcept"
        },
        "policyHolder":{
            "$ref":"#/definitions/Account_coverage"
        },
        "subscriber":{
            "$ref":"#/definitions/Account_coverage"
        },
        "beneficiary":{
            "$ref":"#/definitions/Account_coverage"
        },
        "dependent":{
            "type":"string",
            "minLength":1
        },
        "relationship":{
            "$ref":"#/definitions/Claim_priority"
        },
        "period":{
            "$ref":"#/definitions/Account_servicePeriod"
        },
        "payor":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_coverage"
            },
            "minItems":1
        },
        "class":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Coverage_class"
            },
            "minItems":1
        },
        "meta":{
            "$ref":"#/definitions/Account_meta"
        }
    },
    "description":""
}

Nested Schema : Account_coverage

Type: object

Show Source

reference: string

Minimum Length: 1

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

Nested Schema : class

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Coverage_class

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

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_coverage

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

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 : Claim_priority

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/CapabilityStatement_interaction_1"
            },
            "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 : 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 : Coverage_class

Type: object

Show Source

name: string

Minimum Length: 1
type(optional): object Basic_code
value: string

Minimum Length: 1

{
    "required":[
        "name",
        "value"
    ],
    "properties":{
        "type":{
            "$ref":"#/definitions/Basic_code"
        },
        "value":{
            "type":"string",
            "minLength":1
        },
        "name":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : Basic_code

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/ActivityDefinition_code"
            },
            "minItems":1
        }
    }
}

Nested Schema : coding

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_code

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

Nested Schema : ActivityDefinition_code

Type: object

Show Source

code: string

Minimum Length: 1
system: string

Minimum Length: 1

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

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object CapabilityStatement_interaction_1

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

Nested Schema : CapabilityStatement_interaction_1

Type: object

Show Source

code: string

Minimum Length: 1

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