Jump to

• Request
• Response

Get a list of coverages

get

/Coverage

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

Retrieves a list of coverages that meet the supplied query parameters.

Request

Query Parameters

• _id: string
  The logical resource ID.
• _revinclude: string
  The related Provenance resources to include in the search bundle.

  Allowed Values: [ "Provenance:target" ]
• patient: string
  The covered party.

Header Parameters

• accept(required): string

  The media type to be requested.

  Example: application/fhir+json

• authorization(required): string
  The credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer Token.

There's no request body for this operation.

Back to Top

Response

200 Response

Successful search response.

Body ()

Root Schema : schema

Type: object

Show Source

• entry: array entry
• id(required): string
• link: array link
• resourceType(required): string
  Allowed Values: [ "Bundle" ]
• type(required): string

{
    "type":"object",
    "required":[
        "resourceType",
        "id",
        "type"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Bundle"
            ]
        },
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "link":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BundleLink"
            }
        },
        "entry":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "fullUrl":{
                        "type":"string",
                        "format":"uri"
                    },
                    "resource":{
                        "$ref":"#/components/schemas/Coverage"
                    },
                    "search":{
                        "$ref":"#/components/schemas/Search"
                    }
                }
            }
        }
    }
}

Nested Schema : entry

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "fullUrl":{
                "type":"string",
                "format":"uri"
            },
            "resource":{
                "$ref":"#/components/schemas/Coverage"
            },
            "search":{
                "$ref":"#/components/schemas/Search"
            }
        }
    }
}

Nested Schema : link

Type: array

Show Source

• Array of: object BundleLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/BundleLink"
    }
}

Nested Schema : items

Type: object

Show Source

• fullUrl: string (uri)
• resource: object Coverage
• search: object Search

{
    "type":"object",
    "properties":{
        "fullUrl":{
            "type":"string",
            "format":"uri"
        },
        "resource":{
            "$ref":"#/components/schemas/Coverage"
        },
        "search":{
            "$ref":"#/components/schemas/Search"
        }
    }
}

Nested Schema : Coverage

Type: object

Show Source

• beneficiary(required): beneficiary
  (USCDI) The plan beneficiary.
• class: array class

  (USCDI) The additional coverage classifications.

  • Entries can represent group-level or plan-level classification details.
  • For group classification, type coding may indicate group.
  • For plan classification, type coding may indicate plan.
• id(required): string
• identifier: array identifier
  (USCDI) The member ID and other identifiers.
• payor(required): array payor
  (USCDI) The issuer of the policy.
• period: period
  (USCDI) The coverage start and end dates.
• relationship(required): relationship
  (USCDI) The beneficiary's relationship to the subscriber.
• resourceType(required): string
  Allowed Values: [ "Coverage" ]
• status(required): string
  (USCDI) The following values are supported:

  • active
  • cancelled
  • draft
  • entered-in-error
• subscriberId: string
  (USCDI) The ID assigned to the subscriber.
• type: type
  (USCDI) The coverage category such as medical or accident.

{
    "type":"object",
    "required":[
        "resourceType",
        "id",
        "status",
        "beneficiary",
        "relationship",
        "payor"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Coverage"
            ]
        },
        "id":{
            "type":"string"
        },
        "identifier":{
            "type":"array",
            "description":"(USCDI) The member ID and other identifiers.",
            "items":{
                "oneOf":[
                    {
                        "$ref":"#/components/schemas/Identifier"
                    },
                    {
                        "$ref":"#/components/schemas/MemberId"
                    }
                ]
            }
        },
        "status":{
            "type":"string",
            "description":"(USCDI) The following values are supported: \n<ul>\n  <li><code>active</code></li>\n  <li><code>cancelled</code></li>\n  <li><code>draft</code></li>\n  <li><code>entered-in-error</code></li>\n</ul>\n"
        },
        "type":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/CodeableConcept"
                }
            ],
            "description":"(USCDI) The coverage category such as medical or accident."
        },
        "subscriberId":{
            "type":"string",
            "description":"(USCDI) The ID assigned to the subscriber."
        },
        "beneficiary":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Reference"
                }
            ],
            "description":"(USCDI) The plan beneficiary."
        },
        "relationship":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/CodeableConcept"
                }
            ],
            "description":"(USCDI) The beneficiary's relationship to the subscriber."
        },
        "period":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Period"
                }
            ],
            "description":"(USCDI) The coverage start and end dates."
        },
        "payor":{
            "type":"array",
            "description":"(USCDI) The issuer of the policy.",
            "items":{
                "$ref":"#/components/schemas/Reference"
            }
        },
        "class":{
            "type":"array",
            "description":"<p>(USCDI) The additional coverage classifications.</p>\n<ul>\n  <li>Entries can represent group-level or plan-level classification details.</li>\n  <li>For group classification, type coding may indicate <code>group</code>.</li>\n  <li>For plan classification, type coding may indicate <code>plan</code>.</li>\n</ul>\n",
            "items":{
                "$ref":"#/components/schemas/CoverageClass"
            }
        }
    }
}

Nested Schema : Search

Type: object

Show Source

• mode: string

{
    "type":"object",
    "properties":{
        "mode":{
            "type":"string"
        }
    }
}

Nested Schema : beneficiary

(USCDI) The plan beneficiary.

Match All

(USCDI) The plan beneficiary.

Show Source

• object Reference

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Reference"
        }
    ],
    "description":"(USCDI) The plan beneficiary."
}

Nested Schema : class

Type: array

(USCDI) The additional coverage classifications.

• Entries can represent group-level or plan-level classification details.
• For group classification, type coding may indicate group.
• For plan classification, type coding may indicate plan.

Show Source

• Array of: object CoverageClass

{
    "type":"array",
    "description":"<p>(USCDI) The additional coverage classifications.</p>\n<ul>\n  <li>Entries can represent group-level or plan-level classification details.</li>\n  <li>For group classification, type coding may indicate <code>group</code>.</li>\n  <li>For plan classification, type coding may indicate <code>plan</code>.</li>\n</ul>\n",
    "items":{
        "$ref":"#/components/schemas/CoverageClass"
    }
}

Nested Schema : identifier

Type: array

(USCDI) The member ID and other identifiers.

Show Source

• Array of: items

{
    "type":"array",
    "description":"(USCDI) The member ID and other identifiers.",
    "items":{
        "oneOf":[
            {
                "$ref":"#/components/schemas/Identifier"
            },
            {
                "$ref":"#/components/schemas/MemberId"
            }
        ]
    }
}

Nested Schema : payor

Type: array

(USCDI) The issuer of the policy.

Show Source

• Array of: object Reference

{
    "type":"array",
    "description":"(USCDI) The issuer of the policy.",
    "items":{
        "$ref":"#/components/schemas/Reference"
    }
}

Nested Schema : period

(USCDI) The coverage start and end dates.

Match All

(USCDI) The coverage start and end dates.

Show Source

• object Period

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Period"
        }
    ],
    "description":"(USCDI) The coverage start and end dates."
}

Nested Schema : relationship

(USCDI) The beneficiary's relationship to the subscriber.

Match All

(USCDI) The beneficiary's relationship to the subscriber.

Show Source

• object CodeableConcept

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CodeableConcept"
        }
    ],
    "description":"(USCDI) The beneficiary's relationship to the subscriber."
}

Nested Schema : type

(USCDI) The coverage category such as medical or accident.

Match All

(USCDI) The coverage category such as medical or accident.

Show Source

• object CodeableConcept

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CodeableConcept"
        }
    ],
    "description":"(USCDI) The coverage category such as medical or accident."
}

Nested Schema : Reference

Type: object

Show Source

• reference: string
• type: string

{
    "type":"object",
    "properties":{
        "reference":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

Nested Schema : CoverageClass

Type: object

Show Source

• name: string
  A human-readable description of the type and value.
• type(required): type
  The type of class such as group or plan.
• value(required): string
  The value associated with the type.

{
    "type":"object",
    "required":[
        "type",
        "value"
    ],
    "properties":{
        "type":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/CodeableConcept"
                }
            ],
            "description":"The type of class such as group or plan."
        },
        "value":{
            "type":"string",
            "description":"The value associated with the type."
        },
        "name":{
            "type":"string",
            "description":"A human-readable description of the type and value."
        }
    }
}

Nested Schema : type

The type of class such as group or plan.

Match All

The type of class such as group or plan.

Show Source

