Skip to main content

InsurancePlan

Draft Financial

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

Endpoints​

alphahttps://api.dev.ovok.com/fhir/R4/InsurancePlan
InteractionMethodPath
ReadGET/fhir/R4/InsurancePlan/[id]
VreadGET/fhir/R4/InsurancePlan/[id]/_history/[vid]
UpdatePUT/fhir/R4/InsurancePlan/[id]
PatchPATCH/fhir/R4/InsurancePlan/[id]
DeleteDELETE/fhir/R4/InsurancePlan/[id]
CreatePOST/fhir/R4/InsurancePlan
SearchGET/fhir/R4/InsurancePlan
HistoryGET/fhir/R4/InsurancePlan/[id]/_history

Top-level elements​

ElementType(s)CardinalityDescription
identifierIdentifier0..*Business Identifier for Product
statuscode0..1draft | active | retired | unknown modifier
typeCodeableConcept0..*Kind of product
namestring0..1Official name
aliasstring0..*Alternate names
periodPeriod0..1When the product is available
ownedByReference0..1Plan issuer
administeredByReference0..1Product administrator
coverageAreaReference0..*Where product applies
contactBackboneElement0..*Contact for the product
endpointReference0..*Technical endpoint
networkReference0..*What networks are Included
coverageBackboneElement0..*Coverage details
planBackboneElement0..*Plan details

Resource-specific search parameters​

ParameterTypeDescription
_compartmentstring
_countstringhttps://www.hl7.org/fhir/search.html#_count
_elementsstringhttps://www.hl7.org/fhir/search.html#_elements
_idstring
_lastUpdatedstring
_profilestring
_securitystring
_sortstringhttps://www.hl7.org/fhir/search.html#_sort
_sourcestring
_summarystringhttps://www.hl7.org/fhir/search.html#_summary
_tagstring
_totalstringhttps://www.hl7.org/fhir/search.html#_total
addressstringhttp://hl7.org/fhir/SearchParameter/InsurancePlan-address
address-citystringhttp://hl7.org/fhir/SearchParameter/InsurancePlan-address-city
address-countrystringhttp://hl7.org/fhir/SearchParameter/InsurancePlan-address-country
address-postalcodestringhttp://hl7.org/fhir/SearchParameter/InsurancePlan-address-postalcode
address-statestringhttp://hl7.org/fhir/SearchParameter/InsurancePlan-address-state
address-usestringhttp://hl7.org/fhir/SearchParameter/InsurancePlan-address-use
administered-bystringhttp://hl7.org/fhir/SearchParameter/InsurancePlan-administered-by
endpointstringhttp://hl7.org/fhir/SearchParameter/InsurancePlan-endpoint
identifierstringhttp://hl7.org/fhir/SearchParameter/InsurancePlan-identifier
namestringhttp://hl7.org/fhir/SearchParameter/InsurancePlan-name
owned-bystringhttp://hl7.org/fhir/SearchParameter/InsurancePlan-owned-by
phoneticstringhttp://hl7.org/fhir/SearchParameter/InsurancePlan-phonetic
statusstringhttp://hl7.org/fhir/SearchParameter/InsurancePlan-status
typestringhttp://hl7.org/fhir/SearchParameter/InsurancePlan-type

Reference​