InsurancePlan

ResourceFinancial · GeneralTrial useMaturity 0

Details of a Health Insurance product/plan provided by an organization.

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

14 of 14 parameters tested

Structure

Show inherited elements (35)

Element	Card.	Type	Description
identifierΣ	0..*	Identifier	Business Identifier for Product
status?!Σ	0..1	code	draft | active | retired | unknownBinding (required): publication-status
typeΣ	0..*	CodeableConcept	Kind of productBinding (example): insuranceplan-type
nameΣ	0..1	string	Official name
alias	0..*	string	Alternate names
period	0..1	Period	When the product is available
ownedByΣ	0..1	Reference(Organization)	Plan issuer
administeredByΣ	0..1	Reference(Organization)	Product administrator
coverageAreaΣ	0..*	Reference(Location)	Where product applies
contact	0..*	BackboneElement	Contact for the product
purpose	0..1	CodeableConcept	The type of contactBinding (extensible): contactentity-type
name	0..1	HumanName	A name associated with the contact
telecom	0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
address	0..1	Address	Visiting or postal addresses for the contact
endpoint	0..*	Reference(Endpoint)	Technical endpoint
network	0..*	Reference(Organization)	What networks are Included
coverage	0..*	BackboneElement	Coverage details
typeRequired	1..1	CodeableConcept	Type of coverage
network	0..*	Reference(Organization)	What networks provide coverage
benefitRequired	1..*	BackboneElement	List of benefits
typeRequired	1..1	CodeableConcept	Type of benefit
requirement	0..1	string	Referral requirements
limit	0..*	BackboneElement	Benefit limits
value	0..1	Quantity	Maximum value allowed
code	0..1	CodeableConcept	Benefit limit details
plan	0..*	BackboneElement	Plan details
identifierΣ	0..*	Identifier	Business Identifier for Product
type	0..1	CodeableConcept	Type of plan
coverageAreaΣ	0..*	Reference(Location)	Where product applies
network	0..*	Reference(Organization)	What networks provide coverage
generalCost	0..*	BackboneElement	Overall costs
type	0..1	CodeableConcept	Type of cost
groupSize	0..1	positiveInt	Number of enrollees
cost	0..1	Money	Cost value
comment	0..1	string	Additional cost information
specificCost	0..*	BackboneElement	Specific costs
categoryRequired	1..1	CodeableConcept	General category of benefit
benefit	0..*	BackboneElement	Benefits list
typeRequired	1..1	CodeableConcept	Type of specific benefit
cost	0..*	BackboneElement	List of the costs
typeRequired	1..1	CodeableConcept	Type of cost
applicability	0..1	CodeableConcept	in-network | out-of-network | otherBinding (required): insuranceplan-applicability
qualifiers	0..*	CodeableConcept	Additional information about the cost
value	0..1	Quantity	The actual cost value

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/InsurancePlan?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
address	string	A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text InsurancePlan.contact.address
address-city	string	A city specified in an address InsurancePlan.contact.address.city
address-country	string	A country specified in an address InsurancePlan.contact.address.country
address-postalcode	string	A postal code specified in an address InsurancePlan.contact.address.postalCode
address-state	string	A state specified in an address InsurancePlan.contact.address.state
address-use	token	A use code specified in an address InsurancePlan.contact.address.use
administered-by	reference	Product administrator InsurancePlan.administeredBy
endpoint	reference	Technical endpoint InsurancePlan.endpoint
identifier	token	Any identifier for the organization (not the accreditation issuer's identifier) InsurancePlan.identifier
name	string	A portion of the organization's name or alias name | alias
owned-by	reference	An organization of which this organization forms a part InsurancePlan.ownedBy
phonetic	string	A portion of the organization's name using some kind of phonetic matching algorithm InsurancePlan.name
status	token	Is the Organization record active InsurancePlan.status
type	token	A code for the type of organization InsurancePlan.type

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition