InsurancePlan - FHIR Resource (r4)
This InsurancePlan Resource uses the FHIR API standard for access and structure.
Validate an InsurancePlan FHIR Resource (r4)
InsurancePlan Attributes
AttributeField is listTypeDescription
Description: C? Business Identifier for Product
FHIR Version: r4
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 (InsurancePlan) identifier FHIR attribute
Description: draft | active | retired | unknown
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": Learn more about the (InsurancePlan) status FHIR attribute
Description: Kind of product
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"type": Learn more about the (InsurancePlan) type FHIR attribute
Description: C? Official name
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"name": "foo"Learn more about the (InsurancePlan) name FHIR attribute
Description: Alternate names
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"alias": Learn more about the (InsurancePlan) alias FHIR attribute
Description: When the product is available
FHIR Version: r4
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 (InsurancePlan) period FHIR attribute
Description: Plan issuer
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"ownedBy": Learn more about the (InsurancePlan) ownedBy FHIR attribute
Description: Product administrator
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"administeredBy": Learn more about the (InsurancePlan) administeredBy FHIR attribute
Description: Where product applies
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"coverageArea": Learn more about the (InsurancePlan) coverageArea FHIR attribute
Description: Contact for the product
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"contact": Learn more about the (InsurancePlan) contact FHIR attribute
Description: Technical endpoint
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"endpoint": Learn more about the (InsurancePlan) endpoint FHIR attribute
Description: What networks are Included
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"network": Learn more about the (InsurancePlan) network FHIR attribute
Description: Coverage details
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"coverage": Learn more about the (InsurancePlan) coverage FHIR attribute
Description: Plan details
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"plan": Learn more about the (InsurancePlan) plan FHIR attribute
InsurancePlan Example
{
"resourceType": "InsurancePlan",
"id": "example",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example</p><p><b>name</b>: foo</p></div>"
},
"name": "foo"
}InsurancePlan Structure
{
"resourceType" : "InsurancePlan",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // C? Business Identifier for Product
"status" : "<code>", // draft | active | retired | unknown
"type" : [{ CodeableConcept }], // Kind of product
"name" : "<string>", // C? Official name
"alias" : ["<string>"], // Alternate names
"period" : { Period }, // When the product is available
"ownedBy" : { Reference(Organization) }, // Plan issuer
"administeredBy" : { Reference(Organization) }, // Product administrator
"coverageArea" : [{ Reference(Location) }], // Where product applies
"contact" : [{ // Contact for the product
"purpose" : { CodeableConcept }, // The type of contact
"name" : { HumanName }, // A name associated with the contact
"telecom" : [{ ContactPoint }], // Contact details (telephone, email, etc.) for a contact
"address" : { Address } // Visiting or postal addresses for the contact
}],
"endpoint" : [{ Reference(Endpoint) }], // Technical endpoint
"network" : [{ Reference(Organization) }], // What networks are Included
"coverage" : [{ // Coverage details
"type" : { CodeableConcept }, // R! Type of coverage
"network" : [{ Reference(Organization) }], // What networks provide coverage
"benefit" : [{ // R! List of benefits
"type" : { CodeableConcept }, // R! Type of benefit
"requirement" : "<string>", // Referral requirements
"limit" : [{ // Benefit limits
"value" : { Quantity }, // Maximum value allowed
"code" : { CodeableConcept } // Benefit limit details
}]
}]
}],
"plan" : [{ // Plan details
"identifier" : [{ Identifier }], // Business Identifier for Product
"type" : { CodeableConcept }, // Type of plan
"coverageArea" : [{ Reference(Location) }], // Where product applies
"network" : [{ Reference(Organization) }], // What networks provide coverage
"generalCost" : [{ // Overall costs
"type" : { CodeableConcept }, // Type of cost
"groupSize" : "<positiveInt>", // Number of enrollees
"cost" : { Money }, // Cost value
"comment" : "<string>" // Additional cost information
}],
"specificCost" : [{ // Specific costs
"category" : { CodeableConcept }, // R! General category of benefit
"benefit" : [{ // Benefits list
"type" : { CodeableConcept }, // R! Type of specific benefit
"cost" : [{ // List of the costs
"type" : { CodeableConcept }, // R! Type of cost
"applicability" : { CodeableConcept }, // in-network | out-of-network | other
"qualifiers" : [{ CodeableConcept }], // Additional information about the cost
"value" : { Quantity } // The actual cost value
}]
}]
}]
}]
}
InsurancePlan Search Parameters
The following search parameters can be used to query InsurancePlan resources. Just submit them like so:
https://api.1up.health/fhir/r4/InsurancePlan?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
address | text | contact.address |
address-city | text | contact.address.city |
address-country | text | contact.address.country |
address-postalcode | text | contact.address.postalCode |
address-state | text | contact.address.state |
address-use | text | contact.address.use |
administered-by | reference | administeredBy |
endpoint | reference | endpoint |
identifier | text | identifier |
name | text | name | alias |
owned-by | reference | ownedBy |
phonetic | text | name |
status | text | status |
type | text | type |
