InsurancePlan

Draft Financial

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

Endpoints

devhttps://api.sandbox.ovok.com/fhir/R5/InsurancePlan

Interaction	Method	Path
Read	GET	/fhir/R5/InsurancePlan/[id]
Vread	GET	/fhir/R5/InsurancePlan/[id]/_history/[vid]
Update	PUT	/fhir/R5/InsurancePlan/[id]
Patch	PATCH	/fhir/R5/InsurancePlan/[id]
Delete	DELETE	/fhir/R5/InsurancePlan/[id]
Create	POST	/fhir/R5/InsurancePlan
Search	GET	/fhir/R5/InsurancePlan?...
History	GET	/fhir/R5/InsurancePlan/[id]/_history
Type-history	GET	/fhir/R5/InsurancePlan/_history

Top-level elements

Element	Type(s)	Cardinality	Description
identifier	Identifier	0..*	Business Identifier for Product
status	code	0..1	draft
type	CodeableConcept	0..*	Kind of product
name	string	0..1	Official name
alias	string	0..*	Alternate names
period	Period	0..1	When the product is available
ownedBy	Reference	0..1	Product issuer
administeredBy	Reference	0..1	Product administrator
coverageArea	Reference	0..*	Where product applies
contact	ExtendedContactDetail	0..*	Official contact details relevant to the health insurance plan/product
endpoint	Reference	0..*	Technical endpoint
network	Reference	0..*	What networks are Included
coverage	BackboneElement	0..*	Coverage details
plan	BackboneElement	0..*	Plan details

Resource-specific search parameters

Parameter	Type	Description
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
address-city	string	A city specified in an address
address-country	string	A country specified in an address
address-postalcode	string	A postal code specified in an address
address-state	string	A state specified in an address
address-use	token	A use code specified in an address
administered-by	reference	Product administrator
endpoint	reference	Technical endpoint
identifier	token	Any identifier for the organization (not the accreditation issuer's identifier)
name	string	A portion of the organization's name or alias
owned-by	reference	An organization of which this organization forms a part
phonetic	string	A portion of the organization's name using some kind of phonetic matching algorithm
status	token	Is the Organization record active
type	token	A code for the type of organization

Reference

• Official FHIR R5 spec: InsurancePlan
• Maturity: Draft (FMM 0).