Coverage - FHIR Resource (dstu2)
This Coverage Resource uses the FHIR API standard for access and structure.
Validate an Coverage FHIR Resource (dstu2)
Coverage Attributes
AttributeField is listTypeDescription
Description: BIN Number
FHIR Version: dstu2
Attribute Type : Identifier
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"bin": Learn more about the (Coverage) bin FHIR attribute
Description: An identifier for the group
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"group": Learn more about the (Coverage) group FHIR attribute
Description: Insurer network
FHIR Version: dstu2
Attribute Type : Identifier
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"network": Learn more about the (Coverage) network FHIR attribute
Description: The plan instance or sequence counter
FHIR Version: dstu2
Attribute Type : positiveInt
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"sequence": Learn more about the (Coverage) sequence FHIR attribute
Description: The dependent number
FHIR Version: dstu2
Attribute Type : positiveInt
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"dependent": Learn more about the (Coverage) dependent FHIR attribute
Description: Coverage start and end dates
FHIR Version: dstu2
Attribute Type : Period
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"period": Learn more about the (Coverage) period FHIR attribute
Description: Contract details
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"contract": Learn more about the (Coverage) contract FHIR attribute
Description: Plan holder information
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"subscriber": Learn more about the (Coverage) subscriber FHIR attribute
Description: An identifier for the subsection of the plan
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"subPlan": Learn more about the (Coverage) subPlan FHIR attribute
Description: An identifier for the plan
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"plan": Learn more about the (Coverage) plan FHIR attribute
Description: The primary coverage ID
FHIR Version: dstu2
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": Learn more about the (Coverage) identifier FHIR attribute
Description: Type of coverage
FHIR Version: dstu2
Attribute Type : Coding
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"type": Learn more about the (Coverage) type FHIR attribute
Description: Subscriber ID
FHIR Version: dstu2
Attribute Type : Identifier
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"subscriberId": Learn more about the (Coverage) subscriberId FHIR attribute
Description: An identifier for the plan issuer
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"issuer": Learn more about the (Coverage) issuer FHIR attribute
Coverage Structure
{
"resourceType" : "Coverage",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"issuer" : { Reference(Organization) }, // An identifier for the plan issuer
"bin" : { Identifier }, // BIN Number
"period" : { Period }, // Coverage start and end dates
"type" : { Coding }, // Type of coverage
"subscriberId" : { Identifier }, // Subscriber ID
"identifier" : [{ Identifier }], // The primary coverage ID
"group" : "<string>", // An identifier for the group
"plan" : "<string>", // An identifier for the plan
"subPlan" : "<string>", // An identifier for the subsection of the plan
"dependent" : "<positiveInt>", // The dependent number
"sequence" : "<positiveInt>", // The plan instance or sequence counter
"subscriber" : { Reference(Patient) }, // Plan holder information
"network" : { Identifier }, // Insurer network
"contract" : [{ Reference(Contract) }] // Contract details
}
Coverage Search Parameters
The following search parameters can be used to query Coverage resources. Just submit them like so:
https://api.1up.health/fhir/dstu2/Coverage?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
dependent | text | dependent |
group | text | group |
identifier | text | identifier |
issuer | reference | issuer |
plan | text | plan |
sequence | text | sequence |
subplan | text | subPlan |
type | text | type |