• object CodeableConcept

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CodeableConcept"
        }
    ],
    "description":"The type of class such as group or plan."
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
• text: string

{
    "type":"object",
    "properties":{
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            }
        },
        "text":{
            "type":"string"
        }
    }
}

Nested Schema : coding

Type: array

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    }
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string (uri)

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string",
            "format":"uri"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        }
    }
}

Nested Schema : items

Match One Schema

Show Source

• object Identifier
• object MemberId

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/Identifier"
        },
        {
            "$ref":"#/components/schemas/MemberId"
        }
    ]
}

Nested Schema : Identifier

Type: object

Show Source

• system(required): string (uri)
• value(required): string

{
    "type":"object",
    "required":[
        "system",
        "value"
    ],
    "properties":{
        "system":{
            "type":"string",
            "format":"uri"
        },
        "value":{
            "type":"string"
        }
    }
}

Nested Schema : MemberId

Type: object

Show Source

• system: string (uri)
• type(required): object type
• value: string

{
    "type":"object",
    "required":[
        "type"
    ],
    "properties":{
        "type":{
            "type":"object",
            "required":[
                "coding"
            ],
            "properties":{
                "coding":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "required":[
                            "system",
                            "code"
                        ],
                        "properties":{
                            "system":{
                                "type":"string",
                                "enum":[
                                    "http://terminology.hl7.org/CodeSystem/v2-0203"
                                ]
                            },
                            "code":{
                                "type":"string",
                                "enum":[
                                    "MB"
                                ]
                            },
                            "display":{
                                "type":"string"
                            }
                        }
                    }
                },
                "text":{
                    "type":"string"
                }
            }
        },
        "system":{
            "type":"string",
            "format":"uri"
        },
        "value":{
            "type":"string"
        }
    }
}

Nested Schema : type

Type: object

Show Source

• coding(required): array coding
• text: string

{
    "type":"object",
    "required":[
        "coding"
    ],
    "properties":{
        "coding":{
            "type":"array",
            "items":{
                "type":"object",
                "required":[
                    "system",
                    "code"
                ],
                "properties":{
                    "system":{
                        "type":"string",
                        "enum":[
                            "http://terminology.hl7.org/CodeSystem/v2-0203"
                        ]
                    },
                    "code":{
                        "type":"string",
                        "enum":[
                            "MB"
                        ]
                    },
                    "display":{
                        "type":"string"
                    }
                }
            }
        },
        "text":{
            "type":"string"
        }
    }
}

Nested Schema : coding

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "required":[
            "system",
            "code"
        ],
        "properties":{
            "system":{
                "type":"string",
                "enum":[
                    "http://terminology.hl7.org/CodeSystem/v2-0203"
                ]
            },
            "code":{
                "type":"string",
                "enum":[
                    "MB"
                ]
            },
            "display":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• code(required): string
  Allowed Values: [ "MB" ]
• display: string
• system(required): string
  Allowed Values: [ "http://terminology.hl7.org/CodeSystem/v2-0203" ]

{
    "type":"object",
    "required":[
        "system",
        "code"
    ],
    "properties":{
        "system":{
            "type":"string",
            "enum":[
                "http://terminology.hl7.org/CodeSystem/v2-0203"
            ]
        },
        "code":{
            "type":"string",
            "enum":[
                "MB"
            ]
        },
        "display":{
            "type":"string"
        }
    }
}

Nested Schema : Period

Type: object

Show Source

• end: string (date-time)
• start: string (date-time)

{
    "type":"object",
    "properties":{
        "start":{
            "type":"string",
            "format":"date-time"
        },
        "end":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : BundleLink

Type: object

Show Source

• relation: string
  Allowed Values: [ "self", "next", "previous" ]
• url: string (uri)

{
    "type":"object",
    "properties":{
        "relation":{
            "type":"string",
            "enum":[
                "self",
                "next",
                "previous"
            ]
        },
        "url":{
            "type":"string",
            "format":"uri"
        }
    }
}

Default Response

An OperationOutcome describing any error that occurred.

Body ()

Root Schema : OperationOutcome

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

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

Nested Schema : items

Type: object

Show Source

• code(required): string
• severity(required): string

{
    "type":"object",
    "required":[
        "severity",
        "code"
    ],
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        }
    }
}

Back to Top